Update Inputs and add Links

smashedr · smashedr · commit 7c2583f39a13 · 2025-09-06T12:21:46.000-07:00
diff --git a/.vitepress/config.mts b/.vitepress/config.mts
@@ -122,8 +122,8 @@ export default defineConfig({
         base: '/guides',
         items: [
           { text: 'Get Started', link: '/get-started' },
-          { text: 'Examples', link: '/examples' },
           { text: 'Features', link: '/features' },
+          { text: 'Examples', link: '/examples' },
           //
         ],
       },
diff --git a/docs/docs/inputs.md b/docs/docs/inputs.md
@@ -4,7 +4,7 @@ The inputs are organized in a table for quick [reference](#reference) with addit
 
 ## Reference
 
-💡 You can click on each input for more [Details](#details).
+💡 You can click on an input for more [Details](#details).
 
 | Input&nbsp;Name                               | Default&nbsp;Value                  | Short&nbsp;Description&nbsp;of&nbsp;the&nbsp;Input&nbsp;Value |
 | :-------------------------------------------- | :---------------------------------- | :------------------------------------------------------------ |
@@ -36,26 +36,32 @@ The inputs are organized in a table for quick [reference](#reference) with addit
 
 ### name
 
-the stack name for Swarm and project name for Compose.
+Swarm sack name or Compose project name.
 
 Example: `cool-stack`
 
 ### file
 
-Stack file or Compose file(s). _Swarm_ only supports 1 file per stack.
+Stack file or Compose file(s).
+
+_Swarm._ Only supports 1 file per stack.
 
 _Compose._ [Multiple files](https://docs.docker.com/compose/how-tos/multiple-compose-files/) can be provided, space seperated. and the `-f` flag will be prepended to each file.
 
 Example: `web.yaml db.yaml`  
 Output: `-f web.yaml -f db.yaml`
 
-### mode
+### mode <Badge type="warning">Compose Only</Badge> {#mode}
+
+Enable Docker Compose mode by setting this to `compose`.
 
-**Compose Only.** Set this to `compose` to use [compose up](https://docs.docker.com/reference/cli/docker/compose/up/) instead of [stack deploy](https://docs.docker.com/reference/cli/docker/stack/deploy/) for non-swarm hosts.
+Ths deploy will use [compose up](https://docs.docker.com/reference/cli/docker/compose/up/) instead of [stack deploy](https://docs.docker.com/reference/cli/docker/stack/deploy/) for non-swarm hosts.
 
-### args
+Example: `compose`
 
-**Compose Only.** Compose arguments to pass to the `compose up` command. Only used for `mode: compose` deployments.
+### args <Badge type="warning">Compose Only</Badge> {#args}
+
+Compose arguments to pass to the `compose up` command. Only used for `mode: compose` deployments.
 The `detach` flag defaults to false for compose. With no args the default is `--remove-orphans --force-recreate`.
 Use an empty string to override. For more details, see the compose
 [docs](https://docs.docker.com/reference/cli/docker/compose/up/).
@@ -94,10 +100,10 @@ dig TXT +short o-o.myaddr.l.google.com @ns1.google.com
 You must provide either a `pass` or `ssh_key`, but **not** both.
 
 When using a password, a temporary key is generated using [ssh-keygen](https://linux.die.net/man/1/ssh-copy-id)
-and copied to the host using [ssh-copy-id](https://linux.die.net/man/1/ssh-copy-id).
-The authorized_keys file is [cleaned up](https://github.com/cssnr/stack-deploy-action/blob/master/src/main.sh#L10) after each deploy.
+and copied to the host with [ssh-copy-id](https://linux.die.net/man/1/ssh-copy-id) using [sshpass](https://linux.die.net/man/1/sshpass).
+The authorized_keys file entry is [cleaned up](https://github.com/cssnr/stack-deploy-action/blob/master/src/main.sh#L10) after each deploy.
 
-To generate an SSH run the following as the `user` you are using:
+To generate an SSH key, run the following as the `user` you are using:
 
 ::: code-group
 
@@ -121,29 +127,36 @@ This will disable the [ssh-keyscan](https://linux.die.net/man/1/ssh-keyscan) com
 
 Variables in this file are exported before running stack deploy.
 If you need compose file templating this can also be done in a previous step.
-If using `mode: compose` you can also add the `compose_arg: --env-file stringArray`.
+
+_Compose._ You can also add to the [args](#args) with `--env-file stringArray`.
 
 ::: tip IMPORTANT
 **This is NOT** the Docker compose [env_file](https://docs.docker.com/compose/how-tos/environment-variables/set-environment-variables/#use-the-env_file-attribute) directive.
 That is set in your compose file as normal.
 :::
 
-### detach
+### detach <Badge type="warning">Swarm Only</Badge> {#detach}
 
-**Swarm Only.** Set this to `false` to not exit immediately and wait for the services to converge.
+Set this to `false` to not exit immediately and wait for the services to converge.
 This will generate extra output in the logs and is useful for debugging deployments.
 
 Defaults to `false` in `mode: compose`.
 
-### resolve_image
+See the [stack deploy Options](https://docs.docker.com/reference/cli/docker/stack/deploy/#options) for more details.
+
+### resolve_image <Badge type="warning">Swarm Only</Badge> {#resolve-image}
+
+When the default `always` is used, this argument is omitted.
+
+See the [stack deploy Options](https://docs.docker.com/reference/cli/docker/stack/deploy/#options) for more details.
 
-**Swarm Only.** When the default `always` is used, this argument is omitted.
+### registry_auth <Badge type="warning">Swarm Only</Badge> {#registry-auth}
 
-### registry_auth
+Set to `true` to deploy with `--with-registry-auth`.
 
-**Swarm Only.** Set to `true` to deploy with `--with-registry-auth`.
+If setting [registry_user](#registry-user-registry-pass)/[registry_pass](#registry-user-registry-pass) this is implied.
 
-If setting `registry_user`/`registry_pass` this is implied.
+See the [stack deploy Options](https://docs.docker.com/reference/cli/docker/stack/deploy/#options) for more details.
 
 ### registry_host
 
diff --git a/docs/guides/features.md b/docs/guides/features.md
@@ -4,12 +4,14 @@ Deploy a Docker [stack](https://docs.docker.com/reference/cli/docker/stack/deplo
 using a [remote context](https://docs.docker.com/engine/manage-resources/contexts/). This deploys the stack from the current workspace without copying files.
 
 - Deploy to Docker Swarm or Compose.
-- Deploy over SSH using keyfile or password.
+- Deploy over SSH using [keyfile](../docs/inputs.md#pass-ssh-key) or [password](../docs/inputs.md#pass-ssh-key).
 - Deploy from the current working directory.
-- Deploy from a private registry with credentials.
+- Deploy from a private registry with [credentials](../docs/inputs.md#registry-user-registry-pass).
 - [Job Summary](#job-summary) with deployment output, including errors.
-- Supports multiple compose file and stack deployments.
-- Allows setting custom arguments for the deployment command.
+- Supports multiple compose [files](../docs/inputs.md#file) and stack deployments.
+- Allows setting custom [arguments](../docs/inputs.md#args) for the deployment command.
+
+See the [Inputs Documentation](../docs/inputs.md) for more options.
 
 You can [get started here](get-started.md) or view [workflow examples](examples.md).
 
diff --git a/docs/guides/get-started.md b/docs/guides/get-started.md
@@ -25,28 +25,29 @@ _If creating a [new workflow](https://docs.github.com/en/actions/concepts/workfl
 
 **Make sure to update the highlighted lines.**
 
-The only required inputs are `name`, `host`, `user` and `pass` or `ssh_key` _(not both)_.
+The only required inputs are [name](../docs/inputs.md#name), [host](../docs/inputs.md#host), `user`
+and [pass](../docs/inputs.md#pass-ssh-key) or [ssh_key](../docs/inputs.md#pass-ssh-key) _(not both)_.
 
-See the [Inputs Documentation](../docs/inputs.md) for more options and **default** values.
+> See the [Inputs Documentation](../docs/inputs.md) for more options and **default** values.
 
 ## Usage
 
 The stack is deployed from the current actions working directory (no files copied). Therefore, all paths are relative to the actions' directory.
 
-If you check out your repository to the root and your compose file is in the `app` directory, set `file` to: `app/docker-compose.yaml`
+If you check out your repository to the root and your compose file is in the `app` directory, set [file](../docs/inputs.md#file) to: `app/docker-compose.yaml`
 
 If using the [env_file](https://docs.docker.com/compose/how-tos/environment-variables/set-environment-variables/#use-the-env_file-attribute) compose directive in your stack file, this file's path would be relative to your `docker-compose.yaml` file.
 
 The workflow runs based on the [events](https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows) defined in the `on:` parameter.
 If using the `workflow_dispatch` trigger you can [manually run the job](https://docs.github.com/en/actions/how-tos/manage-workflow-runs/manually-run-a-workflow) at any time.
 
-There are many more [options](../docs/inputs.md) to customize your deployment.
+> See the [Inputs Documentation](../docs/inputs.md) for more options to customize your deployment.
 
 ## Secrets
 
 You should store your credentials in [GitHub Actions Secrets](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets).
 
-The SSH Key should be copied and pasted exactly as it appears in the private key file.
+The [SSH key](../docs/inputs.md#pass-ssh-key) should be copied and pasted exactly as it appears in the private key file.
 
 You do not need to add all values as a secret. However, be aware that any inputs not added as a secret,
 will be visible in the [GitHub Actions Logs](https://docs.github.com/en/actions/how-tos/monitor-workflows/use-workflow-run-logs).
@@ -76,11 +77,7 @@ Compose Note: `"${STACK_FILES[@]}"` is an array of `-f docker-compose.yaml` for
 
 You can view the full deployment script on GitHub: [src/main.sh](https://github.com/cssnr/stack-deploy-action/blob/master/src/main.sh)
 
-See the [Inputs Documentation](../docs/inputs.md) for more options to customize the deployment.
-
-::: info FEATURE REQUEST
-If you need more options, please [open a feature request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests)
-:::
+> See the [Inputs Documentation](../docs/inputs.md) for more options to customize the deployment.
 
 ## Portainer
 
@@ -92,3 +89,7 @@ For this you should use: [cssnr/portainer-stack-deploy-action](https://github.co
 
 For more details see the [README.md](https://github.com/cssnr/portainer-stack-deploy-action?tab=readme-ov-file#readme) on GitHub.
 [Support](https://github.com/cssnr/portainer-stack-deploy-action?tab=readme-ov-file#Support) is also available.
+
+::: info FEATURE REQUEST
+If you need more options, please [open a feature request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests)
+:::
diff --git a/docs/snippets/examples/compose/full.yaml b/docs/snippets/examples/compose/full.yaml
@@ -2,7 +2,7 @@
   uses: cssnr/stack-deploy-action@v1
   with:
     name: "stack-name"
-    file: "docker-compose-swarm.yaml"
+    file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
     port: ${{ secrets.DOCKER_PORT }}
     user: ${{ secrets.DOCKER_USER }}
diff --git a/docs/snippets/examples/swarm/full.yaml b/docs/snippets/examples/swarm/full.yaml
@@ -2,7 +2,7 @@
   uses: cssnr/stack-deploy-action@v1
   with:
     name: "stack-name"
-    file: "docker-compose-swarm.yaml"
+    file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
     port: ${{ secrets.DOCKER_PORT }}
     user: ${{ secrets.DOCKER_USER }}
diff --git a/docs/snippets/examples/swarm/options.yaml b/docs/snippets/examples/swarm/options.yaml
@@ -2,7 +2,7 @@
   uses: cssnr/stack-deploy-action@v1
   with:
     name: "stack-name"
-    file: "docker-compose-swarm.yaml"
+    file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
     port: ${{ secrets.DOCKER_PORT }}
     user: ${{ secrets.DOCKER_USER }}
diff --git a/docs/snippets/examples/swarm/registry.yaml b/docs/snippets/examples/swarm/registry.yaml
@@ -2,7 +2,7 @@
   uses: cssnr/stack-deploy-action@v1
   with:
     name: "stack-name"
-    file: "docker-compose-swarm.yaml"
+    file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
     port: ${{ secrets.DOCKER_PORT }}
     user: ${{ secrets.DOCKER_USER }}
diff --git a/docs/snippets/examples/workflows/full.yaml b/docs/snippets/examples/workflows/full.yaml
@@ -69,7 +69,7 @@ jobs:
         uses: cssnr/stack-deploy-action@v1
         with:
           name: "stack-name"
-          file: "docker-compose-swarm.yaml"
+          file: "docker-compose.yaml"
           host: ${{ secrets.DOCKER_HOST }}
           port: ${{ secrets.DOCKER_PORT }}
           user: ${{ secrets.DOCKER_USER }}
diff --git a/docs/snippets/examples/workflows/simple.yaml b/docs/snippets/examples/workflows/simple.yaml
@@ -17,7 +17,7 @@ jobs:
         uses: cssnr/stack-deploy-action@v1
         with:
           name: "stack-name"
-          file: "docker-compose-swarm.yaml"
+          file: "docker-compose.yaml"
           host: ${{ secrets.DOCKER_HOST }}
           port: ${{ secrets.DOCKER_PORT }}
           user: ${{ secrets.DOCKER_USER }}
