Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixup docs sidebar order #1705

Merged
merged 1 commit into from
May 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion adr/0014-oci-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ zarf-package-adr-arm64.tar.zst

With this new structure in place, we can now publish Zarf packages as OCI artifacts. Under the hood this implements the `oras` Go library using Docker's authentication system. For interacting with these packages, the `oci://` package path prefix has been added (ex. `zarf package publish oci://...`).

For an example of this in action, please see the corresponding [tutorial](../docs/6-zarf-tutorials/7-publish-and-deploy.md).
For an example of this in action, please see the corresponding [tutorial](../docs/5-zarf-tutorials/7-publish-and-deploy.md).

## Consequences

Expand Down
2 changes: 1 addition & 1 deletion docs-website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ const config = {
const sidebarItems = await defaultSidebarItemsGenerator(args)
if (args.item.dirName === 'docs') {
// This hack places the examples tree at the 7th position in the sidebar
sidebarItems.splice(7, 0, {
sidebarItems.splice(6, 0, {
type: 'category',
label: 'Package Examples',
link: {
Expand Down
2 changes: 1 addition & 1 deletion docs/0-zarf-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Zarf can pull from various places like Docker Hub, Iron Bank, GitHub, and local

This part of the process requires access to the internet. The `zarf` binary is presented with a `zarf.yaml`, it then begins downloading, packing, and compressing the software that you requested. It then outputs a single, ready-to-move distributable called "a package".

For additional information, see the [Creating a package](./6-zarf-tutorials/0-creating-a-zarf-package.md) section.
For additional information, see the [Creating a package](./5-zarf-tutorials/0-creating-a-zarf-package.md) section.

### (2) Ship the Package to the System Location

Expand Down
4 changes: 2 additions & 2 deletions docs/1-getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ If you are online on the machine with cluster access you can also run `zarf init

:::note

You can build your own custom 'init' package too if you'd like. For this you should check out the [Creating a Custom 'init' Package Tutorial](../6-zarf-tutorials/8-custom-init-packages.md).
You can build your own custom 'init' package too if you'd like. For this you should check out the [Creating a Custom 'init' Package Tutorial](../5-zarf-tutorials/8-custom-init-packages.md).

:::

Expand All @@ -89,7 +89,7 @@ You can build your own custom 'init' package too if you'd like. For this you sho

Depending on how familiar you are with Kubernetes, DevOps, and Zarf, let's find what set of information would be most useful to you.

- If you want to become more familiar with Zarf and it's features, see the [Tutorials](../6-zarf-tutorials/index.md) page.
- If you want to become more familiar with Zarf and it's features, see the [Tutorials](../5-zarf-tutorials/index.md) page.

- More information about the Zarf CLI is available on the [Zarf CLI](../2-the-zarf-cli/index.md) page, or by browsing through the help descriptions of all the commands available through `zarf --help`.

Expand Down
6 changes: 3 additions & 3 deletions docs/2-the-zarf-cli/1-cli-common-uses.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Zarf is a tool that optimizes the delivery of applications and capabilities into

To create a Zarf Package, you must execute the [`zarf package create`](./100-cli-commands/zarf_package_create.md) command, which generates a tarball archive that includes all the required dependencies and instructions to deploy the capabilities onto another machine. The `zarf package create` command uses a [`zarf.yaml` configuration file](../3-create-a-zarf-package/4-zarf-schema.md) that describes the package's components and performs all necessary actions, such as downloading container images and git repositories, to build the final package.

Additional information on Zarf Packages can be found on the [Understanding Zarf Packages](../3-create-a-zarf-package/1-zarf-packages.md) page along with the [Creating a Zarf Package Tutorial](../6-zarf-tutorials/0-creating-a-zarf-package.md).
Additional information on Zarf Packages can be found on the [Understanding Zarf Packages](../3-create-a-zarf-package/1-zarf-packages.md) page along with the [Creating a Zarf Package Tutorial](../5-zarf-tutorials/0-creating-a-zarf-package.md).

## Initializing a Cluster: `zarf init`

Expand All @@ -19,7 +19,7 @@ For Windows and macOS environments, a cluster must already exist before initiali

For Linux environments, Zarf itself can create and update a local K3s cluster, in addition to using any other local or remote Kubernetes cluster. The init package used by `zarf init` contains all the resources necessary to create a local [K3s](https://k3s.io/) cluster on your machine. This package may be located in your current working directory, the directory where the Zarf CLI binary is located, or downloaded from GitHub releases during command execution.

Further details on the initialization process can be found on the [init package](../3-create-a-zarf-package/3-zarf-init-package.md) page along with the [Initializing a K8s Cluster Tutorial](../6-zarf-tutorials/1-initializing-a-k8s-cluster.md).
Further details on the initialization process can be found on the [init package](../3-create-a-zarf-package/3-zarf-init-package.md) page along with the [Initializing a K8s Cluster Tutorial](../5-zarf-tutorials/1-initializing-a-k8s-cluster.md).

:::note
Depending on the permissions of your user, if you are installing K3s with `zarf init`, you may need to run it as a privileged user. This can be done by either:
Expand All @@ -35,4 +35,4 @@ Depending on the permissions of your user, if you are installing K3s with `zarf

The [`zarf package deploy`](./100-cli-commands/zarf_package_deploy.md) command deploys the packaged capabilities into the target environment. The package can be deployed on any cluster, even those without an external internet connection, since it includes all of its external resources. The external resources are pushed into the cluster to services Zarf either deployed itself or that it was told about on `init`, such as the init package's Gitea Git server or a pre-existing Harbor image registry. Then, the application is deployed according to the instructions in the zarf.yaml file, such as deploying a helm chart, deploying raw K8s manifests, or executing a series of shell commands. Generally, it is presumed that the `zarf init` command has already been executed on the target machine. However, there are a few exceptional cases where this assumption does not apply, such as [YOLO Mode](../8-faq.md#what-is-yolo-mode-and-why-would-i-use-it).

Additional information about Zarf Packages can found on the [Understanding Zarf Packages](../3-create-a-zarf-package/1-zarf-packages.md) page along with the [Deploying a Local Zarf Package Tutorial](../6-zarf-tutorials//2-deploying-zarf-packages.md).
Additional information about Zarf Packages can found on the [Understanding Zarf Packages](../3-create-a-zarf-package/1-zarf-packages.md) page along with the [Deploying a Local Zarf Package Tutorial](../5-zarf-tutorials//2-deploying-zarf-packages.md).
2 changes: 1 addition & 1 deletion docs/3-create-a-zarf-package/1-zarf-packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The following list outlines the dependencies for creating a Zarf Package:

When executed, the `zarf package create` command locates the `zarf.yaml` file in the current directory and constructs the package from that file. The command utilizes internet or intranet resources to retrieve all the required assets and stores them in a temporary directory. After the required resources have been obtained, Zarf generates a tarball of the temporary directory and performs necessary cleanup actions. You can learn more about this flow on the [package create lifecycle](./5-package-create-lifecycle.md) page.

The process of defining and creating a package is also elaborated on in detail in the [Creating a Zarf Package Tutorial](../6-zarf-tutorials/0-creating-a-zarf-package.md).
The process of defining and creating a package is also elaborated on in detail in the [Creating a Zarf Package Tutorial](../5-zarf-tutorials/0-creating-a-zarf-package.md).

## Inspecting a Created Package

Expand Down
2 changes: 1 addition & 1 deletion docs/3-create-a-zarf-package/3-zarf-init-package.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The 'init' package is a special Zarf Package (denoted by `kind: ZarfInitConfig` in its `zarf.yaml`) that initializes a cluster with the requisite air gap services when running `zarf init`. This allows future Zarf Packages to store any required resources (i.e. container images and git repositories) so that they can be retrieved later.

The default 'init' package that Zarf ships is defined in the `zarf.yaml` that lives at the [root of the Zarf repository](https://github.com/defenseunicorns/zarf/blob/main/zarf.yaml), and is constructed from composed components that provide a foundation for customization. If you would like to change the behavior of the 'init' package you can do so by modifying this `zarf.yaml` or any of the composed components that it references and running `zarf package create` at the root of the repository. You can learn more about creating a custom init package in the [Creating a Custom 'init' Package Tutorial](../6-zarf-tutorials/8-custom-init-packages.md).
The default 'init' package that Zarf ships is defined in the `zarf.yaml` that lives at the [root of the Zarf repository](https://github.com/defenseunicorns/zarf/blob/main/zarf.yaml), and is constructed from composed components that provide a foundation for customization. If you would like to change the behavior of the 'init' package you can do so by modifying this `zarf.yaml` or any of the composed components that it references and running `zarf package create` at the root of the repository. You can learn more about creating a custom init package in the [Creating a Custom 'init' Package Tutorial](../5-zarf-tutorials/8-custom-init-packages.md).

Upon deployment, the init package creates a `zarf` namespace within your K8s cluster and deploys pods, services, and secrets to that namespace based on the components selected for deployment.

Expand Down
2 changes: 1 addition & 1 deletion docs/3-create-a-zarf-package/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To learn more about creating a Zarf package, you can check out the following res
- [Understanding Zarf Components](./2-zarf-components.md): A breakdown of the primary structure that makes up a Zarf Package.
- [Zarf Schema Documentation](./4-zarf-schema.md): Documentation that covers the configuration available in a Zarf Package definition.
- [The Package Create Lifecycle](./5-package-create-lifecycle.md): An overview of the lifecycle of `zarf package create`.
- [Creating a Zarf Package Tutorial](../6-zarf-tutorials/0-creating-a-zarf-package.md): A tutorial covering how to take an application and create a package for it.
- [Creating a Zarf Package Tutorial](../5-zarf-tutorials/0-creating-a-zarf-package.md): A tutorial covering how to take an application and create a package for it.

## Typical Creation Workflow:

Expand Down
6 changes: 3 additions & 3 deletions docs/4-deploy-a-zarf-package/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Once the Zarf package has arrived in your target environment, run the `zarf pack

:::tip

For a comprehensive tutorial of deploying a Zarf Package, see the [Deploying Zarf Packages tutorial](../6-zarf-tutorials/2-deploying-zarf-packages.md).
For a comprehensive tutorial of deploying a Zarf Package, see the [Deploying Zarf Packages tutorial](../5-zarf-tutorials/2-deploying-zarf-packages.md).

:::

Expand All @@ -24,7 +24,7 @@ Zarf normally expects to operate against a Kubernetes cluster that has been [Zar

- **YOLO Mode** - Yaml-OnLy Online mode allows for a faster deployment without requiring the `zarf init` command to be run beforehand. It can be useful for testing or for environments that manage their own registries and Git servers completely outside of Zarf. Given this mode does not use the [Zarf Agent](../8-faq.md#what-is-the-zarf-agent) any resources specified will need to be manually modified for the environment.

- **Cluster-less** - Zarf normally interacts with clusters and kubernetes resources, but it is possible to have Zarf perform actions before a cluster exists (including [deploying the cluster itself](../6-zarf-tutorials/5-creating-a-k8s-cluster-with-zarf.md)). These packages generally have more dependencies on the host or environment that they run within.
- **Cluster-less** - Zarf normally interacts with clusters and kubernetes resources, but it is possible to have Zarf perform actions before a cluster exists (including [deploying the cluster itself](../5-zarf-tutorials/5-creating-a-k8s-cluster-with-zarf.md)). These packages generally have more dependencies on the host or environment that they run within.

## Additional Resources

Expand All @@ -33,7 +33,7 @@ To learn more about deploying a Zarf package, you can check out the following re
- [Getting Started with Zarf](../1-getting-started/index.md): A step-by-step guide to installing Zarf and a description of the problems it seeks to solve.
- [Zarf CLI Documentation](../2-the-zarf-cli/index.md): A comprehensive guide to using the Zarf command-line interface.
- [The Package Deploy Lifecycle](./1-package-deploy-lifecycle.md): An overview of the lifecycle of `zarf package deploy`.
- [Deploying a Zarf Package Tutorial](../6-zarf-tutorials/3-deploy-a-retro-arcade.md): A tutorial covering how to deploy a package onto an initialized cluster.
- [Deploying a Zarf Package Tutorial](../5-zarf-tutorials/3-deploy-a-retro-arcade.md): A tutorial covering how to deploy a package onto an initialized cluster.
- [The Zarf Init Package](../3-create-a-zarf-package/3-zarf-init-package.md): Learn about the 'init' package that is used to store resources for zarf packages.

## Typical Deployment Workflow:
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion examples/big-bang/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ The `bigbang` noun sits within the `extensions` specification of Zarf and provid
- `skipFlux` - Whether to skip deploying flux; Defaults to false
- `valuesFiles` - The list of values files to pass to Big Bang; these will be merged together

To see a tutorial for the creation and deployment of this package see the [Big Bang Tutorial](../../docs/6-zarf-tutorials/6-big-bang.md).
To see a tutorial for the creation and deployment of this package see the [Big Bang Tutorial](../../docs/5-zarf-tutorials/6-big-bang.md).
2 changes: 1 addition & 1 deletion examples/dos-games/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DOS Games in the Cluster!

This example provides the basis for Zarf's [Retro Arcade](../../docs/6-zarf-tutorials/3-deploy-a-retro-arcade.md) tutorial. It deploys a Dos Games arcade into the cluster and provides an easy way to connect and play games.
This example provides the basis for Zarf's [Retro Arcade](../../docs/5-zarf-tutorials/3-deploy-a-retro-arcade.md) tutorial. It deploys a Dos Games arcade into the cluster and provides an easy way to connect and play games.

:::note

Expand Down
2 changes: 1 addition & 1 deletion examples/git-data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Full clones are used in this example with the `stefanprodan/podinfo` repository

## Example Usage

This example assumes you have already initialized a Zarf cluster. If that is not the case, refer to the [Initializing the Cluster Tutorial](../../docs/6-zarf-tutorials/1-initializing-a-k8s-cluster.md). Be sure when initializing the Zarf cluster to deploy the `git` component, or be ready to specify an external `git` repository.
This example assumes you have already initialized a Zarf cluster. If that is not the case, refer to the [Initializing the Cluster Tutorial](../../docs/5-zarf-tutorials/1-initializing-a-k8s-cluster.md). Be sure when initializing the Zarf cluster to deploy the `git` component, or be ready to specify an external `git` repository.

### Create the Zarf Package

Expand Down
2 changes: 1 addition & 1 deletion examples/postgres-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ This example uses Zalando's Postgres operator as after looking at several altern

4. Build the package using `zarf package create examples/postgres-operator`

5. Create a Zarf cluster as described in the [Initializing a Cluster Tutorial](../../docs/6-zarf-tutorials/1-initializing-a-k8s-cluster.md/)
5. Create a Zarf cluster as described in the [Initializing a Cluster Tutorial](../../docs/5-zarf-tutorials/1-initializing-a-k8s-cluster.md/)

## Instructions

Expand Down
2 changes: 1 addition & 1 deletion examples/tiny-kafka/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Before the magic can happen you have to do a few things:

1. Build the package using `zarf package create examples/tiny-kafka`

1. Create a Zarf cluster as described in the [Initializing a Cluster Tutorial](../../docs/6-zarf-tutorials/1-initializing-a-k8s-cluster.md/)
1. Create a Zarf cluster as described in the [Initializing a Cluster Tutorial](../../docs/5-zarf-tutorials/1-initializing-a-k8s-cluster.md/)

## Instructions

Expand Down
2 changes: 1 addition & 1 deletion examples/wordpress/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# WordPress

This example demonstrates how to use Zarf to deploy a WordPress blog into a cluster. It is used as a part of the [Creating a Zarf Package](../../docs/6-zarf-tutorials/0-creating-a-zarf-package.md) and [Deploying a Zarf Package](../../docs/6-zarf-tutorials/2-deploying-zarf-packages.md) tutorials.
This example demonstrates how to use Zarf to deploy a WordPress blog into a cluster. It is used as a part of the [Creating a Zarf Package](../../docs/5-zarf-tutorials/0-creating-a-zarf-package.md) and [Deploying a Zarf Package](../../docs/5-zarf-tutorials/2-deploying-zarf-packages.md) tutorials.

:::info

Expand Down