From 5af1701926f29bd5a0b819dd9be3a067b07d4d4e Mon Sep 17 00:00:00 2001 From: Joe Heck Date: Thu, 18 Jan 2018 16:06:07 -0800 Subject: [PATCH] adding full-link to the glossary YAML style guide --- _data/glossary/_example.yml | 2 +- _includes/templates/glossary/README.md | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/_data/glossary/_example.yml b/_data/glossary/_example.yml index 78ef717df2..c7e6533611 100644 --- a/_data/glossary/_example.yml +++ b/_data/glossary/_example.yml @@ -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 diff --git a/_includes/templates/glossary/README.md b/_includes/templates/glossary/README.md index 18973e9926..7048df5c62 100644 --- a/_includes/templates/glossary/README.md +++ b/_includes/templates/glossary/README.md @@ -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`