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

Docs edits to "Setup and Install" page #1592

Closed
Jessy-Morris opened this issue Apr 12, 2023 · 0 comments · Fixed by #1597
Closed

Docs edits to "Setup and Install" page #1592

Jessy-Morris opened this issue Apr 12, 2023 · 0 comments · Fixed by #1597
Assignees
Labels
documentation 📘 Improvements or additions to documentation

Comments

@Jessy-Morris
Copy link
Contributor

Is your feature request related to a problem? Please describe.

Documentation does not reflect the editorial guidelines outlined in the Project Style Guide. Editing the "Setup and Install" page to align with the updated Style Guide to improve readability for users.

  • Editing heading capitalization
  • Fixing note: additional information got wrapped into the note, I'll be separating the information to improve formatting
  • Editing language to align with style guide
  • Capitalizing K8s
  • Removing '!'
@Jessy-Morris Jessy-Morris added the documentation 📘 Improvements or additions to documentation label Apr 12, 2023
@Jessy-Morris Jessy-Morris self-assigned this Apr 12, 2023
@github-project-automation github-project-automation bot moved this to New Requests in Zarf Project Board Apr 12, 2023
Racer159 added a commit that referenced this issue Apr 24, 2023
## Description
Documentation does not reflect the editorial guidelines outlined in the
Project Style Guide. Editing the "Set Up and Install" page to align with
the updated Style Guide to improve readability for users.

- Editing heading capitalization
- Fixing note: additional information got wrapped into the note, I'll be
separating the information to improve formatting
- Editing language to align with style guide
- Capitalizing K8s
- Removing '!'

## Related Issue

Fixes #1592 

## 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📘 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant