diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b46af9e76..5e8e305ef 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -526,7 +526,7 @@ If you are using GoLand, use the **Go Remote** debug configuration and make sure ### Command Documentation -Our commands are documented at and that documentation is +Our commands are documented at and that documentation is generated by our CLI. You should regenerate that documentation when you change any files in **cmd/porter** by running `mage DocsGen` which is run every time you run `mage build`. diff --git a/docs/content/architecture.md b/docs/content/architecture.md index b2ba3ad96..669db29d0 100644 --- a/docs/content/architecture.md +++ b/docs/content/architecture.md @@ -45,7 +45,7 @@ Learn more about [how Porter works at runtime](/architecture-runtime/). * [Security Features](/security-features/) * [Create a Bundle](/getting-started/create-bundle/) -* [Distribute Bundles](/development/distribute-bundles/) -* [Airgapped Deployments](/administrators/airgap/) +* [Distribute Bundles](/development/authoring-a-bundle/distribute-bundles//) +* [Airgapped Deployments](/administration/move-bundles-airgapped/) [mixins]: /mixins/ diff --git a/docs/content/blog/porter-collaboration.md b/docs/content/blog/porter-collaboration.md index 58df46512..6032cdbd7 100644 --- a/docs/content/blog/porter-collaboration.md +++ b/docs/content/blog/porter-collaboration.md @@ -64,5 +64,5 @@ overview of CNAB, demos of bundles in action and more. [azure-plugin]: /plugins/azure/ [slack]: /community/#slack [install]: /install/ -[tutorial]: /plugins/tutorial/ +[tutorial]: /how-to-guides/work-with-plugins/ [learning]: /learning/ diff --git a/docs/content/blog/using-docker-in-bundles.md b/docs/content/blog/using-docker-in-bundles.md index 4f01e07e9..49c78a015 100644 --- a/docs/content/blog/using-docker-in-bundles.md +++ b/docs/content/blog/using-docker-in-bundles.md @@ -96,7 +96,7 @@ install: This blog post focuses on just the docker mixin, but here is a [full working example for how to use Docker Compose in a -bundle](/examples/src/compose/). +bundle](/examples/src/dockerapp/). ### Use Docker @@ -234,6 +234,6 @@ us to take this further, please reach out on the [porter][porter-repo] or [docke repositories! [porter-repo]: https://github.com/getporter/porter/ -[docker-repo]: https://github.com/getporter/mixin-docker/ +[docker-repo]: https://github.com/getporter/docker-mixin [compose-spec]: https://www.compose-spec.io/ [docker mixin]: /mixins/docker/ diff --git a/docs/content/blog/v1-is-here.md b/docs/content/blog/v1-is-here.md index f49fac9dd..857e7df4c 100644 --- a/docs/content/blog/v1-is-here.md +++ b/docs/content/blog/v1-is-here.md @@ -76,7 +76,7 @@ Read more about Porter's [security features](/security-features/). Our v1 release is not a stopping point, but instead a way point where we can now say "Porter is stable and safe to use in production". We have big plans going forward, adding new features on top of v1 incrementally: -* **Advanced Dependencies**: Our initial implementation of dependencies was always limited in scope. More complete and powerful dependency support is already underway. Learn more in [PEP003 Advanced Dependencies](https://github.com/getporter/proposals/blob/main/pep/003-dependency-namespaces-and-labels.md). +* **Advanced Dependencies**: Our initial implementation of dependencies was always limited in scope. More complete and powerful dependency support is already underway. Learn more in [PEP003 Advanced Dependencies](https://github.com/getporter/proposals/blob/main/pep/003-advanced-dependencies.md). * **Distribute Mixins as Bundles**: After we have advanced dependency support, we are improving how mixins are distributed and executed so that they are BUNDLES! This will significantly improve performance, layer caching, mixin distribution, and bundle execution security. Learn more in [PEEP005 Mixins are Bundles](https://github.com/getporter/proposals/blob/main/pep/005-mixins-are-bundles.md). * **Porter Operator v1**: The [Porter Operator] is far enough along for you to try, and we aim to quickly get it ready for a v1 release. * **Support for signing bundles**: Porter will support integration with Notary for signing and verifying bundles. diff --git a/docs/content/blog/v1-roadmap.md b/docs/content/blog/v1-roadmap.md index fb76208bd..bef8f1072 100644 --- a/docs/content/blog/v1-roadmap.md +++ b/docs/content/blog/v1-roadmap.md @@ -39,7 +39,7 @@ We always welcome new contributors, even if you are new to Go, containers, or ev If you'd like to help us with v1 or contribute to the larger features in our pipeline, the [new contributor guide] is where to start. 🚀 [v1 milestone]: https://github.com/getporter/porter/milestone/16 -[version strategy]: /project/version-strategy/ +[version strategy]: /references/version-strategy/ [buildkit]: https://github.com/getporter/porter/pull/1567 [advanced dependency management]: https://github.com/getporter/proposals/pull/8 [labels and namespaces]: https://github.com/cnabio/cnab-spec/pull/411 diff --git a/docs/content/docs/bundle/manifest/_index.md b/docs/content/docs/bundle/manifest/_index.md index 1d0614711..fd3a5caca 100644 --- a/docs/content/docs/bundle/manifest/_index.md +++ b/docs/content/docs/bundle/manifest/_index.md @@ -31,7 +31,7 @@ The manifest is made up of multiple components. See the [Manifest File Format] f We have full [examples](https://github.com/getporter/examples) of Porter manifests in the Porter repository. -[templates]: /development/using-templates/ +[templates]: /development/authoring-a-bundle/using-templates/ [Manifest File Format]: /reference/file-formats/#manifest ## Bundle Metadata @@ -476,7 +476,7 @@ similar to `help`, but has a different name, you should declare it in the `custo ## Dependencies Dependencies are an extension of the [CNAB Spec](https://github.com/cnabio/cnab-spec/blob/master/500-CNAB-dependencies.md). -See [dependencies](/dependencies/) for more details on how Porter handles dependencies. +See [dependencies](/development/authoring-a-bundle/working-with-dependencies/) for more details on how Porter handles dependencies. ```yaml dependencies: @@ -621,5 +621,5 @@ be copied into the final bundle so that you can access them at runtime. The path * [Manifest File Format](/reference/file-formats/#manifest) * [Using Mixins](/use-mixins/) -* [Bundle Dependencies](/dependencies/) +* [Bundle Dependencies](/development/authoring-a-bundle/working-with-dependencies/) * [Parameters, Credentials, Outputs, and Images in Porter](/wiring/) diff --git a/docs/content/docs/bundle/manifest/file-format/_index.md b/docs/content/docs/bundle/manifest/file-format/_index.md index eec710c76..342fd62a6 100644 --- a/docs/content/docs/bundle/manifest/file-format/_index.md +++ b/docs/content/docs/bundle/manifest/file-format/_index.md @@ -233,7 +233,7 @@ status: ## Next Steps -* [Create a Bundle](/bundle/create/) +* [Create a Bundle](/development/authoring-a-bundle/create-a-bundle/) [semver v2]: https://semver.org/spec/v2.0.0.html [manifest-schema]: https://raw.githubusercontent.com/getporter/porter/main/pkg/schema/manifest.schema.json diff --git a/docs/content/docs/development/authoring-a-bundle/create-a-bundle.md b/docs/content/docs/development/authoring-a-bundle/create-a-bundle.md index 048d0d8b0..64f521cd8 100644 --- a/docs/content/docs/development/authoring-a-bundle/create-a-bundle.md +++ b/docs/content/docs/development/authoring-a-bundle/create-a-bundle.md @@ -185,7 +185,7 @@ Now that you know how to create a bundle, here are some more detailed topics on - [Customize your Porter manifest, porter.yaml][manifest] - [Porter Manifest File Format](/bundle/manifest/file-format/) - [Best Practices for the exec Mixin](/best-practices/exec-mixin/) -- [Understand how bundles are distributed](/distribute-bundles/) +- [Understand how bundles are distributed](/development/authoring-a-bundle/distribute-bundles/) [install Porter]: /install/ [Porter Visual Studio Code]: https://marketplace.visualstudio.com/items?itemName=getporter.porter-vscode @@ -198,7 +198,7 @@ Now that you know how to create a bundle, here are some more detailed topics on [porter install]: /cli/porter_install/ [porter mixins search]: /cli/porter_mixins_search/ [porter explain]: /cli/porter_explain/ -[porter mixin install]: /cli/porter_mixin_install/ +[porter mixin install]: /cli/porter_mixins_install/ [Mixins]: /mixins/ [create a custom mixin]: /mixin-dev-guide/ [terraform mixin]: /mixins/terraform/ diff --git a/docs/content/docs/references/cli/bundles/_index.md b/docs/content/docs/references/cli/bundles/_index.md index d1a6f4e2f..1bb1563f2 100644 --- a/docs/content/docs/references/cli/bundles/_index.md +++ b/docs/content/docs/references/cli/bundles/_index.md @@ -24,7 +24,7 @@ Commands for working with bundles. These all have shortcuts so that you can call ### SEE ALSO -- [porter](/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command. +- [porter](/references/cli/porter/) - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command. Most commands require a Docker daemon, either local or remote. diff --git a/docs/content/docs/references/cli/porter.md b/docs/content/docs/references/cli/porter.md index 4eb7a3e92..918f8160b 100644 --- a/docs/content/docs/references/cli/porter.md +++ b/docs/content/docs/references/cli/porter.md @@ -36,22 +36,22 @@ porter [flags] - [porter archive](/cli/porter_archive/) - Archive a bundle from a reference - [porter build](/cli/porter_build/) - Build a bundle -- [porter bundles](/cli/porter_bundles/) - Bundle commands +- [porter bundles](/cli/references/cli/bundles/) - Bundle commands - [porter completion](/cli/porter_completion/) - Generate completion script - [porter copy](/cli/porter_copy/) - Copy a bundle - [porter create](/cli/porter_create/) - Create a bundle -- [porter credentials](/cli/porter_credentials/) - Credentials commands +- [porter credentials](/references/cli/credentials/) - Credentials commands - [porter explain](/cli/porter_explain/) - Explain a bundle - [porter inspect](/cli/porter_inspect/) - Inspect a bundle - [porter install](/cli/porter_install/) - Create a new installation of a bundle -- [porter installations](/cli/porter_installations/) - Installation commands +- [porter installations](/references/cli/installations/) - Installation commands - [porter invoke](/cli/porter_invoke/) - Invoke a custom action on an installation - [porter lint](/cli/porter_lint/) - Lint a bundle - [porter list](/cli/porter_list/) - List installed bundles - [porter logs](/cli/porter_logs/) - Show the logs from an installation -- [porter mixins](/cli/porter_mixins/) - Mixin commands. Mixins assist with authoring bundles. -- [porter parameters](/cli/porter_parameters/) - Parameter set commands -- [porter plugins](/cli/porter_plugins/) - Plugin commands. Plugins enable Porter to work on different cloud providers and systems. +- [porter mixins](/references/cli/mixins/) - Mixin commands. Mixins assist with authoring bundles. +- [porter parameters](/references/cli/parameters/) - Parameter set commands +- [porter plugins](/references/cli/plugins/) - Plugin commands. Plugins enable Porter to work on different cloud providers and systems. - [porter publish](/cli/porter_publish/) - Publish a bundle - [porter schema](/cli/porter_schema/) - Print the JSON schema for the Porter manifest - [porter show](/cli/porter_show/) - Show an installation of a bundle diff --git a/docs/content/security-features.md b/docs/content/security-features.md index 786aca46c..8cc0c8677 100644 --- a/docs/content/security-features.md +++ b/docs/content/security-features.md @@ -79,5 +79,5 @@ But by default, that foot gun is disabled. * [Airgapped Deployments](/references/examples/airgap/) * [Blog: Upgrade your plugins to securely store sensitive data](/blog/persist-sensitive-data-safely/) -[credential sets]: /introduction/intro-credentials/#credential-sets +[credential sets]: /introduction/concepts-and-components/intro-credentials/#credential-sets [secrets plugins]: /plugins/types/#secrets diff --git a/docs/content/wiring.md b/docs/content/wiring.md index f8e50c0ca..4583136ca 100644 --- a/docs/content/wiring.md +++ b/docs/content/wiring.md @@ -420,7 +420,7 @@ install: mariadb.enabled: false ``` -For more information on how dependencies are handled, refer to the [dependencies](/development/working-with-dependencies/) documentation. +For more information on how dependencies are handled, refer to the [dependencies](/development/authoring-a-bundle/working-with-dependencies/) documentation. ## Combining References