MCO Update the machine config node module title to be more JTBD #102928
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openshift-ci
bot
added
the
size/XS
|
🤖 Fri Nov 21 22:49:51 - Prow CI generated the docs preview: https://102928--ocpdocs-pr.netlify.app/openshift-enterprise/latest/machine_configuration/index.html |
|
@mburke5678: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
mburke5678
added
the
merge-review-needed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I wanted to change the name of the modules that document the machine config node feature, which reports the status of nodes after you update, or make specific changes, to the node. The current titles, About checking machine config node status and Checking machine config node status were based on the Checking machine config pool status module that proceeds them. To me these titles seem too feature-centric. I want something more Jobs to be Done style.
I also added abstract tags and slightly tweaked the intro paragraph of
checking-mco-node-status.adocto make to better fit the new standards.I would love feedback on any of these changes.
Link to docs preview:
About node status during updates -- New title.
Checking node status during updates -- New title; small addition to first paragraph.
QE review:
No QE