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.

Sign up for GitHub

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

Jump to bottom

Docs edits to "User Guide" page #1510

Closed
Jessy-Morris opened this issue Mar 29, 2023 · 0 comments · Fixed by #1512
Closed

Docs edits to "User Guide" page #1510

Jessy-Morris opened this issue Mar 29, 2023 · 0 comments · Fixed by #1512
Assignees
@Jessy-Morris
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 "User Guide" page to align with the updated Style Guide to improve readability for users.

  • Remove excess '!'
  • Remove metaphorical language
  • Correct heading capitalization
  • Edit context for better readability
  • Add punctuation to lists
@Jessy-Morris Jessy-Morris added the documentation 📘 Improvements or additions to documentation label Mar 29, 2023
@Jessy-Morris Jessy-Morris self-assigned this Mar 29, 2023
@github-project-automation github-project-automation bot moved this to New Requests in Zarf Project Board Mar 29, 2023
@Jessy-Morris Jessy-Morris mentioned this issue Mar 29, 2023
Merged
5 tasks
Racer159 pushed a commit that referenced this issue Mar 29, 2023
@Jessy-Morris
Docs edits to User Guide page (#1512)
385eae7 
## Description
Documentation does not reflect the editorial guidelines outlined in the
Project Style Guide. Editing the "User Guide" page to align with the
updated Style Guide to improve readability for users.

- Remove excess '!'
- Remove metaphorical language
- Correct heading capitalization
- Edit context for better readability
- Add punctuation to lists
- Correct link text

## Related Issue

Fixes #1510 

## 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
@github-project-automation github-project-automation bot moved this from New Requests to Done in Zarf Project Board Mar 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Jessy-Morris Jessy-Morris

Labels
documentation 📘 Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs edits to User Guide page zarf-dev/zarf
1 participant
@Jessy-Morris