meta data for this page
  •  

Documentation Standards

We'd like to maintain a consistent look and feel for this documentation at docs.itflow.org. If you choose to contribute to our documentation, please try to follow these guidelines:

  • Page titles and main headings should start with a level 1 headline, e.g. ====== Title ======
  • Subheadings should utilize level 2 and level 3 headlines, e.g. ===== Subheading under a topic =====
  • Use bold text to indicate actions, e.g. Select **yes** to continue
  • Use italics to add emphasis
  • Code, PHP variables and commands should be placed into codeblocks, e.g. ''$dbhost''
  • Be simple, direct and to the point - write for a human
  • Avoid using emojis
  • When you need an example domain, use itflow.yourdomain.com
  • Include useful edit summaries