-
Story
-
Resolution: Done
-
Medium
-
None
-
None
-
None
Running the sphinx spelling extension across the doc project and all related submodule repos, generates a list of strings that are not in the default "en_US" dictionary. Many of these are spelling errors and words concatenated to form variable names/properties, etc. But a few of them are likely words, acronyms, names, etc that we want to consider correct and use consistently across all ONAP projects. This story is about
(1) Taking the attached validwords.txt file list of strings, deleting lines and/or modifying lines to create a new file with a list of strings (words, acronyms, project names company names, etc) that should be recognized as correct and use consistent case/spelling across all ONAP projects.
(2) Describing any principles used to determine what should be valid for future use in extending the list.
(3) Recommending any items in the remaining list that should be better defined in a glossary or other reference.
Individual project rst files can add exceptions within each file using the sphinx spelling directive for other cases such as variable names/properties that are not common across all projects.