From 312b4a8f4ad8995a55d8606b996f993d1ebf9e62 Mon Sep 17 00:00:00 2001 From: Emma Foley Date: Wed, 7 Jul 2021 12:14:48 +0100 Subject: Update glossary to make it link-able Using the sphinx glossary directive [1], the terms in the glossary can now be linked from the main docs. To link a glossary term, use the following syntax to link to term Anuket:: :term:`Anuket` :term: `This project ` [1] https://sublime-and-sphinx-guide.readthedocs.io/en/latest/glossary.html Signed-off-by: Emma Foley --- docs/glossary/index.rst | 132 +++++++++++++++++++++++++++--------------------- docs/index.rst | 5 ++ 2 files changed, 79 insertions(+), 58 deletions(-) diff --git a/docs/glossary/index.rst b/docs/glossary/index.rst index 5b95c67fb..0d8616970 100644 --- a/docs/glossary/index.rst +++ b/docs/glossary/index.rst @@ -17,186 +17,202 @@ This glossary provides a common definition of phrases and words commonly used in A - +.. glossary:: -Anuket + Anuket - The ancient Egyptian Goddess Anuket was a personification of the Nile as “Nourisher of the Fields”, and the name for the combined OPNFV and CNTT project. + The ancient Egyptian Goddess Anuket was a personification of the Nile as “Nourisher of the Fields”, and the name for the combined OPNFV and CNTT project. -Arno + Arno - A river running through Tuscany and the name of the first OPNFV release. + A river running through Tuscany and the name of the first OPNFV release. + + API -API Application Programming Interface -------- B - +.. glossary:: -Brahmaputra + Brahmaputra - A river running through Asia and the name of the Second OPNFV release. + A river running through Asia and the name of the Second OPNFV release. -------- C - +.. glossary:: + + Colorado -Colorado + A river in Argentina and the name of the Third OPNFV release. - A river in Argentina and the name of the Third OPNFV release. - -CNTT + CNTT - Cloud iNfrastructure Telco Task Force + Cloud iNfrastructure Telco Task Force -------- D - +.. glossary:: -Danube + Danube - A river in Europe and the name of the Fourth OPNFV release. + A river in Europe and the name of the Fourth OPNFV release. -DPDK + DPDK - Data Plane Development Kit + Data Plane Development Kit -DPI + DPI - Deep Packet Inspection + Deep Packet Inspection -DSCP + DSCP - Differentiated Services Code Point + Differentiated Services Code Point -------- E - +.. glossary:: -Euphrates + Euphrates - A river in Southeast Asia and the name of the Fifth OPNFV release. + A river in Southeast Asia and the name of the Fifth OPNFV release. -------- F - +.. glossary:: -Fraser + Fraser - A river in British Columbia, Canada, and the name of the Sixth OPNFV release. + A river in British Columbia, Canada, and the name of the Sixth OPNFV release. -------- G - +.. glossary:: -Gambia + Gambia - A river in Western Africa and the name of the Seventh OPNFV release. + A river in Western Africa and the name of the Seventh OPNFV release. -------- H - +.. glossary:: -Hunter + Hunter - A river in New South Wales, Australia and the name of the Eighth OPNFV release. + A river in New South Wales, Australia and the name of the Eighth OPNFV release. -------- I - +.. glossary:: -IGMP + IGMP - Internet Group Management Protocol + Internet Group Management Protocol -IOPS + IOPS - Input/Output Operations Per Second + Input/Output Operations Per Second -Iruya + Iruya - A river in Salta Province, Argentina and the name of the Ninth OPNFV release. + A river in Salta Province, Argentina and the name of the Ninth OPNFV release. -------- J - +.. glossary:: -Jerma + Jerma - A river in Serbia and the name of the Tenth OPNFV release. + A river in Serbia and the name of the Tenth OPNFV release. -------- K - +.. glossary:: -Kali + Kali + A river in Uttara Kannada district of Karnataka state in India and the name of the First Anuket (OPNFV+CNTT) release. - A river in Uttara Kannada district of Karnataka state in India and the name of the First Anuket (OPNFV+CNTT) release. -Kubernetes + Kubernetes - An operating system container management system, sometimes abbreviated "K8s" (meaning K, eight letters, and s). + An operating system container management system, sometimes abbreviated "K8s" (meaning K, eight letters, and s). -------- L - +.. glossary:: + + Lakelse -Lakelse + A river in Britsh Columbia, Canada (name derived from the Coast Tsimshian language word "LaxGyels"), and the name of the Second Anuket (OPNFV+CNTT) Release. - A river in Britsh Columbia, Canada (name derived from the Coast Tsimshian language word "LaxGyels"), and the name of the Second Anuket (OPNFV+CNTT) Release. +-------- N - +.. glossary:: -NFV + NFV - Network Functions Virtualisation, an industry initiative to leverage virtualisation technologies in carrier networks. + Network Functions Virtualisation, an industry initiative to leverage virtualisation technologies in carrier networks. -NFVI + NFVI - Network Function Virtualization Infrastructure + Network Function Virtualization Infrastructure -NIC + NIC - Network Interface Controller + Network Interface Controller -------- O - +.. glossary:: -OPNFV + OPNFV - Open Platform for NFV, an open source project developing an NFV reference platform and features. + Open Platform for NFV, an open source project developing an NFV reference platform and features. -------- V - +.. glossary:: -VLAN - - A virtual local area network, typically an isolated ethernet network. - -VM + VLAN - Virtual machine, an emulation in software of a computer system. + A virtual local area network, typically an isolated ethernet network. -VNF + VM - Virtual network function, typically a networking application or function running in a virtual environment. + Virtual machine, an emulation in software of a computer system. + VNF + Virtual network function, typically a networking application or function running in a virtual environment. diff --git a/docs/index.rst b/docs/index.rst index 21e259a26..4e59d6d7b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,6 +54,11 @@ Developer Guide how-to-use-docs/index +Glossary +-------- + +:doc:`glossary/index` + Found a typo or any other feedback? Send us an email_ or talk to us on Slack_. -- cgit 1.2.3-korg