Capturing issues found during the reorg eval to follow up on later

bergerhoffer commented 2 years ago

Capturing issues noticed during the reorg. Need to follow up after the reorg:

[ ] Red Hat Data Grid mentions that this name is as of "7.3 and later", but Red Hat JBoss Data Grid says that it is used as of 7.3 and earlier. Need to confirm which one is actually used in 7.3, and adjust the other term as necessary.
[ ] BxMS product name has changed and should be updated throughout its terms. Ping @sterobin for help - some of the component names changed too.
[ ] SSO terms are missing the (\) designation
[ ] OCS terms are missing the yes/no/with caution icons
[ ] The Foreman entry mentions a BZ to get a UI element changed, but the BZ was closed as WONTFIX. If it's still an issue, remove the reference to the BZ. If it's not still an issue, remove the guidance on it all (last 3 sentences)
[ ] The link to the Microsoft Azure glossary is broken. I think it should probably be changed to https://docs.microsoft.com/en-us/azure/azure-glossary-cloud-terminology
[ ] Terms that have two or more descriptions should use the same syntax for the 1/2/n. Some places use (1) and (2), others use 1) and 2). Pick one and use it consistently
[ ] "OpenStack services" isn't actually a term, but is guidance on how to write them generically. I had pulled the OCP "API objects" entry for the same reason. Didn't add it in for now, but consider whether to keep this (and the OCP one), or keep excluding them.
[ ] If we keep the ^ OpenStack services entry, consider whether it's okay as bullets or not. I thought we didn't want to use bullets because of systems like Vale that might be parsing the entries. Looks like the Operator entry is complex as well.
[ ] Fix "behaviour" to "behavior"
[ ] Certificate authorities description goes into probably too much specifics to Red Hat Identity Management for the SSG. Probably remove everything except the first sentence. Actually... there are several general ones like this. Review these other entries as well: Apache web server, cross-forest trust, domain controller, Kerberos protocol, Kerberos realm, Key Distribution Center, POSIX, web server (Check the RHEL tab of spreadsheet, possibly more). Determine if we want to just remove the IDM-specific pieces, or make them a 1) and 2) situation.
[ ] Some OpenShift terms were general, but still had some OCP-specific info. Consider whether those should just be removed, for example: image
[ ] Remove the outdated terms "OpenShift master" and "Kubernetes master". Or change them to do not use.
[ ] The "Use it" field for "OpenShift" says "yes, as described above". This should either be changed to "yes" or "with caution". Same for the "user name" field
[ ] RHSSO has some terms that are general enough, but had RHSSO-specific text to them. Consider removing the RHSSO-specific pieces. Examples: consent, credentials, role, service account, session. See spreadsheet for notes. Also consider if RHSSO name needs to be rebranded to the technology, or is okay to continue as is.
[ ] Review AMQ terms for any that say "In Red Hat AMQ" but might be better as something more generic like "In messaging" or "In JMS" or something. For example, "queue", "producer", "consumer", etc. Note that "destination" currently uses "In JMS".
[ ] There is a TODO under "JBoss Way" - needs xrefs to other entries
[ ] Evaluate Ceph terms to see if any are general enough to stand alone, or to be removed completely. (bucket, etc). Also there is a reference to version 1.3 that should be checked.
[ ] Fix broken link in Ceph's "pool" entry.
[ ] Does OCS need to be updated to new name of ODF?
[ ] Need to make changes to the Fuse terms that were suggested in the spreadsheet. This includes things like removing a few entries, renaming items, etc.

mportman12 commented 2 years ago

bergerhoffer commented 2 years ago

Closing this parent issue since items have been broken into grouped child issues.

redhat-documentation / supplementary-style-guide

Capturing issues found during the reorg eval to follow up on later #180