-
Notifications
You must be signed in to change notification settings - Fork 8
MTA-6449 Fixing Release Notes Errors in 8.0 #283
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
vashirova
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Pkylas007 peer review completed, thank you for the opportunity. My main suggestion is to fix indentation issues for all individual Release Notes. Feel free to tag me if you need further review and/or help with indentation.
docs/release-notes/master.adoc
Outdated
|
|
||
| // Bring back when 8.1 is out [id="mta-8-0-0"] | ||
| //== {ProductShortName} 8.0.0 | ||
| [role="_abstract"] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is not necessary to add the abstract tag to master.adoc files, see https://docs.google.com/document/d/1tVnJt2kVuioaET8USjPRrSOUtgVl1H5C2uIxPck-sjU/edit?tab=t.0#heading=h.emgr9aipqezj.
|
|
||
| When you analyzed a binary, the performance degraded because {ProductShortName} relied on Maven search. With this release, this issue is fixed by introducing the pre-generated Maven index that does not require connecting to an external index. | ||
|
|
||
| link:https://issues.redhat.com/browse/MTA-6231[MTA-6231] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| When you analyzed a binary, the performance degraded because {ProductShortName} relied on Maven search. With this release, this issue is fixed by introducing the pre-generated Maven index that does not require connecting to an external index. | |
| link:https://issues.redhat.com/browse/MTA-6231[MTA-6231] | |
| + | |
| When you analyzed a binary, the performance degraded because {ProductShortName} relied on Maven search. With this release, this issue is fixed by introducing the pre-generated Maven index that does not require connecting to an external index. | |
| + | |
| link:https://issues.redhat.com/browse/MTA-6231[MTA-6231] |
Since this is a definition list, as with any other list we must attach all relevant paragraphs with a plus sign (+). See https://redhat-documentation.github.io/supplementary-style-guide/#release-note-asciidoc-format. This can be easily identified on the preview.
This issue is relevant for all individual Release Notes in this title, I'm not commenting on all of them.
|
|
||
| Before this update, when you generated a deployment manifest by using the Helm template, the default values in the`values.yaml` file, packaged with the Helm chart, were ignored. Consequently, only the values from the `values.yaml` file created after running the `mta-cli discover` command were used. With this update, the default `values.yaml` file is merged with the discover `values.yaml` file. | ||
|
|
||
| (link:https://issues.redhat.com/browse/MTA-5793[MTA-5793]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[Out of scope] I noticed 2 different syntax styles for links: with and without parenthesis. I'm curious if there is a reason behind it. If not, I'd consider picking one syntax style and sticking to all for the whole title for consistency.
This is not specific to DITA and thus I wouldn't bother to fix it for already published content. But I'd consider it for next releases.
| Before this update, when you analyzed an application built with Gradle in `Source code + dependencies` mode in the {ProductFullName} user interface (UI), the analysis failed if you had Gradle version 7 or later installed* With this update, the issue is fixed* | ||
|
|
||
| (link:https://issues.redhat.com/browse/MTA-5907[MTA-5907]) | ||
| (link:https://issues*redhat*com/browse/MTA-5907[MTA-5907]) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| (link:https://issues*redhat*com/browse/MTA-5907[MTA-5907]) | |
| (link:https://issues.redhat.com/browse/MTA-5907[MTA-5907]) |
Broken link otherwise
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
772b765 to
15a2c8a
Compare
anarnold97
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM - please merge
JIRA
*MTA-6449 [DOC] DITA Error - MTA Release Notes
Version
Preview
What changed
::delimiter