Skip to content

Commit

Permalink
IA: Renaming Developer Guide to Contribute to Zarf (#1634)
Browse files Browse the repository at this point in the history
## Description
Based on user feedback and to improve the information architecture, we
are changing the Developer Guide to Contribute to Zarf. All links
associated with the Developer Guide have been modified accordingly.

## Related Issue

Fixes #1629 
Relates to #1397 

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [X] Other (security config, docs update, etc)

## Checklist before merging

- [X] Test, docs, adr added or updated as needed
- [X] [Contributor Guide
Steps](https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md#developer-workflow)
followed

Co-authored-by: Wayne Starr <[email protected]>
  • Loading branch information
Jessy-Morris and Racer159 committed Apr 21, 2023
1 parent 2fb5f1c commit 79971f4
Show file tree
Hide file tree
Showing 11 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Our E2E tests can be found in the `/test` folder and follow the journey of someo
Our Unit tests can be found as `*_test.go` files inside the package that they are designed to test. These are also run in CI and are designed to test small functions with clear interfaces that would be difficult to test otherwise. As a general rule, we are limiting unit tests to the `src/pkg/*` folder.

All of our tests should be able to be run locally or in CI.
You can learn more about the testing of Zarf [here](docs/6-developer-guide/2-testing.md).
You can learn more about the testing of Zarf [here](docs/6-contribute-to-zarf/2-testing.md).

## Documentation

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Using Zarf in Github workflows? Check out the [setup-zarf](https://github.com/de

## Developing

To contribute, please see our [Contributor Guide](https://docs.zarf.dev/docs/developer-guide/contributor-guide). Below is an architectural diagram showing the basics of how Zarf functions which you can read more about [here](https://docs.zarf.dev/docs/developer-guide/nerd-notes).
To contribute, please see our [Contributor Guide](https://docs.zarf.dev/docs/contribute-to-zarf/contributor-guide). Below is an architectural diagram showing the basics of how Zarf functions which you can read more about [here](https://docs.zarf.dev/docs/contribute-to-zarf/nerd-notes).

![Architecture Diagram](./docs/.images/architecture.drawio.svg)

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 @@ -43,7 +43,7 @@ A typical Zarf deployment is made up of three parts:

:::note

For more technical information on how Zarf works and to view the Zarf architecture, visit our [Nerd Notes page](./6-developer-guide/3-nerd-notes.md).
For more technical information on how Zarf works and to view the Zarf architecture, visit our [Nerd Notes page](./6-contribute-to-zarf/3-nerd-notes.md).

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/13-walkthroughs/0-using-zarf-package-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ zarf package create . # Run the command to create the zarf package
This set of commands will create a zarf package in the current directory. In this case, the package name should look something like `zarf-init-amd64-v0.24.0.tar.zst`, although it might be slightly different depending on your system architecture.

:::note
If you continue without entering an agent image, package create will fail. The Zarf Agent is required to rewrite Kubernetes objects in the air gap via what is known as a Mutating Webhook. More technical information about it can be found [here](../6-developer-guide/3-nerd-notes.md).
If you continue without entering an agent image, package create will fail. The Zarf Agent is required to rewrite Kubernetes objects in the air gap via what is known as a Mutating Webhook. More technical information about it can be found [here](../6-contribute-to-zarf/3-nerd-notes.md).
:::

When you execute the `zarf package create` command, Zarf will prompt you to confirm that you want to create the package by displaying the package definition and asking you to respond with either `y` or `n`.
Expand Down
2 changes: 1 addition & 1 deletion docs/4-user-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,5 +84,5 @@ Once your package has arrived, you will need to:
If you are looking for more advanced information on how to operate and customize Zarf to your specific environment needs, check out these additional resources:

- For information on how to create a custom configuration of the Zarf CLI see the [Operator Manual](../5-operator-manual/_category_.json).
- For information on how to create your own Zarf Packages see the [Developer Guide](../6-developer-guide/1-contributor-guide.md).
- For information on how to create your own Zarf Packages see the [Zarf Packages](https://docs.zarf.dev/docs/user-guide/zarf-packages/) page.
- To see some of the ways our community is using Zarf to deploy code onto air-gapped systems see the [Zarf Examples](../../examples/README.md).
File renamed without changes.
File renamed without changes.
File renamed without changes.
4 changes: 4 additions & 0 deletions docs/6-contribute-to-zarf/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Contribute to Zarf"
}

4 changes: 0 additions & 4 deletions docs/6-developer-guide/_category_.json

This file was deleted.

0 comments on commit 79971f4

Please sign in to comment.