diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 6545b30..bbebe63 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -38,7 +38,7 @@ export default defineConfig({ config(md) { md.use(groupIconMdPlugin) }, - // toc: { level: [2] }, + toc: { level: [2] }, }, title: settings.title, diff --git a/.vitepress/theme/components/StackTable.vue b/.vitepress/theme/components/StackTable.vue new file mode 100644 index 0000000..564f563 --- /dev/null +++ b/.vitepress/theme/components/StackTable.vue @@ -0,0 +1,94 @@ + + + + + diff --git a/.vitepress/theme/custom.css b/.vitepress/theme/custom.css index d6d9bbe..d38fad4 100644 --- a/.vitepress/theme/custom.css +++ b/.vitepress/theme/custom.css @@ -17,6 +17,10 @@ summary { cursor: pointer; } +table th { + text-wrap: nowrap; +} + .vp-doc img { display: inline-block; margin-right: 8px; diff --git a/.vitepress/theme/index.js b/.vitepress/theme/index.js index b6f3287..d398ca2 100644 --- a/.vitepress/theme/index.js +++ b/.vitepress/theme/index.js @@ -4,6 +4,7 @@ import 'virtual:group-icons.css' import Contributors from './components/Contributors.vue' import YouTubeEmbed from './components/YouTubeEmbed.vue' +import StackTable from './components/StackTable.vue' // noinspection JSUnusedGlobalSymbols export default { @@ -13,5 +14,6 @@ export default { app.component('Badge', VPBadge) app.component('Contributors', Contributors) app.component('YouTubeEmbed', YouTubeEmbed) + app.component('StackTable', StackTable) }, } diff --git a/docs/docs/inputs.md b/docs/docs/inputs.md index 4288d35..fb58f60 100644 --- a/docs/docs/inputs.md +++ b/docs/docs/inputs.md @@ -1,10 +1,6 @@ # Inputs -The inputs are organized in a table for quick [reference](#reference) with additional [details](#details) below. - -## Reference - -💡 You can click on an input for more [Details](#details). +💡 Click on the **Input Name** for more [Details](#details). | Input Name | Default Value | Short Description of the Input Value | | :------------------------------------ | :---------------------------------- | :------------------------------------------------------------ | @@ -161,7 +157,7 @@ If you need compose file templating this can also be done in a previous step. _Compose._ You can also add to the [args](#args) with `--env-file stringArray`. -::: tip IMPORTANT +::: info **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. ::: @@ -179,7 +175,7 @@ Default: `true` ### prune -Prune dangling images. Set to `true` to enable. +Prune services that are no longer referenced. Set to `true` to enable. _See the [stack deploy Options](https://docs.docker.com/reference/cli/docker/stack/deploy/#options) for more details._ @@ -223,6 +219,6 @@ Required to run [docker login](https://docs.docker.com/reference/cli/docker/logi Write a Summary for the job. To disable this set to `false`. -_For more information see [Job Summary](../guides/features.md#job-summary)._ +For more information see [Job Summary](../guides/features.md#job-summary). Default: `true` diff --git a/docs/guides/features.md b/docs/guides/features.md index 96133ab..f09fe71 100644 --- a/docs/guides/features.md +++ b/docs/guides/features.md @@ -15,7 +15,7 @@ See the [Inputs Documentation](../docs/inputs.md) for more options. You can [get started here](get-started.md) or view [workflow examples](examples.md). -::: info FEATURE REQUEST +::: tip Request a Feature 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/guides/get-started.md b/docs/guides/get-started.md index 3e50c8c..4aea3ab 100644 --- a/docs/guides/get-started.md +++ b/docs/guides/get-started.md @@ -94,6 +94,6 @@ For more details see the [README.md](https://github.com/cssnr/portainer-stack-de   -::: info FEATURE REQUEST +::: tip Request a Feature 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/guides/resources.md b/docs/guides/resources.md index 264af37..658c7da 100644 --- a/docs/guides/resources.md +++ b/docs/guides/resources.md @@ -10,9 +10,88 @@ A collection of resources and guides for getting started. +## Action Comparison + +The majority of other actions available have not been recently updated +and most of them are forks and clones of each other. + +This action was built from the ground up to deploy a Docker swarm stack +then updated to allow Docker compose deployments. + +The goal of this action is to be the ultimate Docker deployment action on GitHub. +To date every [issue](https://github.com/cssnr/stack-deploy-action/issues) has been fixed +and all [feature requests](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests) have been added. + +::: warning +None of these actions have been tested. This is an exhaustive list of published actions. +::: + + + +> **Updated** - Link to Pulse (activity) +> **Language** - Link to Dependants (users) + +If there are any missing [features](../guides/features.md) you need, +please submit a [feature request](https://github.com/cssnr/stack-deploy-action/discussions/categories/feature-requests) and we will get them added... +   -::: tip +::: tip Additional Resources Have a related resource? Let us know by submitting a [PR](https://github.com/cssnr/stack-deploy-docs/edit/master/docs/guides/examples.md) or opening an [Issue](https://github.com/cssnr/stack-deploy-docs/issues) on [GitHub](https://github.com/cssnr/stack-deploy-docs). :::