Glossary project part 1 #1305
Glossary project part 1 #1305
Conversation
initial draft + styling for definition tags
…58-glossary-project
…file to update regardless of version to achieve this, we needed to use an madx-code-block to give us a proper side navigation TOC
…ated terms was visually confusing added some definitions (catalogs, downstream cluster)
martyav
requested review from
btat,
LucasSaintarbor and
sunilarjun
as code owners
shared-files/_glossary.md
Outdated
| Rancher Enterprise | ||
| </dt> | ||
| <dd> | ||
| An alternative name for <i>Rancher Prime</i>. |
There was a problem hiding this comment.
| An alternative name for <i>Rancher Prime</i>. | |
| An alternative name for <i>Rancher Prime</i>. |
There was a problem hiding this comment.
Listing these here since they apply to multiple things
- The
An alternative name for...instances use colon, comma, and periods. We should be consistent. - The criteria used to determine what values show in the
Related termsfield for the K8s distros seems very inconsistent. If we're using "they're all K8s distros" as the relation, then all entries should list all other entries.- K3s
- RKE2
- Rancher Kubernetes Engine (RKE)
- K3s, RKE2, RKE Government
- RKE1
- RKE2
- RKE2
- None
- RKE Government
- None
- K3s
Co-authored-by: Billy Tat <[email protected]> Co-authored-by: Sunil Singh <[email protected]>
…cing language in definitions
shared-files/_glossary.md
Outdated
| A CNCF-certified Kubernetes distribution that runs entirely within Docker containers. There are two main versions of RKE available. The 1.x software line is sometimes called <i>RKE1</i>. The next-generation line is called <i>RKE2</i>. | ||
| </li> | ||
| <li> | ||
| Shorthand for <i>RKE1</i>, the 1.x software line of RKE. |
There was a problem hiding this comment.
Is this considered a second definition or is the ordered list used as a workaround to add another paragraph?
Shorthand for RKE1 - it seems a bit awkward to call the preferred term a shorthand of a secondary form.
the 1.x software line of RKE - we're kind of defining RKE by making a reference to RKE with this part.
Also, both parts of the second listitem seemed like they can be dropped since the first listitem already makes a similar reference.
There was a problem hiding this comment.
It was intended as a second definition, but if we don't need it we can get rid of the list
There was a problem hiding this comment.
I'd vote for removing it.
Forgot to include this in my original comment:
the 1.x software line of RKE - we're kind of defining RKE by making a reference to RKE with this part.
There was a problem hiding this comment.
If definition 2 stood alone without the previous definition describing RKE, it would be more confusing. But, at any rate, definition 1 already covers the RKE1 usage ("The 1.x software line is sometimes called RKE1") so the second definition isn't necessary. We can just remove the second definition and update that sentence in the first to, "The 1.x software line is sometimes called RKE1, or simply RKE."
Co-authored-by: Billy Tat <[email protected]>
Co-authored-by: Billy Tat <[email protected]>
martyav
dismissed
sunilarjun’s stale review
Dismissing as the changes requested have been fulfilled, but the review is still open
Addresses #358
Reminders
See the README for more details on how to work with the Rancher docs.
Verify if changes pertain to other versions of Rancher. If they do, finalize the edits on one version of the page, then apply the edits to the other versions.
If the pull request is dependent on an upcoming release, make sure to target the release branch instead of
main.Description
Since we were asked to publish what we have instead of waiting for the rest of the glossary to be filled out, I created a new working branch based off of #1125. I'm keeping #1125 open as it still contains useful conversations and can be used for tracking.
Comments