Skip to content

adding full-link to the glossary YAML style guide #7015

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 22, 2018
Merged

adding full-link to the glossary YAML style guide #7015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
adding full-link to the glossary YAML style guide
  • Loading branch information
@heckj
heckj committed Jan 19, 2018
commit 5af1701926f29bd5a0b819dd9be3a067b07d4d4e
2 changes: 1 addition & 1 deletion _data/glossary/_example.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
id: _example
name: Example K8s Term
full-link: kubernetes.io/docs/link-to-long-dedicated-docs-page
full-link: /docs/link-to-long-dedicated-docs-page
aka:
- Slang K8s Term
- Misnomer
Expand Down
2 changes: 2 additions & 0 deletions _includes/templates/glossary/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ To write a glossary snippet, start with a copy of the template, [`/_data/glossar
* 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.
* (Required) `name`
* The name of the term.
* (Optional) `full-link`
* The link to any specific long-form documentation, starting with `https://` if not within the website repo, and `/docs/...` if within the repo.
* (Required) `tags`
* 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).
* (Required) `short description`
Expand Down