Skip to content
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.

Sign up for GitHub

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

https://issues.redhat.com/browse/ACM-15155 #7281

Merged
merged 5 commits into from
Nov 26, 2024
Merged

https://issues.redhat.com/browse/ACM-15155 #7281

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8ad2638
https://issues.redhat.com/browse/ACM-15155
Nov 25, 2024
0a0b82b
doc feedback
Nov 25, 2024
195115e
Update clusters/release_notes/mce_errata.adoc
jc-berger Nov 25, 2024
36263ab
Update clusters/release_notes/mce_errata.adoc
jc-berger Nov 25, 2024
bf17986
Update clusters/release_notes/mce_errata.adoc
jc-berger Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions clusters/release_notes/mce_errata.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,17 @@ For {mce-short}, the Errata updates are automatically applied when released.
If no release notes are listed, the product does not have an Errata release at this time.

*Important:* For reference, Jira links and Jira numbers might be added to the content and used internally. Links that require access might not be available for the user.

== Errata 2.7.1

* Delivers updates to one or more product container images.

* Fixes an error with the *Clear all filters* button. (https://issues.redhat.com/browse/ACM-15277[ACM-15277])

* Stops the `Detach clusters` action from deleting hosted clusters. (https://issues.redhat.com/browse/ACM-15018[ACM-15018])

* Prevents the managed clusters from being displayed in the _Discovery_ tab in the console after updating valid {ocm} credentials to invalid ones. (https://issues.redhat.com/browse/ACM-15010[ACM-15010])

* Keeps the `cluster-proxy-addon` from getting stuck in the `Progressing` state. (https://issues.redhat.com/browse/ACM-14863[ACM-14863])


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's reduce the same robotic language "Fixes an issue where" so not each of these sound the same. Also are these actual code elements?

Copy link
Contributor

@swopebe swopebe Nov 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We switch tense here at times. Please see previous release notes. Not sure if you want present or past here.

..is stuck in a type of progressing state. (really weird line, what are we trying to say here?)

Stuck in the progressing status (or stage)... is usually how tech writers would word a status.

Again, you have to rewrite most of what you get to make it understandable to the user...and that means we have to have some level of understanding about what we are trying to say.

Copy link
Contributor

@swopebe swopebe Nov 25, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Check in the issue, but I think we are trying to say that the cluster-proxy-addon resource(??) is stuck in the Progressing state. (or status, usually starts with a capital letter but I could be wrong--although that would be weird to have it lower case)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Brandi! So, I think the revision works, let me know what you think.

Reading the Jira, it says the state is "progressing... mca and work configs mismatch"

I've never seen a state that long nor a state with ellipses in it. Anyway, I think Progressing captures what it means and the JIra can give the user more detail, but let me know if you think the rewrite fixes your concern with it being confusing.