ColoradoRLA icon indicating copy to clipboard operation
ColoradoRLA copied to clipboard

ensure glossary is up-to-date, appropriate, and consistent for User Manual, Run Book, and Specification

Open kiniry opened this issue 8 years ago • 5 comments
trafficstars

kiniry avatar Aug 17 '17 23:08 kiniry

A couple suggestions:

  • add a few terms around open source (e.g. "open source," "copyleft," etc)
  • alphabetize the entries

cjerdonek avatar Aug 21 '17 00:08 cjerdonek

PS - since the glossary is big, it looks like it would be easy to script alphabetizing it (e.g. in Python by splitting on \n* **, sorting, and then joining again). Or even just splitting on \n\n.

cjerdonek avatar Aug 21 '17 00:08 cjerdonek

Thanks for your input @cjerdonek. @mkiniry, make sure to add those terms and work with us to get the full glossary done for the phase-3 release.

And yes, @cjerdonek, we did intend to auto-sort the list. Feel free to provide a script in a PR. ;)

kiniry avatar Aug 25 '17 17:08 kiniry

I added a script in PR #481. You don't need to check it in if you just want to use it once.

cjerdonek avatar Aug 26 '17 00:08 cjerdonek

There are several @review comments still in the glossary. What procedure do we want to use to resolve them? E.g., @sfsinger resolves them using her best judgment and asks for review from @kiniry?

sfsinger19103 avatar Sep 16 '17 23:09 sfsinger19103