Using the Recipe README

Every recipe has a README.md file at the root of its file structure. The README displays in the Wiki tab of the Recipes page.

Tip

Use the README to describe a recipe and its variations or to give user instructions for running orders.

Edit README content from the Wiki tab

1. Open a kitchen and select a recipe from the list.
2. Select the Wiki tab.
3. Click Edit.
4. Make changes to the file content using the toolbar and/or GitHub flavored Markdown.
5. Click Update to save your changes.

Edit README.md in the File Editor

1. Open a kitchen and select a recipe from the list.
2. Select Recipe Actions > View Files.
3. Select README.md from the file list on the left.
4. Modify the content using GitHub flavored Markdown and, optionally, Jinja variables.
5. Once done, select Add notes for changelog , and click Update.

Create a README

You can create one from the File Editor if a recipe does not have a README file display in the Wiki tab.

1. Open a kitchen and select a recipe from the list.
2. Select Recipe Actions > View Files.

3. Click Add Files.

   Note

   The README exists at the root of a recipe's file structure. Do not nest the file in another folder.

4. Select Create Empty.

5. Enter README.me as the File Name.
6. Click Add.
7. In the new file, enter using GitHub flavored Markdown and, optionally, Jinja variables.
8. When done, select Add notes for changelog , and click Update.

Your new README will appear in the Wiki tab of the recipe.

Visual example in Automation