[Openstack-docs] Glossary usage in manuals

Andreas Jaeger aj at suse.com
Tue Jan 14 21:26:37 UTC 2014


I had some discussion with Diane and David about glossary usage and
summarize my understanding and a proposal here.

We have a great glossary (see
http://docs.openstack.org/glossary/content/glossary.html)  and only the
Security Guide uses it to produce some entries:
http://docs.openstack.org/security-guide/content/go01.html

We use in some places firstterm which is related to the glossary but
does not use it. I propose that we should not use firstterm at all and
use glossterm and include a glossary.

I'd also like to investigate a nice Rackspace maven plug-in that allows
to use HTML popups for Glossary definitions.

We can add the glossary to each book we build - either the complete
glossary or just the entries that use "glossterm" in the guide.

My proposal is to make better use of the great glossary we have and thus:
* Deprecate firstterm usage, ask for glossterm
* Add glossterm to some terms
* Add the glossary to our manuals
* Display as glossary only the entries that are in the documented
* Evaluate the Rackspace glossary plug-in

I propose to start with the Install Guide and then add further guides.

What do you think?

Andreas
-- 
 Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
  SUSE LINUX Products GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
   GF: Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB16746 (AG Nürnberg)
    GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126



More information about the Openstack-docs mailing list