diff --git a/docs/content/author-bundles.md b/docs/content/author-bundles.md index a169c8ffdd..f16ff43b93 100644 --- a/docs/content/author-bundles.md +++ b/docs/content/author-bundles.md @@ -5,8 +5,11 @@ aliases: - /authoring-bundles/ --- -Porter generates a bundle from its manifest, porter.yaml. -Manifests use [templates] for variable substitution. +Use the [porter create](/cli/porter_create) command to scaffold a new bundle in the current directory. +The bundle is defined by its manifest, a porter.yaml file. +The manifest supports variable substitution through [templates]. +You can [customize the Dockerfile](/custom-dockerfile/) used to build the bundle installer. + The manifest is made up of multiple components: * [Bundle Metadata](#bundle-metadata) @@ -67,11 +70,8 @@ maintainers: Mixins are adapters between the Porter and an existing tool or system. They know how to talk to Porter to include everything they need to run, such as a CLI or config files, and how to execute their steps in the Porter manifest. -Anyone can [create a mixin](/mixin-dev-guide/), here's a list of the mixins that are installed with Porter by default: - -* exec - run shell scripts and commands -* helm - use the helm cli -* azure - provision services on the Azure cloud +There are [many mixins](/mixins/) created both by the Porter Authors and the community. +Only the [exec mixin](/mixins/exec/) is installed by default. Declare the mixins that your bundle uses with the `mixins` section of the manifest: diff --git a/docs/content/examples/_index.md b/docs/content/examples/_index.md index 30398b6673..5c73ae2cd3 100644 --- a/docs/content/examples/_index.md +++ b/docs/content/examples/_index.md @@ -4,3 +4,4 @@ description: Learn how to work with various tools and techniques with these exam --- These are example bundles that demonstrate various techniques or how to use a specific tool with Porter. +Additional examples can be found in our repository in the [examples directory](https://porter.sh/src/examples). diff --git a/docs/content/mixins/_index.md b/docs/content/mixins/_index.md index 420f91935a..45200518f4 100644 --- a/docs/content/mixins/_index.md +++ b/docs/content/mixins/_index.md @@ -1,7 +1,31 @@ --- title: Mixins -description: Available Mixins +description: Quickly integrate with existing tools using Porter mixins +aliases: +- /using-mixins/ +- /use-mixins/ --- -Mixins make Porter special. They are the building blocks that you use when -authoring bundles. Find them, use them, [create your own](/mixin-dev-guide). +Mixins make Porter special. They are the building blocks that you use when authoring bundles. Find them, use them, [create your own](/mixin-dev-guide/). + +Mixins are adapters between the Porter and an existing tool or system. They know how to talk to Porter to include everything +they need to run, such as a CLI or config files, and how to execute their steps in the Porter manifest. + +There are [many mixins](/mixins/) created both by the Porter Authors and the community. +Only the [exec mixin](/mixins/exec/) is installed by default. + + +# Next + +* [Use a mixin in a bundle](/author-bundles/#mixins) +* [Mixin Architecture](/mixin-dev-guide/architecture/) + +# Available Mixins + +Below are mixins that are either maintained by the Porter authors, or are community mixins that are known to be well-maintained. +Use the [porter mixins search](/cli/porter_mixins_search) command to see all known mixins. + +See the [Search Guide][search-guide] on how to search for available plugins and/or +add your own to the list. + +[search-guide]: /package-search/ diff --git a/docs/content/plugins/_index.md b/docs/content/plugins/_index.md index 72bbd3b984..24ca8ef1ac 100644 --- a/docs/content/plugins/_index.md +++ b/docs/content/plugins/_index.md @@ -18,6 +18,11 @@ integrate with a MongoDB as a Server offering from your cloud provider. authoring bundles. There are a couple [types of plugins][types] and a single plugin binary may contain multiple implementations. +# Available Plugins + +Below are plugins that are either maintained by the Porter authors, or are community mixins that are known to be well-maintained. +Use the [porter plugins search](/cli/porter_plugins_search) command to see all known plugins. + See the [Search Guide][search-guide] on how to search for available plugins and/or add your own to the list. diff --git a/docs/content/quickstart/_index.md b/docs/content/quickstart/_index.md index df8d06b3ce..a2d4952c5d 100644 --- a/docs/content/quickstart/_index.md +++ b/docs/content/quickstart/_index.md @@ -1,6 +1,6 @@ --- -title: QuickStart Guide -descriptions: Get started using Porter +title: "QuickStart: Bundles" +descriptions: Learn about bundles and how to install them with Porter layout: single --- diff --git a/docs/content/quickstart/credentials.md b/docs/content/quickstart/credentials.md index 10bf5d2a00..4c25e14707 100644 --- a/docs/content/quickstart/credentials.md +++ b/docs/content/quickstart/credentials.md @@ -173,5 +173,5 @@ porter uninstall credentials-tutorial In this QuickStart, you learned how to see the credentials defined on a bundle, generate a credential set telling Porter where to find the credentials values, and pass credentials when executing a bundle. +* [QuickStart: Manage an installation using desired state](/quickstart/desired-state/) * [Understanding how credentials are resolved](/credentials/) -* [Manage an installation using desired state](/quickstart/desired-state/) \ No newline at end of file diff --git a/docs/content/use-mixins.md b/docs/content/use-mixins.md deleted file mode 100644 index a6665b0401..0000000000 --- a/docs/content/use-mixins.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Use Mixins -description: Quickly integrate with existing tools using Porter mixins -aliases: -- /using-mixins/ ---- - -This is a placeholder doc page. See our [contributing guide][contrib] -if you would like to add content for this page. - -# TODO - -* How to install and find mixins -* Mixin Schema and autocomplete - -# Next - -* [Mixin Architecture](/mixin-dev-guide/architecture/) - -[contrib]: /contribute/guide/#documentation