istio / istio.io

Source for the istio.io site
https://istio.io/
Apache License 2.0
761 stars 1.54k forks source link

Expand glossary and use {{< gloss >}} to use as metadata for See Also and SEO #3573

Open geeknoid opened 5 years ago

geeknoid commented 5 years ago

We should expand the glossary, and make use of the site's {{< gloss >}} feature that allows pop ups for glossary terms. Some terms to include:

I'll add more as I think of 'em.

geeknoid commented 5 years ago

See #3434

rcaballeromx commented 5 years ago

See #3686 Also related. I've assigned this bug to myself to tackle these terminology taxonomy issues for 1.2.

rcaballeromx commented 5 years ago

I've created an epic out of the existing issue. @geeknoid @frankbu @sdake @mandarjog @oaktowner Please create an issue and add it to the epic for each term you want implemented in the Glossary and with the first instance in every page marked with {{< gloss >}} consistently across the English (en) version of the docs. Please let everyone know. I'll post something on discuss.istio.io tomorrow.

geeknoid commented 5 years ago

Why an epic for this? Creating issues for individual words seems a heavy process, when the checkbox list within this single issue seems sufficient to track what needs to be documented.

rcaballeromx commented 5 years ago

Issue created for Mesh Configuration Protocol to serve as an example for the community. https://github.com/istio/istio.io/issues/4218

istio-policy-bot commented 5 years ago

🚧 This issue or pull request will be closed in a week due to not having had activity in the last 105 days. If you feel this issue or pull request deserves attention, an Istio team member must comment on the issue or PR in order to keep it opened, or it must be labeled as being stale-proof. Thank you for your contributions.

Created by the issue and PR lifecycle manager.