Improve usage of glossary in manuals

Registered by Emma Foley on 2016-07-29

There are 712 terms defined in the glossary [1].
There are 165 references to the glossary terms throughout the openstack-manuals repo [2].

The glossary exists to explain terms in the context of OpenStack, so that users don't have to look up terms that they are unfamiliar with and try to fit it back into the right context.
This is only useful if:
- users can easily access the glossary (i.e. link to glossary in docs).
- the glossary is not over burdened with acrynoms or terms that are not specific to OpenStack

[1] grep "^ [A-Z,a-z]" glossary.rst | wc -l
[2] https://github.com/openstack/openstack-manuals/search?utf8=%E2%9C%93&q=%3Aterm%3A

Blueprint information

Status:
Complete
Approver:
Lana
Priority:
Medium
Drafter:
Emma Foley
Direction:
Approved
Assignee:
Emma Foley
Definition:
Approved
Series goal:
Accepted for newton
Implementation:
Implemented
Milestone target:
milestone icon newton
Started by
KATO Tomoyuki on 2016-08-30
Completed by
Lana on 2016-09-21

Related branches

Sprints

Whiteboard

Gerrit topic: https://review.openstack.org/#q,topic:spec/improve-glossary-usage,n,z

Addressed by: https://review.openstack.org/348940
    Adds specification to improve glossary usage

Gerrit topic: https://review.openstack.org/#q,topic:bp/improve-glossary-usage,n,z

Addressed by: https://review.openstack.org/357777
    [glossary] Remove acrynoms [A-C]

Addressed by: https://review.openstack.org/357778
    [glossary] Remove acrynoms [D]

Addressed by: https://review.openstack.org/357781
    [glossary] Remove acrynoms [E-I]

Addressed by: https://review.openstack.org/357783
    [glossary] Remove acrynoms [J-L]

Addressed by: https://review.openstack.org/357785
    [glossary] Remove acrynoms [M-N]

Addressed by: https://review.openstack.org/357911
    [glossary] Remove acronyms [O-Z]

Addressed by: https://review.openstack.org/364899
    [glossary] Consolodate project codenames [trove]

Addressed by: https://review.openstack.org/364915
    [glossary] Consolodate project codenames [barbican]

Addressed by: https://review.openstack.org/364918
    [glossary] Consolodate project codenames [ceilometer]

Addressed by: https://review.openstack.org/364922
    [glossary] Consolodate project codenames [cinder]

Addressed by: https://review.openstack.org/364985
    [glossary] Consolodate project codenames [heat]

Addressed by: https://review.openstack.org/364988
    [glossary] Consolodate project codenames [horizon]

Addressed by: https://review.openstack.org/364989
    [glossary] Consolodate project codenames [ironic]

Addressed by: https://review.openstack.org/364991
    [glossary] Consolodate project codenames [keystone]

Addressed by: https://review.openstack.org/364992
    [glossary] Consolodate project codenames [mistral]

Addressed by: https://review.openstack.org/364993
    [glossary] Consolodate project codenames [monasca]

Addressed by: https://review.openstack.org/364995
    [glossary] Consolodate project codenames [murano]

Addressed by: https://review.openstack.org/364996
    [glossary] Consolodate project codenames [neutron]

Addressed by: https://review.openstack.org/364997
    [glossary] Consolodate project codenames [nova]

Addressed by: https://review.openstack.org/365003
    [glossary] Consolodate project codenames [zaqar]

Addressed by: https://review.openstack.org/368772
    [glossary] Fix acronym: BMC

Addressed by: https://review.openstack.org/384967
    [glossary] Consolodate project codenames [glance]

Addressed by: https://review.openstack.org/384974
    [glossary] Consolodate project codenames [rally]

Addressed by: https://review.openstack.org/385001
    [glossary] Consolodate project codenames [swift]

Addressed by: https://review.openstack.org/385010
    [Glossary] Consolodate project codenames [oslo]

Addressed by: https://review.openstack.org/385048
    [glossary] Consolodate project codenames [manila]

Addressed by: https://review.openstack.org/385068
    [glossary] Consolodate project codenames [sahara]

Addressed by: https://review.openstack.org/392715
    [glossary] Consolodate project codenames [magnum]

Addressed by: https://review.openstack.org/406172
    [glossary] Consolodate project codenames [designate]

Addressed by: https://review.openstack.org/406182
    [glossary] Consolodate project codenames [solum]

Addressed by: https://review.openstack.org/406201
    [glossary] Add tacker to the glossary

Addressed by: https://review.openstack.org/414185
    [glossary] Consolodate project codenames [vitrage]

Addressed by: https://review.openstack.org/414187
    [glossary] Consolodate project codenames [watcher]

Addressed by: https://review.openstack.org/414212
    [glossary] Consolodate project codenames [octavia]

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.