istio.io icon indicating copy to clipboard operation
istio.io copied to clipboard

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

Open geeknoid opened this issue 6 years ago • 6 comments

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:

  • [x] Mesh Configuration Protocol (MCP)
  • [x] Secret Discovery Protocol (SDS)
  • [ ] Ingress Gateway
  • [ ] Egress Gateway
  • [x] Sidecar
  • [x] SPIFEE
  • [ ] Container Network Interface (CNI)
  • [x] Virtual Service
  • [ ] Destination Rule
  • [ ] Custom Resource Definition
  • [ ] Circuit breaker
  • [ ] Load shedding
  • [ ] Strong Identity

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

geeknoid avatar Mar 08 '19 14:03 geeknoid

See #3434

geeknoid avatar Mar 08 '19 14:03 geeknoid

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

rcaballeromx avatar Mar 14 '19 17:03 rcaballeromx

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.

rcaballeromx avatar May 24 '19 05:05 rcaballeromx

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.

geeknoid avatar May 24 '19 14:05 geeknoid

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

rcaballeromx avatar May 24 '19 17:05 rcaballeromx

🚧 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.

istio-policy-bot avatar Oct 30 '19 03:10 istio-policy-bot