This template is pretty straight forward, when creating a new example, be sure to do the following:
- Fork the repo.
- Copy this template file into the
/examples
directory and give it a unique, succinct name. Please follow theCaMeLcAsE
format that this file uses, and make sure the filename always starts with the Chef product (eg.Chef|Habitat|InSpec|Automate
). A full example would be something like this:ChefRoleCookbookModel.md
. - Make sure to follow the template below, and provide any information that is marked as [required], be sure to delete any unnecessary text (including the opening and closing "[]" as well as everything from this line and above) prior to making your PR.
---------------------- DELETE ME & ALL ABOVE ME!!!!! ----------------------
[Enter a brief description of what you're example HowTo guide does, and what the end-result of following this guide will be.]
- [This guide assumes that you, as the reader, have the following already setup.]
- [List any prerequisites here.]
- [Use a bulleted list.]
- [Such as, this example uses Jenkins
version
with plugins (xyz).]
- [Chef Product] | [
version
] - [Another Chef Product] | [
version
] - [Other Relevant Software] | [
version
] | link
- [Step by step, numbered list of what to do.]
- [Add screenshots when necessary, they really help!]
- [Wrap it up with the expected outcome, what the user should see when finished.]
- [This section should be updated regularly as people ask about certain behaviors and you answer questions related to this example.]