[RHACS] [Docs] [rhacs-docs-main] ROX-33462: Fixing DITA errors in the 4.10 release notes#107975
[RHACS] [Docs] [rhacs-docs-main] ROX-33462: Fixing DITA errors in the 4.10 release notes#107975agantony wants to merge 1 commit intoopenshift:rhacs-docs-mainfrom
Conversation
agantony
added
ok-to-test
|
@agantony: This pull request references ROX-33462 which is a valid jira issue. 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 openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci-robot
added
the
jira/valid-reference
openshift-ci
bot
added
the
size/XL
agantony
force-pushed
the
ROX33462-dita-fix-4.10-RN
branch
from
7a8ef3e to
46358f1
Compare
|
🤖 Thu Mar 05 15:36:04 - Prow CI generated the docs preview: https://107975--ocpdocs-pr.netlify.app/openshift-acs/latest/configuration/enable-offline-mode.html |
ROX33462 Small improvements ROX33462 Fixing linguistic errors ROX33462 Fixing linguistic errors
agantony
force-pushed
the
ROX33462-dita-fix-4.10-RN
branch
from
46358f1 to
5f8d994
Compare
|
@agantony: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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. |
| [id="bug-fixes_410"] | ||
| = Bug fixes in version 4.10 | ||
|
|
||
| *Release date*: {ga-date-410} |
There was a problem hiding this comment.
I think this needs to be removed (the date) or moved under the abstract
| *Release date*: {ga-date-410} | ||
|
|
||
| [role="_abstract"] | ||
| Apply these recent updates to Central to optimize your system's performance and dashboard visibility. You can now manage network policies by using assigned port names and complete faster image searches. Update your environment to resolve database connection hoarding during machine-to-machine (M2M) configuration and view unified policy categories without duplicates. |
There was a problem hiding this comment.
I would be more generic and just say something like "This release contains bug fixes and enhancements" - this doesn't really seem accurate to describe all of the bug fixes
|
|
||
| Deprecated functionality is still included in {product-title-short} and continues to be supported; however, it will be removed in a future release of this product and is not recommended for new deployments. | ||
| For the most recent list of major functionality deprecated and removed, see the following table. | ||
| Additional removed or deprecated functionality is available after the table. |
There was a problem hiding this comment.
| Additional removed or deprecated functionality is available after the table. | |
| Information about additional removed or deprecated functionality is available after the table. |
| = Notable technical changes | ||
|
|
||
| [role="_abstract"] | ||
| To successfully make a transition to {product-title-short} 4.10, you must follow specific staged upgrade paths and verify your system components meet the latest version requirements. You can go to the redesigned *Risk* page and configure adjusted parallel image scan limits to optimize your daily security workflows. Review the recent architectural changes, including removed APIs and updated certificate initialization logic, to support cluster stability and prevent backup reconciliation failures. |
There was a problem hiding this comment.
This doesn't seem correct, the abstract should describe the whole module, not just the risk page? I think this should be something like "This release includes notable technical changes" - that's it, because they are listed following the abstract. Was this AI generated? It doesn't make sense.
| = Release dates | ||
|
|
||
| [role="_abstract"] | ||
| To effectively plan your system upgrades, monitor the release schedule for {product-title-short}. You can verify exactly when {product-title-short} 4.10 and later updates officially become available to ensure your environments remain up to date. |
There was a problem hiding this comment.
This seems like a weird abstract for what is essentially a list of dates.
|
|
||
| {product-title-short} 4.10 includes the following new features, improvements, and updates: | ||
|
|
||
| Platform:: |
There was a problem hiding this comment.
The whole point of having these bullets was to have links to the sections later in the document. Since we aren't allowed to have xrefs in the module, and you have the xrefs under "additional resources", I would remove all of these bullets and just say "4.10 includes new features, improvements, and updates."
kcarmichael08
added
the
peer-review-done
4 participants
Version(s):
4.10+
Issue:
https://issues.redhat.com/browse/ROX-33462
Link to docs preview:
SME review: NA
Additional information:
Cherry-pick to
rhacs-docs-4.10