docs: updated workflow docs

hotosm · Sep 29, 2023 · 2d1dc01 · 2d1dc01
1 parent fe81215
commit 2d1dc01
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 55 deletions.
diff --git a/docs/doxygen_build.md b/docs/doxygen_build.md
@@ -4,27 +4,23 @@
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
-| INPUT       | TYPE   | REQUIRED | DEFAULT | DESCRIPTION                                           |
-| ----------- | ------ | -------- | ------- | ----------------------------------------------------- |
-| cache_key   | string | false    |         | The cache key to receive from <br>a previous job.     |
-| cache_paths | string | true     |         | The paths to cache for preceeding/following <br>jobs. |
+|                               INPUT                               |  TYPE  | REQUIRED | DEFAULT |                      DESCRIPTION                       |
+|-------------------------------------------------------------------|--------|----------|---------|--------------------------------------------------------|
+|    <a name="input_cache_key"></a>[cache_key](#input_cache_key)    | string |  false   |         |   The cache key to receive <br>from a previous job.    |
+| <a name="input_cache_paths"></a>[cache_paths](#input_cache_paths) | string |   true   |         | The paths to cache for <br>preceeding/following jobs.  |
 
 <!-- AUTO-DOC-INPUT:END -->
 
 ## Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
-
 No outputs.
-
 <!-- AUTO-DOC-OUTPUT:END -->
 
 ## Secrets
 
 <!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
-
 No secrets.
-
 <!-- AUTO-DOC-SECRETS:END -->
 
 ## Example Usage

diff --git a/docs/image_build.md b/docs/image_build.md
@@ -4,32 +4,28 @@
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
-| INPUT        | TYPE    | REQUIRED | DEFAULT                              | DESCRIPTION                                                  |
-| ------------ | ------- | -------- | ------------------------------------ | ------------------------------------------------------------ |
-| build_args   | string  | false    |                                      | Space separated list of build args <br>to use for the image. |
-| build_target | string  | false    |                                      | The target to built to (default to end of the Dockerfile).   |
-| context      | string  | false    | `"."`                                | Root directory to start the build <br>from.                  |
-| dockerfile   | string  | false    | `"${{ inputs.context }}/Dockerfile"` | Absolute path of the dockerfile (inside the context dir).    |
-| image_tags   | string  | true     |                                      | Space separated list of tags for <br>the built image.        |
-| push         | boolean | false    | `true`                               | Override prevent pushing the image.                          |
-| registry     | string  | false    | `"ghcr.io"`                          | Override GHCR to use an external <br>reg.                    |
+|                                INPUT                                 |  TYPE   | REQUIRED |               DEFAULT                |                            DESCRIPTION                            |
+|----------------------------------------------------------------------|---------|----------|--------------------------------------|-------------------------------------------------------------------|
+|    <a name="input_build_args"></a>[build_args](#input_build_args)    | string  |  false   |                                      | Space separated list of build <br>args to use for the <br>image.  |
+| <a name="input_build_target"></a>[build_target](#input_build_target) | string  |  false   |                                      |  The target to built to <br>(default to end of the Dockerfile).   |
+|        <a name="input_context"></a>[context](#input_context)         | string  |  false   |                `"."`                 |           Root directory to start the <br>build from.             |
+|    <a name="input_dockerfile"></a>[dockerfile](#input_dockerfile)    | string  |  false   | `"${{ inputs.context }}/Dockerfile"` |  Absolute path of the dockerfile <br>(inside the context dir).    |
+|    <a name="input_image_tags"></a>[image_tags](#input_image_tags)    | string  |   true   |                                      |      Space separated list of tags <br>for the built image.        |
+|             <a name="input_push"></a>[push](#input_push)             | boolean |  false   |                `true`                |                Override prevent pushing the image.                |
+|       <a name="input_registry"></a>[registry](#input_registry)       | string  |  false   |             `"ghcr.io"`              |            Override GHCR to use an <br>external reg.              |
 
 <!-- AUTO-DOC-INPUT:END -->
 
 ## Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
-
 No outputs.
-
 <!-- AUTO-DOC-OUTPUT:END -->
 
 ## Secrets
 
 <!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
-
 No secrets.
-
 <!-- AUTO-DOC-SECRETS:END -->
 
 ## Example Usage

diff --git a/docs/mkdocs_build.md b/docs/mkdocs_build.md
@@ -4,29 +4,25 @@
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
-| INPUT           | TYPE   | REQUIRED | DEFAULT                                   | DESCRIPTION                                                                      |
-| --------------- | ------ | -------- | ----------------------------------------- | -------------------------------------------------------------------------------- |
-| cache_key       | string | false    |                                           | The cache key to receive from <br>a previous job.                                |
-| cache_paths     | string | false    |                                           | The paths to cache for preceeding/following <br>jobs.                            |
-| image           | string | false    | `"docker.io/squidfunk/mkdocs-material:9"` | Override the image to build mkdocs.                                              |
-| prepend_command | string | false    |                                           | Command to run before mkdocs deploy <br>(e.g. 'gosu appuser' to run as appuser). |
+|                                     INPUT                                     |  TYPE  | REQUIRED |                  DEFAULT                  |                                    DESCRIPTION                                    |
+|-------------------------------------------------------------------------------|--------|----------|-------------------------------------------|-----------------------------------------------------------------------------------|
+|          <a name="input_cache_key"></a>[cache_key](#input_cache_key)          | string |  false   |                                           |                The cache key to receive <br>from a previous job.                  |
+|       <a name="input_cache_paths"></a>[cache_paths](#input_cache_paths)       | string |  false   |                                           |              The paths to cache for <br>preceeding/following jobs.                |
+|                <a name="input_image"></a>[image](#input_image)                | string |  false   | `"docker.io/squidfunk/mkdocs-material:9"` |                     Override the image to build <br>mkdocs.                       |
+| <a name="input_prepend_command"></a>[prepend_command](#input_prepend_command) | string |  false   |                                           | Command to run before mkdocs <br>deploy (e.g. 'gosu appuser' to run as appuser).  |
 
 <!-- AUTO-DOC-INPUT:END -->
 
 ## Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
-
 No outputs.
-
 <!-- AUTO-DOC-OUTPUT:END -->
 
 ## Secrets
 
 <!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
-
 No secrets.
-
 <!-- AUTO-DOC-SECRETS:END -->
 
 ## Example Usage

diff --git a/docs/openapi_build.md b/docs/openapi_build.md
@@ -4,29 +4,25 @@
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
-| INPUT                 | TYPE   | REQUIRED | DEFAULT | DESCRIPTION                                                                         |
-| --------------------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------- |
-| cache_key             | string | false    |         | The cache key to receive from <br>a previous job.                                   |
-| cache_paths           | string | true     |         | The paths to cache for preceeding/following <br>jobs.                               |
-| example_env_file_path | string | true     |         | FastAPI must start with an environment <br>set. Path to a .env with <br>dummy vars. |
-| image                 | string | true     |         | The image to build to OpenAPI <br>JSON (dependencies included, i.e. FastAPI.).      |
+|                                              INPUT                                              |  TYPE  | REQUIRED | DEFAULT |                                     DESCRIPTION                                      |
+|-------------------------------------------------------------------------------------------------|--------|----------|---------|--------------------------------------------------------------------------------------|
+|                   <a name="input_cache_key"></a>[cache_key](#input_cache_key)                   | string |  false   |         |                  The cache key to receive <br>from a previous job.                   |
+|                <a name="input_cache_paths"></a>[cache_paths](#input_cache_paths)                | string |   true   |         |                The paths to cache for <br>preceeding/following jobs.                 |
+| <a name="input_example_env_file_path"></a>[example_env_file_path](#input_example_env_file_path) | string |   true   |         | FastAPI must start with an <br>environment set. Path to a <br>.env with dummy vars.  |
+|                         <a name="input_image"></a>[image](#input_image)                         | string |   true   |         |   The image to build to <br>OpenAPI JSON (dependencies included, i.e. FastAPI.).     |
 
 <!-- AUTO-DOC-INPUT:END -->
 
 ## Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
-
 No outputs.
-
 <!-- AUTO-DOC-OUTPUT:END -->
 
 ## Secrets
 
 <!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
-
 No secrets.
-
 <!-- AUTO-DOC-SECRETS:END -->
 
 ## Example Usage

diff --git a/docs/pypi_publish.md b/docs/pypi_publish.md
@@ -3,26 +3,22 @@
 ## Inputs
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
-
 No inputs.
-
 <!-- AUTO-DOC-INPUT:END -->
 
 ## Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
-
 No outputs.
-
 <!-- AUTO-DOC-OUTPUT:END -->
 
 ## Secrets
 
 <!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
 
-| SECRET     | REQUIRED | DESCRIPTION                                  |
-| ---------- | -------- | -------------------------------------------- |
-| PYPI_TOKEN | true     | The PyPi.org API token for your <br>project. |
+|                              SECRET                              | REQUIRED |                  DESCRIPTION                  |
+|------------------------------------------------------------------|----------|-----------------------------------------------|
+| <a name="secret_PYPI_TOKEN"></a>[PYPI_TOKEN](#secret_PYPI_TOKEN) |   true   | The PyPi.org API token for <br>your project.  |
 
 <!-- AUTO-DOC-SECRETS:END -->
 

diff --git a/docs/wiki.md b/docs/wiki.md
@@ -4,24 +4,20 @@
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
 
-| INPUT         | TYPE   | REQUIRED | DEFAULT     | DESCRIPTION                                                                               |
-| ------------- | ------ | -------- | ----------- | ----------------------------------------------------------------------------------------- |
-| homepage_path | string | false    | `"Home.md"` | The file to rename to `Home.md` <br>for the root Wiki page, relative <br>from `docs` dir. |
+|                                  INPUT                                  |  TYPE  | REQUIRED |   DEFAULT   |                                        DESCRIPTION                                         |
+|-------------------------------------------------------------------------|--------|----------|-------------|--------------------------------------------------------------------------------------------|
+| <a name="input_homepage_path"></a>[homepage_path](#input_homepage_path) | string |  false   | `"Home.md"` | The file to rename to <br>`Home.md` for the root Wiki <br>page, relative from `docs` dir.  |
 
 <!-- AUTO-DOC-INPUT:END -->
 
 ## Outputs
 
 <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
-
 No outputs.
-
 <!-- AUTO-DOC-OUTPUT:END -->
 
 ## Secrets
 
 <!-- AUTO-DOC-SECRETS:START - Do not remove or modify this section -->
-
 No secrets.
-
 <!-- AUTO-DOC-SECRETS:END -->