Skip to content

Commit 93570ff

Browse files
committed
Change to View or Edit
1 parent 00e7dce commit 93570ff

File tree

4 files changed

+22
-23
lines changed

4 files changed

+22
-23
lines changed

.vitepress/config.mts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ export default defineConfig({
4545
description: settings.description.short,
4646
head: [
4747
['link', { rel: 'icon', type: 'image/x-icon', href: '/favicon.ico' }],
48+
// ['link', { rel: 'icon', type: 'image/svg', sizes: 'any', href: '/images/logo/logo.svg' }],
4849
['link', { rel: 'apple-touch-icon', type: 'image/png', sizes: '180x180', href: '/apple-touch-icon.png' }],
4950
['link', { rel: 'icon', type: 'image/png', sizes: '32x32', href: '/images/logo/logo32.png' }],
5051
['link', { rel: 'icon', type: 'image/png', sizes: '16x16', href: '/images/logo/logo16.png' }],
@@ -148,7 +149,7 @@ export default defineConfig({
148149

149150
editLink: {
150151
pattern: `${settings.docs_repo}/blob/master/docs/:path`,
151-
text: 'View on GitHub',
152+
text: 'View or Edit on GitHub',
152153
},
153154

154155
lastUpdated: {

docs/guides/features.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ using a [Remote Context](#remote-context). This deploys the stack from the curre
1010
- [Job Summary](#job-summary) with deployment output, including errors.
1111
- Supports multiple compose [files](../docs/inputs.md#file) and stack deployments.
1212
- Allows setting custom [arguments](../docs/inputs.md#args) for the deployment command.
13-
14-
See the [Inputs Documentation](../docs/inputs.md) for more options.
13+
- **To view all features see the [Inputs Documentation](../docs/inputs.md).**
1514

1615
You can [get started here](get-started.md) or view [workflow examples](examples.md).
1716

docs/guides/get-started.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -43,22 +43,6 @@ If using the `workflow_dispatch` trigger you can [manually run the job](https://
4343

4444
> See the [Inputs Documentation](../docs/inputs.md) for more options to customize your deployment.
4545
46-
## Secrets
47-
48-
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).
49-
50-
The [SSH key](../docs/inputs.md#ssh_key) should be copied and pasted exactly as it appears in the private key file.
51-
52-
You do not need to add all values as a secret. However, be aware that any inputs not added as a secret,
53-
will be visible in the [GitHub Actions Logs](https://docs.github.com/en/actions/how-tos/monitor-workflows/use-workflow-run-logs).
54-
55-
Likewise, if you add your GitHub username or the port number 22 as a secret,
56-
these values will be replaced with `***`'s anywhere they appear in the logs, including repository names.
57-
58-
If working within an [GitHub Organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations)
59-
you can create these secrets in the organization and make them available to all your repositories.
60-
_This is why I use the [cssnr](https://github.com/cssnr) organization._
61-
6246
## Command
6347

6448
The command used to deploy the stack is generated depending on mode.
@@ -81,6 +65,22 @@ You can view the full deployment script on GitHub: [src/main.sh](https://github.
8165

8266
> See the [Inputs Documentation](../docs/inputs.md) for more options to customize the deployment.
8367
68+
## Secrets
69+
70+
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).
71+
72+
The [SSH key](../docs/inputs.md#ssh_key) should be copied and pasted exactly as it appears in the private keyfile.
73+
74+
You do not need to add all values as a secret. However, be aware that any inputs not added as a secret,
75+
will be visible in the [GitHub Actions Logs](https://docs.github.com/en/actions/how-tos/monitor-workflows/use-workflow-run-logs).
76+
77+
Likewise, if you add your GitHub username or the port number 22 as a secret,
78+
these values will be replaced with `***`'s anywhere they appear in the logs, including repository names.
79+
80+
If working within an [GitHub Organization](https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations)
81+
you can create these secrets in the organization and make them available to all your repositories.
82+
_This is why I use the [cssnr](https://github.com/cssnr) organization._
83+
8484
## Portainer
8585

8686
If you use Portainer, you should deploy directly to [Portainer](https://www.portainer.io/resources/get-started/install) for full control.
@@ -89,8 +89,7 @@ For this you should use: [cssnr/portainer-stack-deploy-action](https://github.co
8989

9090
- https://github.com/marketplace/actions/portainer-stack-deploy-action
9191

92-
For more details see the [README.md](https://github.com/cssnr/portainer-stack-deploy-action?tab=readme-ov-file#readme) on GitHub.
93-
[Support](https://github.com/cssnr/portainer-stack-deploy-action?tab=readme-ov-file#Support) is also available.
92+
For more details visit the website: https://portainer-deploy.cssnr.com/
9493

9594
 
9695

docs/guides/resources.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ This action was built from the ground up to deploy a Docker swarm stack
1919
then updated to allow Docker compose deployments.
2020

2121
The goal of this action is to be the ultimate Docker deployment action on GitHub.
22-
To date every [issue](https://github.com/cssnr/stack-deploy-action/issues) has been fixed
23-
and all [feature requests](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests) have been added.
22+
To date all [issue](https://github.com/cssnr/stack-deploy-action/issues) have been fixed
23+
and all [feature requests](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests) added.
2424

2525
::: warning
2626
None of these actions have been tested. This is an exhaustive list of published actions.

0 commit comments

Comments
 (0)