Skip to content

Commit 01516c2

Browse files
authored
Merge pull request kubernetes#7015 from heckj/glossary_style_update
adding full-link to the glossary YAML style guide
2 parents 0268fa9 + 5af1701 commit 01516c2

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

_data/glossary/_example.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
id: _example
22
name: Example K8s Term
3-
full-link: kubernetes.io/docs/link-to-long-dedicated-docs-page
3+
full-link: /docs/link-to-long-dedicated-docs-page
44
aka:
55
- Slang K8s Term
66
- Misnomer

_includes/templates/glossary/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ To write a glossary snippet, start with a copy of the template, [`/_data/glossar
66
* This field must match the name of the glossary file itself (without the `*.yml` extension). It is *not* intended to be displayed to users, and is only used programmatically.
77
* (Required) `name`
88
* The name of the term.
9+
* (Optional) `full-link`
10+
* The link to any specific long-form documentation, starting with `https://` if not within the website repo, and `/docs/...` if within the repo.
911
* (Required) `tags`
1012
* Must be one of the tags listed in the [tags directory in the website repository](https://github.com/kubernetes/website/tree/master/_data/canonical-tags).
1113
* (Required) `short description`

0 commit comments

Comments
 (0)