zowe/community

Discuss: requirements for automating terminology consistency across repos

Opened this issue · 1 comments

there are words and phrases in our documentation that we want to capitalize a certain way, or use hyphens versus underscores, or using certain names instead of codenames.

when new documentation comes in, a person must be careful to review for these words so that they can be consistent throughout all our documentation, but this is time consuming and perfectly reliable.

to a degree, this is a candidate for automation.

lets discuss how we might create github workflow automation to help us keep our terminology consistent. let's collect requirements on what this must do in order to not get in the way and actually be helpful.

some thoughts to start with:

  • this does not need to prevent PR merges, because it can always be improved afterwards
  • this could be run automatic on PRs, but there must be a list of files to avoid
  • if run automatically, it must have a way to be reverted in case it didnt do what was intended
  • manual runs may be preferred instead, in the form of something that creates a PR on its own, which can be reviewed by a person and corrected before merged. in this way, this could just be a periodic task for people to keep their repositories organized.

Manual must be consistent in all 5000 some languages.