Contributor guides samples

Why I created these guides

When I started at Armory, the docs team didn’t have any contributor guides. Armory’s docs repo was public, so I wrote guides that were appropriate for the general public as well as Armory employees.

My reference points were the Kubernetes contributor guides that I worked on in 2019 while employed by the Cloud Native Computing Foundation and the Google developer documentation style guide.

Original public repo: https://github.com/armory/docs/tree/master/content/en/contribute

Original public site: https://docs.armory.io/contribute/

I used Snagit’s scrolling feature to capture the screenshots. The main body content is correct, but you do see duplicate left and right menus due to the scrolling capture.

I created this content based on my previous project experience.

Style guide

When creating content for Armory, we followed these style guides:

1. Armory Style Guide
2. Google developer documentation style guide
3. The Chicago Manual of Style

Content guide

I divided content into these areas:

1. Concept or explanation
2. How-to or task
3. Tutorial
4. Reference
5. Troubleshooting

Reviewer guidelines

Approver guidelines

How to contribute content