CNV-7522 - nmstate more config example#26524
Conversation
openshift-ci-robot
added
do-not-merge/work-in-progress
|
The preview will be available shortly at: |
aburdenthehand
changed the title
openshift-ci-robot
removed
the
do-not-merge/work-in-progress
|
/lgtm |
|
@RamLavi: changing LGTM is restricted to collaborators DetailsIn response to this:
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/test-infra repository. |
aburdenthehand
added
branch/enterprise-4.5
branch/enterprise-4.6
branch/enterprise-4.7
CNV
aburdenthehand
force-pushed
the
cnv-7521-nmstate-examples
branch
from
3201169 to
031e9ad
Compare
sjhala-ccs
left a comment
sjhala-ccs
left a comment
There was a problem hiding this comment.
A few minor things, but otherwise LGTM!
There was a problem hiding this comment.
I don't think that "snippet" is necessary when you're already saying "example".
There was a problem hiding this comment.
Despite what these changes may suggest, I actually don't much like the term 'snippet'. However I do think it's important to be very specific here between what is a complete example configuration (also featured in the assembly), and what is only a part of a configuration. nmstate is pretty powerful and these policies can alter the network of the whole cluster so I guess this is my prudence showing :)
There was a problem hiding this comment.
Cleaned up some of the flagrant usage. Now only used in leading para specific to the config
There was a problem hiding this comment.
Just curious, what is the purpose of the [discrete] label?
There was a problem hiding this comment.
It prevents the title from showing in the TOC.
I used it here so that I could xref to the different policy examples after the early procedure where it's relevant, but having additional resources turn up as entry 3 in the TOC didn't look right (and those elements are already in the TOC, so it's only relevant to people who are looking at that particular procedure.
ousleyp
left a comment
ousleyp
left a comment
There was a problem hiding this comment.
Some nits, but overall this is looking good!
There was a problem hiding this comment.
Question that I have asked you before, but that might have a new answer now that the formatting guidelines have been updated: should Policy be capitalized throughout this document? If yes, should it be in backticks?
There was a problem hiding this comment.
Good question. Not in backticks, as 'Policy' is only part of the full object name. I'm reluctant to drop it down to 'policy' though because we also have other policies that impact VMs. Maybe using the acronym (NNCP) makes the most sense but runs into the danger of blurring with NNCE, and that distinction should remain clear.
I'd like to keep capitalised for now as I think that makes the most sense for now, but I've raised an item for our next meeting for addressing the decapitalisation of objects in our docs en masse.
…quired a bit of rejigging of current content
aburdenthehand
force-pushed
the
cnv-7521-nmstate-examples
branch
from
cb64cbe to
fca6c95
Compare
|
/cherry-pick enterprise-4.5 |
|
/cherry-pick enterprise-4.6 |
|
@aburdenthehand: new pull request created: #27144 DetailsIn response to this:
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/test-infra repository. |
|
/cherry-pick enterprise-4.7 |
|
@aburdenthehand: new pull request created: #27145 DetailsIn response to this:
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/test-infra repository. |
|
@aburdenthehand: new pull request created: #27146 DetailsIn response to this:
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/test-infra repository. |
9 participants
Adding some new nmstate configuration examples and snippets, which required a bit of rejigging of current content
And it looks like I name my branch the epic ID. Oh well.
https://issues.redhat.com/browse/CNV-7522
Build link: https://cnv-7521-nmstate-examples--ocpdocs.netlify.app/openshift-enterprise/latest/virt/node_network/virt-updating-node-network-config.html