Standardize Examples

Author: smashedr

docs/docs/inputs.md

@@ -46,7 +46,8 @@ 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.
+_Compose._ [Multiple files](https://docs.docker.com/compose/how-tos/multiple-compose-files/) can be provided, **space seperated**,
+and the `-f` flag will be automatically prepended to each file.
 
 Example: `web.yaml db.yaml`  
 Output: `-f web.yaml -f db.yaml`
@@ -55,7 +56,8 @@ Output: `-f web.yaml -f db.yaml`
 
 Enable Docker Compose mode by setting this to `compose`.
 
-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.
+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.
 
 Example: `compose`
 

docs/guides/get-started.md

@@ -6,7 +6,7 @@ prev:
 
 # Getting Started
 
-<span class="search-keywords">Install and Setup Guide.</span>
+<span class="search-keywords">Install and Setup Guide to Begin.</span>
 
 To get started, create or update your [workflow file](#workflow) and review the [usage](#secrets).
 
@@ -25,7 +25,7 @@ _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](../docs/inputs.md#name), [host](../docs/inputs.md#host), `user`
+The only 4 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.

docs/snippets/examples/compose/basic.yaml

@@ -1,10 +1,10 @@
-- name: "Compose Deploy"
+- name: "Stack Deploy"
   uses: cssnr/stack-deploy-action@v1
   with:
     name: "stack-name"
     file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
-    port: ${{ secrets.DOCKER_PORT }}
     user: ${{ secrets.DOCKER_USER }}
-    ssh_key: ${{ secrets.DOCKER_SSH_KEY }}
+    pass: ${{ secrets.DOCKER_PASS }} # not needed with ssh_key
+    ssh_key: ${{ secrets.DOCKER_SSH_KEY }} # not needed with pass
     mode: compose

docs/snippets/examples/compose/full.yaml

@@ -4,8 +4,8 @@
     name: "stack-name"
     file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
-    port: ${{ secrets.DOCKER_PORT }}
     user: ${{ secrets.DOCKER_USER }}
+    port: 22 # 22 is default, you can remove or change this
     pass: ${{ secrets.DOCKER_PASS }} # not needed with ssh_key
     ssh_key: ${{ secrets.DOCKER_SSH_KEY }} # not needed with pass
     env_file: "stack.env"

docs/snippets/examples/compose/options.yaml

@@ -1,11 +1,11 @@
-- name: "Compose Deploy"
+- name: "Stack Deploy"
   uses: cssnr/stack-deploy-action@v1
   with:
     name: "stack-name"
     file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
-    port: ${{ secrets.DOCKER_PORT }}
     user: ${{ secrets.DOCKER_USER }}
-    ssh_key: ${{ secrets.DOCKER_SSH_KEY }}
+    pass: ${{ secrets.DOCKER_PASS }} # not needed with ssh_key
+    ssh_key: ${{ secrets.DOCKER_SSH_KEY }} # not needed with pass
     mode: compose
     args: --remove-orphans --force-recreate

docs/snippets/examples/compose/registry.yaml

@@ -1,12 +1,12 @@
-- name: "Compose Deploy"
+- name: "Stack Deploy"
   uses: cssnr/stack-deploy-action@v1
   with:
     name: "stack-name"
     file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
-    port: ${{ secrets.DOCKER_PORT }}
     user: ${{ secrets.DOCKER_USER }}
-    ssh_key: ${{ secrets.DOCKER_SSH_KEY }}
+    pass: ${{ secrets.DOCKER_PASS }} # not needed with ssh_key
+    ssh_key: ${{ secrets.DOCKER_SSH_KEY }} # not needed with pass
     registry_host: "ghcr.io"
     registry_user: ${{ vars.GHCR_USER }}
     registry_pass: ${{ secrets.GHCR_PASS }}

docs/snippets/examples/swarm/basic.yaml

@@ -5,6 +5,5 @@
     file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
     user: ${{ secrets.DOCKER_USER }}
-    port: ${{ secrets.DOCKER_PORT }} # default 22
     pass: ${{ secrets.DOCKER_PASS }} # not needed with ssh_key
     ssh_key: ${{ secrets.DOCKER_SSH_KEY }} # not needed with pass

docs/snippets/examples/swarm/full.yaml

@@ -4,8 +4,8 @@
     name: "stack-name"
     file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
-    port: ${{ secrets.DOCKER_PORT }}
     user: ${{ secrets.DOCKER_USER }}
+    port: 22 # 22 is default, you can remove or change this
     pass: ${{ secrets.DOCKER_PASS }} # not needed with ssh_key
     ssh_key: ${{ secrets.DOCKER_SSH_KEY }} # not needed with pass
     env_file: "stack.env"

docs/snippets/examples/swarm/options.yaml

@@ -4,9 +4,9 @@
     name: "stack-name"
     file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
-    port: ${{ secrets.DOCKER_PORT }}
     user: ${{ secrets.DOCKER_USER }}
-    ssh_key: ${{ secrets.DOCKER_SSH_KEY }}
+    pass: ${{ secrets.DOCKER_PASS }} # not needed with ssh_key
+    ssh_key: ${{ secrets.DOCKER_SSH_KEY }} # not needed with pass
     detach: false
     prune: true
     resolve_image: "changed"

docs/snippets/examples/swarm/registry.yaml

@@ -4,9 +4,9 @@
     name: "stack-name"
     file: "docker-compose.yaml"
     host: ${{ secrets.DOCKER_HOST }}
-    port: ${{ secrets.DOCKER_PORT }}
     user: ${{ secrets.DOCKER_USER }}
-    pass: ${{ secrets.DOCKER_PASS }}
+    pass: ${{ secrets.DOCKER_PASS }} # not needed with ssh_key
+    ssh_key: ${{ secrets.DOCKER_SSH_KEY }} # not needed with pass
     registry_host: "ghcr.io"
     registry_user: ${{ vars.GHCR_USER }}
     registry_pass: ${{ secrets.GHCR_PASS }}