Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.76 KB

HowToTemplate.md

File metadata and controls

37 lines (24 loc) · 1.76 KB

Chef-Examples HowTo Template

This template is pretty straight forward, when creating a new example, be sure to do the following:

  1. Fork the repo.
  2. Copy this template file into the /examples directory and give it a unique, succinct name. Please follow the CaMeLcAsE 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.
  3. 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!!!!! ----------------------

HowTo - [Do Something with Chef Product XYZ]

[Enter a brief description of what you're example HowTo guide does, and what the end-result of following this guide will be.]

Before You Start

Assumptions

  • [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).]

Tested Versions

  • [Chef Product] | [version]
  • [Another Chef Product] | [version]
  • [Other Relevant Software] | [version] | link

[Do Something e.g. Setup Automate 2 with Slack Notifications]

  1. [Step by step, numbered list of what to do.]
  2. [Add screenshots when necessary, they really help!]
  3. [Wrap it up with the expected outcome, what the user should see when finished.]

FAQs

  1. [This section should be updated regularly as people ask about certain behaviors and you answer questions related to this example.]