diff --git a/docs/bundles/plain.md b/docs/bundles/plain.md index 45fd9caa..cdc8a047 100644 --- a/docs/bundles/plain.md +++ b/docs/bundles/plain.md @@ -9,7 +9,7 @@ content embedded in the bundle. The bundle can be used as the underlying `spec.s a [`Bundle`](https://github.com/operator-framework/rukpak#bundle) resource. A plain bundle is a static collection of arbitrary Kubernetes YAML manifests. A plain bundle is contained in a directory -that can be packaged in a container image layer , a `git` repository or any other content source that the +that can be packaged in a container image layer , a `git` repository or any other content source that the [plain bundle provisioner](../provisioners/plain.md) supports. Supported source types for a plain bundle currently include the following: @@ -23,8 +23,8 @@ Supported source types for a plain bundle currently include the following: Additional source types (such as a local volume or a generic URI-based resource) are on the roadmap. These source types all present the same content: a directory containing static Kubernetes YAML manifests The currently implemented plain bundle format is the `plain+v0` format. The name of the bundle format, `plain+v0` -combines the type of bundle (plain) with the current schema version (v0). The -[plain bundle provisioner](../provisioners/plain.md) is able to source +combines the type of bundle (plain) with the current schema version (v0). The +[plain bundle provisioner](../provisioners/plain.md) is able to source `plain+v0` bundles and install them onto a Kubernetes cluster. > Note: the `plain+v0` bundle format is at schema version v0, which means it's an experimental format that is subject @@ -81,7 +81,7 @@ more information on bundles backed by `git` repositories, see the [`git` based b ### Prerequisites In order to create a plain bundle for Rukpak, ensure your Kubernetes manifests are in a flat directory at the root of -your project called `manifests/`. This allows the contents to be sourced and unpacked by the +your project called `manifests/`. This allows the contents to be sourced and unpacked by the [plain provisioner](..provisioners/plain.md). It should look similar to: ```bash @@ -107,7 +107,7 @@ templates ``` ```bash -$ kustomize build templates > manifests/manifests.yaml +kustomize build templates > manifests/manifests.yaml ``` ### Git source