Procedure template#

A procedure document is one that describes a series of steps or configuration to achieve a desired outcome.

The introduction should answer the following questions:

  • What does this procedure accomplish?

  • How does Cosmos behave after you complete it?

  • Why should someone choose to use this feature or complete this procedure? When should someone not use it?

  • In one sentence or list - what configurations must change. (Detailed instructions are later).

Prerequisites#

List the required resources, versions, tools, or functionality that someone needs to set up before beginning.

1. First step to complete#

  1. Add numerated substeps to the section when it makes sense.

  2. Like if there’s multiple types of commands or code examples someone must use.

    You can nest a code block by indenting it.
    
  3. If there’s bullet points you want to add to a substeps, Sphinx is whitespace sensitive and there are sometimes auto-formatting that can result.

  • This bullet point will auto-format as bold.
    • And the child bullet point is regular weight.

2. Second step#

If there’s only one step, skip numbering.