Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
kiniry opened this issue Aug 17, 2017 · 5 comments

Comments

@kiniry
Copy link
Contributor

kiniry commented Aug 17, 2017

No description provided.

@kiniry kiniry added this to the phase-2 milestone Aug 17, 2017
@kiniry kiniry changed the title ensure glossary is up-to-date, appropriate, and consistent for User's Guide, Tutorial, and Specification ensure glossary is up-to-date, appropriate, and consistent for User Manual, Run Book, and Specification Aug 17, 2017
@cjerdonek
Copy link

A couple suggestions:

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

@cjerdonek
Copy link

cjerdonek commented Aug 21, 2017

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.

@kiniry
Copy link
Contributor Author

kiniry commented Aug 25, 2017

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 kiniry modified the milestones: phase-3, phase-2 Aug 25, 2017
@kiniry kiniry added the feature label Aug 25, 2017
@cjerdonek
Copy link

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

@kiniry kiniry modified the milestones: UI/UX polishing & performance and security testing, phase-3 Sep 1, 2017
@sfsinger19103
Copy link
Contributor

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants