diff options
| author | Bob Killen <bob.killen@linux.com> | 2020-01-26 08:59:44 -0500 |
|---|---|---|
| committer | Bob Killen <bob.killen@linux.com> | 2020-01-26 08:59:44 -0500 |
| commit | fae3ee5ab3296d71a327b1caa879de9d72101c57 (patch) | |
| tree | ee4b530cf21be1a2196c71616fe2b6650eb79878 | |
| parent | aaa3203aabdf1509bb086729ca86abdda651d926 (diff) | |
Update style guide with a note on using the slug attribute.
| -rw-r--r-- | contributors/guide/style-guide.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/contributors/guide/style-guide.md b/contributors/guide/style-guide.md index 23a803b3..a4f79632 100644 --- a/contributors/guide/style-guide.md +++ b/contributors/guide/style-guide.md @@ -200,6 +200,7 @@ These are **guidelines**, not rules. Use your best judgement. - If the document is intended to be surfaced on the Contributor Site; include a yaml metadata header at the beginning of the document. - Metadata must include the `title` attribute. +- If including the `slug` attribute. It **must** match the filename. **[Tables:](#tables)** @@ -673,6 +674,8 @@ relative links. However, how and what they're being linked to can vary widely. - Metadata must include the `title` attribute. - `title` will be used as the title of the document when rendered with [Hugo]. +- If including the `slug` attribute. It **must** match the filename for + intra-site links to be resolved correctly. ### Tables |