A tiny change in HCP release notes structure #85317
Conversation
openshift-ci
bot
added
the
size/S
|
🤖 Fri Nov 22 08:13:27 - Prow CI generated the docs preview: |
|
@xenolinux: 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. |
xenolinux
added
peer-review-needed
|
/label peer-review-in-progress |
|
/remove-label peer-review-needed |
openshift-ci
bot
added
peer-review-in-progress
There was a problem hiding this comment.
LGTM on the changes in the PR.
Global recommendations for future PRs about this page:
From my personal experience with peer reviews for this repo, I was asked multiple times to include the snippets/technology-preview.adoc admonition on pages, preferably after the first paragraph (due to SEO) or further in the section.
IBM Style guidance is to "use parentheses to identify items such as abbreviations, symbols, and measurements, but avoid using parentheses in general text." You might want to rethink use of parentheses in (Technology Preview in section heading.
This page appears to have an inconsistent use of parentheses with TP/GA in new feature headings: TP is mentioned in parentheses, but GA is mentioned without parentheses. For example:
Custom taints and tolerations (Technology Preview)
versus
Hosted control planes on OpenShift Virtualization in a disconnected environment is Generally Available
I'd recommend considering the splitting of your current "New features and enhancements" section into two sections:
New features and enhancements
and
Technology Preview features
See my example of how this can be done: https://docs.openshift.com/container-platform/4.14/observability/otel/otel-rn.html#otel_3-3_technology-preview-features_otel-rn
In this linked example, one common TP admonition is added for all of the TP features in the section:
:FeatureName: Each of these features
include::snippets/technology-preview.adoc[leveloffset=+1]
|
/label peer-review-done |
|
/remove-label peer-review-in-progress |
openshift-ci
bot
added
peer-review-done
Thank you. @max-cx I will consider these improvements to include in another (probably 4.18 RN) PR . |
|
/cherrypick enterprise-4.17 |
|
/cherrypick enterprise-4.18 |
|
@xenolinux: new pull request created: #85566 In 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-sigs/prow repository. |
|
@xenolinux: new pull request created: #85567 In 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-sigs/prow repository. |
Version(s): 4.17+
Issue: None
Link to docs preview: https://85317--ocpdocs-pr.netlify.app/openshift-enterprise/latest/hosted_control_planes/hosted-control-planes-release-notes.html
QE review: Not required. This is purely a structure change.
Additional information: