fix: rename doc names to kebab case

linz · Nov 5, 2023 · f842044 · f842044
1 parent cd84cea
commit f842044
Show file tree

Hide file tree

Showing 20 changed files with 15 additions and 13 deletions.
diff --git a/docs/Developer guide/API/.gitignore → docs/developer-guide/API/.gitignore b/docs/Developer guide/API/.gitignore → docs/developer-guide/API/.gitignore
diff --git a/docs/Developer guide/README.md → docs/developer-guide/README.md b/docs/Developer guide/README.md → docs/developer-guide/README.md
diff --git a/docs/Operator guide/README.md → docs/operator-guide/README.md b/docs/Operator guide/README.md → docs/operator-guide/README.md
diff --git a/docs/Operator guide/COG quality.md → docs/operator-guide/cog-quality.md b/docs/Operator guide/COG quality.md → docs/operator-guide/cog-quality.md
@@ -1,4 +1,6 @@
-# COG Quality - Resampling with reprojecton and overview creation
+# COG Quality
+
+## Resampling with reprojecton and overview creation
 
 creating COGs using a command very similar to
 
@@ -35,24 +37,24 @@ When creating COGs using the different resampling methods the output quality dif
 
 Here are some overviews created using some of the different resampling methods:
 
-![Resampling Quality](./images/quality__resampling-overview.webp)
+![Resampling Quality](./static/quality__resampling-overview.webp)
 
 ### Lanczos 
 
 Provides quite a nice and crisp output
 
-![Lanczos Overview](./images/quality__i6.lanczos.webp)
+![Lanczos Overview](./static/quality__i6.lanczos.webp)
 
 ### Cubic
 Creates weird artifacts around the edges
 
-![Cubic Overview](./images/quality__i6.cubic.webp)
+![Cubic Overview](./static/quality__i6.cubic.webp)
 
 ### Bilinear
 
 looks blury
 
-![Bilinear Overview](./images/quality__i6.bilinear.webp)
+![Bilinear Overview](./static/quality__i6.bilinear.webp)
 
 
 Using lanczos looks best for our overview creation.
@@ -67,13 +69,13 @@ Here are some higher resolution aerial imagery image 0 with different resampling
 
 Creates a jaggeredness, look at the street markings and the edges of the buildings
 
-![Lanczos](./images/quality__005_006_0_lanczos.webp)
+![Lanczos](./static/quality__005_006_0_lanczos.webp)
 
 ### Bilinear
 
 Creates a nice image
 
-![Bilinear](./images/quality__005_006_0_bilinear.webp)
+![Bilinear](./static/quality__005_006_0_bilinear.webp)
 
 
 For our aerial imagery reprojection seems to be best done as bilinear, where as Overview creation seems to be best done as lanczos.

diff --git a/docs/Operator guide/Empty tiles.md → docs/operator-guide/empty-tiles.md b/docs/Operator guide/Empty tiles.md → docs/operator-guide/empty-tiles.md
@@ -10,7 +10,7 @@ Further investigation should also be done on `OATiles-hint: empty` response head
 
 LINZ has imagery datasets which are very sparse, with large empty areas between smaller sections of valid data, for example [Gisborne Urban 2022-2023](https://basemaps.linz.govt.nz/?i=gisborne-2022-2023-0.1m).
 
-[![Gisborne 2023](./images/2023-06-26-gisborne-2023.png)](https://basemaps.linz.govt.nz/?i=gisborne-2022-2023-0.1m)
+[![Gisborne 2023](./static/2023-06-26-gisborne-2023.png)](https://basemaps.linz.govt.nz/?i=gisborne-2022-2023-0.1m)
 
 Even when providing a bounding box for the imagery, there is still a very large amount of empty space, which results in a large number of empty tiles being served.
 

diff --git a/docs/Operator guide/Relief shade.md → docs/operator-guide/relief-shade.md b/docs/Operator guide/Relief shade.md → docs/operator-guide/relief-shade.md
@@ -32,14 +32,14 @@ gdaldem color-relief -co COMPRESS=lzw -co TILED=yes -co NUM_THREADS=ALL_CPUS -of
 Relief shading with vector tiles the only imagery operation is "overlay", if any `white` exists in the relief shade it lightens the image
 
 Base Image:
-![Aerial imagery](./images/relief__aerial.webp)
+![Aerial imagery](./static/relief__aerial.webp)
 
 gdaldem hillshade:
-![Aerial imagery](./images/relief__base.webp)
+![Aerial imagery](./static/relief__base.webp)
 
 
 Using default color ramp applys whites
-![Lighten](./images/relief__lighten.webp)
+![Lighten](./static/relief__lighten.webp)
 
 Custom color ramp which only applys the darken
 
@@ -53,4 +53,4 @@ nv      0       0       0       0
 
 `nv` - No value or NO_DATA  set full alpha
 
-![Lighten](./images/relief__darken.webp)
+![Lighten](./static/relief__darken.webp)
diff --git a/...guide/images/2023-06-26-gisborne-2023.png → ...guide/static/2023-06-26-gisborne-2023.png b/...guide/images/2023-06-26-gisborne-2023.png → ...guide/static/2023-06-26-gisborne-2023.png
diff --git a/...e/images/quality__005_006_0_bilinear.webp → ...e/static/quality__005_006_0_bilinear.webp b/...e/images/quality__005_006_0_bilinear.webp → ...e/static/quality__005_006_0_bilinear.webp
diff --git a/...de/images/quality__005_006_0_lanczos.webp → ...de/static/quality__005_006_0_lanczos.webp b/...de/images/quality__005_006_0_lanczos.webp → ...de/static/quality__005_006_0_lanczos.webp
diff --git a/...or guide/images/quality__i6.bilinear.webp → ...or-guide/static/quality__i6.bilinear.webp b/...or guide/images/quality__i6.bilinear.webp → ...or-guide/static/quality__i6.bilinear.webp
diff --git a/...rator guide/images/quality__i6.cubic.webp → ...rator-guide/static/quality__i6.cubic.webp b/...rator guide/images/quality__i6.cubic.webp → ...rator-guide/static/quality__i6.cubic.webp
diff --git a/...tor guide/images/quality__i6.lanczos.webp → ...tor-guide/static/quality__i6.lanczos.webp b/...tor guide/images/quality__i6.lanczos.webp → ...tor-guide/static/quality__i6.lanczos.webp
diff --git a/.../images/quality__resampling-overview.webp → .../static/quality__resampling-overview.webp b/.../images/quality__resampling-overview.webp → .../static/quality__resampling-overview.webp
diff --git a/...Operator guide/images/relief__aerial.webp → ...operator-guide/static/relief__aerial.webp b/...Operator guide/images/relief__aerial.webp → ...operator-guide/static/relief__aerial.webp
diff --git a/docs/Operator guide/images/relief__base.webp → docs/operator-guide/static/relief__base.webp b/docs/Operator guide/images/relief__base.webp → docs/operator-guide/static/relief__base.webp
diff --git a/...Operator guide/images/relief__darken.webp → ...operator-guide/static/relief__darken.webp b/...Operator guide/images/relief__darken.webp → ...operator-guide/static/relief__darken.webp
diff --git a/...perator guide/images/relief__lighten.webp → ...perator-guide/static/relief__lighten.webp b/...perator guide/images/relief__lighten.webp → ...perator-guide/static/relief__lighten.webp
diff --git a/docs/Operator guide/Texture shade.md → docs/operator-guide/texture-shade.md b/docs/Operator guide/Texture shade.md → docs/operator-guide/texture-shade.md
diff --git a/docs/User guide/README.md → docs/user-guide/README.md b/docs/User guide/README.md → docs/user-guide/README.md
diff --git a/typedoc.json b/typedoc.json
@@ -3,7 +3,7 @@
   "entryPointStrategy": "packages",
   "exclude": ["./packages/__tests__"],
   "plugin": ["typedoc-plugin-markdown"],
-  "out": "./docs/Developer guide/API",
+  "out": "./docs/developer-guide/API",
   "outputFileStrategy": "modules",
   "readme": "none",
   "githubPages": false