Add template for walkthroughs and examples to docs/.templates #1411
Milestone
Comments
|
Per our discussion this should probably better be in the developer guide section and should include our style guide as well (with links from our CONTRIBUTING.md) |
5 tasks
Racer159
added a commit
that referenced
this issue
Apr 12, 2023
## Description Adding the working Project Writing Style Guide to the documentation. This will allow future contributors to align their language to the style guide, improving readability and understanding of the documentation. ## Related Issue Relates to #1411 ## 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]>
github-project-automation
bot
moved this from New Requests
to Done
in Zarf Project Board
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe what should be investigated or refactored
We should add our internal templates for walkthroughs and examples to our
docs/.templatesfolder as.mdfiles and reference them in ourCONTRIBUTING.mdfile to encourage consistency when new walkthroughs or examples are added.Links to any relevant code
https://github.com/defenseunicorns/zarf/tree/main/docs/.templates
https://github.com/defenseunicorns/zarf/blob/main/CONTRIBUTING.md
Additional context
This is a continuation of our work to improve our walkthroughs and examples in docs: #1377
The text was updated successfully, but these errors were encountered: