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

595 dead link on getting started site #596

Merged
merged 4 commits into from
Jul 7, 2022
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
4 changes: 2 additions & 2 deletions docs/12-support.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Support

1. Make sure you've read the [Zarf Overview](./zarf-overview), [Understanding the Basics](./understand-the-basics), and the [Getting Started](./getting-started) guides.
2. Look for an answer in [the frequently asked questions](./faq).
1. Make sure you've read the [Zarf Overview](./0-zarf-overview.md), [Understanding the Basics](./1-understand-the-basics.md), and the [Getting Started](./3-getting-started.md) guides.
2. Look for an answer in [the frequently asked questions](./9-faq.md).
3. Ask a question in [the Zarf Slack Channel](https://kubernetes.slack.com/archives/C03B6BJAUJ3)
4. [Read issues, report a bug, or rquest a new feature](https://github.com/defenseunicorns/zarf/issues)
6 changes: 3 additions & 3 deletions docs/3-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,8 @@ Depending on how familiar you are with Kubernetes, DevOps, and Zarf, let's find

- If you want to dive straight into Zarf, you can find examples and guides in the [Walkthroughs](./walkthroughs) page.

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

- More information about the packages that Zarf create and deploy is available in the [Understanding Zarf Packages](./user-guide/zarf-packages/zarf-packages) page.
- More information about the packages that Zarf create and deploy is available in the [Understanding Zarf Packages](./4-user-guide/2-zarf-packages/1-zarf-packages.md) page.

- If you want to take a step back and better understand the problem Zarf is trying to solve, you can find more context in the [Understand the Basics](./understand-the-basics) and [Core Concepts](./core-concepts) page.
- If you want to take a step back and better understand the problem Zarf is trying to solve, you can find more context in the [Understand the Basics](./1-understand-the-basics.md) and [Core Concepts](./2-core-concepts.md) page.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Building Your Own Zarf CLI

:::note
As mentioned in the [Getting Started page](../../getting-started), a pre-compiled binary is available for arm64 and amd64 machines under the 'Assets' tab of our latest releases on [GitHub](https://github.com/defenseunicorns/zarf/releases). If you don't want to build the CLI yourself you could always download it from there.
As mentioned in the [Getting Started page](../../3-getting-started.md), a pre-compiled binary is available for arm64 and amd64 machines under the 'Assets' tab of our latest releases on [GitHub](https://github.com/defenseunicorns/zarf/releases). If you don't want to build the CLI yourself you could always download it from there.
:::

## Dependencies
Expand Down
16 changes: 8 additions & 8 deletions docs/4-user-guide/1-the-zarf-cli/100-cli-commands/0-zarf.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ zarf [COMMAND]|[ZARF-PACKAGE]|[ZARF-YAML] [flags]

### SEE ALSO

* [zarf completion](./completion) - Generate the autocompletion script for the specified shell
* [zarf connect](./zarf_connect) - Access services or pods deployed in the cluster.
* [zarf destroy](./zarf_destroy) - Tear it all down, we'll miss you Zarf...
* [zarf init](./zarf_init) - Deploys the gitops service or appliance cluster on a clean linux box
* [zarf package](./package) - Pack and unpack updates for the Zarf gitops service.
* [zarf prepare](./prepare) - Tools to help prepare assets for packaging
* [zarf tools](./tools) - Collection of additional tools to make airgap easier
* [zarf version](./zarf_version) - Displays the version the zarf binary was built from
* [zarf completion](./4-completion/index.md) - Generate the autocompletion script for the specified shell
* [zarf connect](./zarf_connect.md) - Access services or pods deployed in the cluster.
* [zarf destroy](./zarf_destroy.md) - Tear it all down, we'll miss you Zarf...
* [zarf init](./zarf_init.md) - Deploys the gitops service or appliance cluster on a clean linux box
* [zarf package](./2-package/index.md) - Pack and unpack updates for the Zarf gitops service.
* [zarf prepare](./5-prepare/index.md) - Tools to help prepare assets for packaging
* [zarf tools](./3-tools/index.md) - Collection of additional tools to make airgap easier
* [zarf version](./zarf_version.md) - Displays the version the zarf binary was built from

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Pack and unpack updates for the Zarf gitops service.

### SEE ALSO

* [zarf](../zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf package create](./zarf_package_create) - Create an update package to push to the gitops server (runs online)
* [zarf package deploy](./zarf_package_deploy) - Deploys an update package from a local file or URL (runs offline)
* [zarf package inspect](./zarf_package_inspect) - lists the payload of an update package file (runs offline)
* [zarf](../0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf package create](./zarf_package_create.md) - Create an update package to push to the gitops server (runs online)
* [zarf package deploy](./zarf_package_deploy.md) - Deploys an update package from a local file or URL (runs offline)
* [zarf package inspect](./zarf_package_inspect.md) - lists the payload of an update package file (runs offline)

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ zarf package create [flags]

### SEE ALSO

* [zarf package](./) - Pack and unpack updates for the Zarf gitops service.
* [zarf package](./index.md) - Pack and unpack updates for the Zarf gitops service.

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ zarf package deploy [PACKAGE] [flags]

### SEE ALSO

* [zarf package](./) - Pack and unpack updates for the Zarf gitops service.
* [zarf package](./index.md) - Pack and unpack updates for the Zarf gitops service.

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ zarf package inspect [PACKAGE] [flags]

### SEE ALSO

* [zarf package](./) - Pack and unpack updates for the Zarf gitops service.
* [zarf package](./index.md) - Pack and unpack updates for the Zarf gitops service.

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Compress/Decompress tools

### SEE ALSO

* [zarf tools](../) - Collection of additional tools to make airgap easier
* [zarf tools](../index.md) - Collection of additional tools to make airgap easier
* [zarf tools archiver compress](zarf_tools_archiver_compress.md) - Compress a collection of sources based off of the destination file extension
* [zarf tools archiver decompress](zarf_tools_archiver_decompress.md) - Decompress an archive to a specified location.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ Collection of additional tools to make airgap easier

### SEE ALSO

* [zarf](../zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf tools archiver](./archiver) - Compress/Decompress tools
* [zarf tools config-schema](./zarf_tools_config-schema) - Generates a JSON schema for the zarf.yaml configuration
* [zarf tools get-admin-password](./zarf_tools_get-admin-password) - Returns the Zarf admin password for gitea read from the zarf-state secret in the zarf namespace
* [zarf tools monitor](./zarf_tools_monitor) - Launch K9s tool for managing K8s clusters
* [zarf tools registry](./registry) - Collection of registry commands provided by Crane
* [zarf](../0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf tools archiver](./archiver/index.md) - Compress/Decompress tools
* [zarf tools config-schema](./zarf_tools_config-schema.md) - Generates a JSON schema for the zarf.yaml configuration
* [zarf tools get-admin-password](./zarf_tools_get-admin-password.md) - Returns the Zarf admin password for gitea read from the zarf-state secret in the zarf namespace
* [zarf tools monitor](./zarf_tools_monitor.md) - Launch K9s tool for managing K8s clusters
* [zarf tools registry](./registry/index.md) - Collection of registry commands provided by Crane

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Collection of registry commands provided by Crane

### SEE ALSO

* [zarf tools](../) - Collection of additional tools to make airgap easier
* [zarf tools](../index.md) - Collection of additional tools to make airgap easier
* [zarf tools registry catalog](zarf_tools_registry_catalog.md) - List the repos in a registry
* [zarf tools registry copy](zarf_tools_registry_copy.md) - Efficiently copy a remote image from src to dst while retaining the digest value
* [zarf tools registry login](zarf_tools_registry_login.md) - Log in to a registry
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ zarf tools config-schema [flags]

### SEE ALSO

* [zarf tools](./) - Collection of additional tools to make airgap easier
* [zarf tools](./index.md) - Collection of additional tools to make airgap easier

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ zarf tools get-admin-password [flags]

### SEE ALSO

* [zarf tools](./) - Collection of additional tools to make airgap easier
* [zarf tools](./index.md) - Collection of additional tools to make airgap easier

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ zarf tools monitor [flags]

### SEE ALSO

* [zarf tools](./) - Collection of additional tools to make airgap easier
* [zarf tools](./index.md) - Collection of additional tools to make airgap easier

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ See each sub-command's help for details on how to use the generated script.

### SEE ALSO

* [zarf](../zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf completion bash](./zarf_completion_bash) - Generate the autocompletion script for bash
* [zarf completion fish](./zarf_completion_fish) - Generate the autocompletion script for fish
* [zarf completion powershell](./zarf_completion_powershell) - Generate the autocompletion script for powershell
* [zarf completion zsh](./zarf_completion_zsh) - Generate the autocompletion script for zsh
* [zarf](../0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf completion bash](./zarf_completion_bash.md) - Generate the autocompletion script for bash
* [zarf completion fish](./zarf_completion_fish.md) - Generate the autocompletion script for fish
* [zarf completion powershell](./zarf_completion_powershell.md) - Generate the autocompletion script for powershell
* [zarf completion zsh](./zarf_completion_zsh.md) - Generate the autocompletion script for zsh

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,6 @@ zarf completion bash

### SEE ALSO

* [zarf completion](./) - Generate the autocompletion script for the specified shell
* [zarf completion](./index.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ zarf completion fish [flags]

### SEE ALSO

* [zarf completion](./) - Generate the autocompletion script for the specified shell
* [zarf completion](./index.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ zarf completion powershell [flags]

### SEE ALSO

* [zarf completion](./) - Generate the autocompletion script for the specified shell
* [zarf completion](./index.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ zarf completion zsh [flags]

### SEE ALSO

* [zarf completion](./) - Generate the autocompletion script for the specified shell
* [zarf completion](./index.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Tools to help prepare assets for packaging

### SEE ALSO

* [zarf](../zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf prepare find-images](./zarf_prepare_find-images) - evaluates components in a zarf file to identify images specified in their helm charts and manifests
* [zarf prepare patch-git](./zarf_prepare_patch-git) - Converts all .git URLs to the specified Zarf HOST and with the Zarf URL pattern in a given FILE
* [zarf prepare sha256sum](./zarf_prepare_sha256sum) - Generate a SHA256SUM for the given file
* [zarf](../0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf prepare find-images](./zarf_prepare_find-images.md) - evaluates components in a zarf file to identify images specified in their helm charts and manifests
* [zarf prepare patch-git](./zarf_prepare_patch-git.md) - Converts all .git URLs to the specified Zarf HOST and with the Zarf URL pattern in a given FILE
* [zarf prepare sha256sum](./zarf_prepare_sha256sum.md) - Generate a SHA256SUM for the given file

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@ zarf prepare find-images [flags]

### SEE ALSO

* [zarf prepare](./) - Tools to help prepare assets for packaging
* [zarf prepare](./index.md) - Tools to help prepare assets for packaging

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ zarf prepare patch-git [HOST] [FILE] [flags]

### SEE ALSO

* [zarf prepare](./) - Tools to help prepare assets for packaging
* [zarf prepare](./index.md) - Tools to help prepare assets for packaging

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ zarf prepare sha256sum [FILE|URL] [flags]

### SEE ALSO

* [zarf prepare](./) - Tools to help prepare assets for packaging
* [zarf prepare](./index.md) - Tools to help prepare assets for packaging

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ zarf connect <REGISTRY|LOGGING|GIT> [flags]

### SEE ALSO

* [zarf](./zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf](./0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ zarf destroy [flags]

### SEE ALSO

* [zarf](./zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf](./0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ zarf init [flags]

### SEE ALSO

* [zarf](./zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf](./0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments

###### Auto generated by spf13/cobra on 20-May-2022
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@ zarf version [flags]

### SEE ALSO

* [zarf](./zarf) - Small tool to bundle dependencies with K3s for air-gapped deployments
* [zarf](./0-zarf.md) - Small tool to bundle dependencies with K3s for air-gapped deployments

###### Auto generated by spf13/cobra on 20-May-2022
Loading