Skip to content

Creating rules

Tiago Araújo [SSW] edited this page Mar 17, 2021 · 9 revisions

Automated creation

TODO: Describe the process

Manual creation

  1. Open GitHub and go to the 'rules' folder
  2. Click Add a new file
  3. Name your file '{rule uri}/index.md' (e.g, 'do-you-encourage-experimentation/index.md')
  4. Edit the file
  5. Copy the content of the rule template
  6. Edit the frontmatter:
    • type: value must be set to 'rule'
    • archivedreason: must be deleted or be left empty, used only for an archived rule
    • title: the title of the rule as it will appear on the rule page
    • guid: unique identifier of the rule in CosmosDb
    • uri: uri of the rule
    • created: creation date of the rule
      • TODO: Add formatting for dates
    • authors: used in the acknowledgment section
    • related: list of related rules
---
type: rule
archivedreason: 
title: Accommodation - Do you know the best online accommodation websites?
guid: 8d59feea-03b4-4cfc-b26e-77b2655293d9
uri: accommodation---do-you-know-the-best-online-accommodation-websites
created: 2015-04-28T05:06:33.0000000Z
authors: []
related:
- do-you-create-an-online-itinerary
- do-you-check-if-your-qantas-flight-is-eligible-for-a-"bid-now"-upgrade
- do-you-know-how-to-get-the-most-out-of-your-credit-card
- do-you-check-your-boarding-pass
- do-you-take-advantage-of-business-rewards-programs

---

Figure: Example or Rule frontmatter

  1. Add the text of your rule in markdown. You can use the tag to write a summary of your rule. What is written before this tag will be diplayed on the category page when 'Show Blurb' is selected.
  2. Save your changes, see Saving rules

<!--endintro-->

Figure: Rule template content

Clone this wiki locally