Sample Specification

Where to place specifications

• Create a subfolder under the content folder with a short name for your specification. This folder will be used in the url, so make it lowercase, short and representative.
• Create an _index.md file with the full name of the specification
  content/sample/_index.md md Copy

  1 2 3

  --- title: "Sample Specification" ---

Front-matter tags in specifications

• title: Shown before any other content in an H1 tag
• version: A Semantic Versioning 2.0.0 compliant version number. Shown directly below the title in an H2 tag
• latest: true or false (default). Used to determine the specification shown when navigating to the specification main URL. At least one specification should be marked as latest, usually the latest release version of the specification

1
2
3
4
5
6
7

---
Title: "Sample Specification"
version: "1.0.0"
latest: true
---

Content of the specification goes here

Translations

• Check hugo.toml file to see if the language is present in the [languages] section, else add it.
• Note the language abbreviation. Lets say its xyz
• Check if i18n/xyz.yaml is available (subsitute the language abbreviation for xyz)
• Translate the content of i18n/xyz.yaml based on i18n/en.yaml
• Locate the specification file to translate, say content/sample/1.0.0/index.mdand copy it to content/sample/1.0.0/index.xyz.md (again substitute language abbreviation for xyz)