Skip to content

Commit

Permalink
Update pages to match new navigation
Browse files Browse the repository at this point in the history
Some pages had TODOs, or the pages they linked to weren't correct after
reorganizing the nav bar. I've updated pages to improve the navigation.

Signed-off-by: Carolyn Van Slyck <[email protected]>
  • Loading branch information
carolynvs committed Nov 1, 2021
1 parent e1acd85 commit 7025008
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 33 deletions.
14 changes: 7 additions & 7 deletions docs/content/author-bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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:

Expand Down
1 change: 1 addition & 0 deletions docs/content/examples/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
30 changes: 27 additions & 3 deletions docs/content/mixins/_index.md
Original file line number Diff line number Diff line change
@@ -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/
5 changes: 5 additions & 0 deletions docs/content/plugins/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
4 changes: 2 additions & 2 deletions docs/content/quickstart/_index.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/quickstart/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
20 changes: 0 additions & 20 deletions docs/content/use-mixins.md

This file was deleted.

0 comments on commit 7025008

Please sign in to comment.