Open Stack

Yes, I think Matt's right, there are probably a lot of terms that need to be removed from the glossary, but I think we can probably do better with linking to OpenStack-specific terms as well. A blueprint + spec for this work would be a good start, Emma.

Lana

On 25/07/16 23:21, Matt Kassawara wrote:
> Generally speaking, we should link the first occurrence of an "unusual" term or acronym in a particular file to the glossary. Linking every occurrence becomes difficult to manage. Also, we might want to consider purging terms or acronyms with definitions not specific to OpenStack because people can easily look them up via generic search.
> 
> On Mon, Jul 25, 2016 at 6:55 AM, Foley, Emma L <emma.l.foley at intel.com <mailto:emma.l.foley at intel.com>> wrote:
> 
>     Hi all,
> 
>     There are 712 terms defined in the glossary [1].
>     There are 165 references to the glossary terms throughout the openstack-manuals repo [2].
> 
>     In my opinion, the glossary is there 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.
>     By adding more links to glossary terms in the manuals, users will have a better experience coming to terms with OpenStack.
>     I've been using OpenStack for quite a while at this stage, and wasn't aware that there was a glossary until recently.
> 
>     My questions are:
>     - Do references to the glossary need to increase?
>     - Do I need to register a blueprint?
> 
>     Regards,
>     Emma
> 
>     [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
>     --------------------------------------------------------------
>     Intel Research and Development Ireland Limited
>     Registered in Ireland
>     Registered Office: Collinstown Industrial Park, Leixlip, County Kildare
>     Registered Number: 308263
> 
> 
> 
>     _______________________________________________
>     OpenStack-docs mailing list
>     OpenStack-docs at lists.openstack.org <mailto:OpenStack-docs at lists.openstack.org>
>     http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 
> 
> 
> 
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> 

-- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 538 bytes
Desc: OpenPGP digital signature
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20160726/287774b7/attachment.pgp>