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.

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

OBSDOCS-1596: Release notes for the Tempo 3.5.1 patch #91498

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Apr 2, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Apr 2, 2025

@max-cx: This pull request references OBSDOCS-1596 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.19.0" version, but no target version was set.

In response to this:

Version(s):

Issue:

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-ci bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Apr 2, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Apr 2, 2025

@max-cx: This pull request references OBSDOCS-1596 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.19.0" version, but no target version was set.

In response to this:

Version(s):

Issue: https://issues.redhat.com/browse/OBSDOCS-1596

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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
Copy link

openshift-ci-robot commented Apr 2, 2025

@max-cx: This pull request references OBSDOCS-1596 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.19.0" version, but no target version was set.

In response to this:

Version(s): 4.12, 4.13, 4.14, 4.15, 4.16, 4.17, 4.18, 4.19

Issue: https://issues.redhat.com/browse/OBSDOCS-1596

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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.

@max-cx max-cx force-pushed the OBSDOCS-1596 branch 4 times, most recently from 5482c78 to 116f35a Compare April 2, 2025 15:10
@openshift-ci-robot
Copy link

openshift-ci-robot commented Apr 2, 2025

@max-cx: This pull request references OBSDOCS-1596 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.19.0" version, but no target version was set.

In response to this:

Version(s): 4.12, 4.13, 4.14, 4.15, 4.16, 4.17, 4.18, 4.19

Issue: https://issues.redhat.com/browse/OBSDOCS-1596

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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
Copy link

openshift-ci-robot commented Apr 2, 2025

@max-cx: This pull request references OBSDOCS-1596 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.19.0" version, but no target version was set.

In response to this:

Version(s): 4.12, 4.13, 4.14, 4.15, 4.16, 4.17, 4.18, 4.19

Issue: https://issues.redhat.com/browse/OBSDOCS-1596

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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.

@max-cx
Copy link
Contributor Author

max-cx commented Apr 2, 2025

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Apr 2, 2025
@GroceryBoyJr
Copy link
Contributor

/label peer-review-in-progress
/remove-label peer-review-needed
/assign GroceryBoyJr

@openshift-ci openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Apr 2, 2025
Copy link
Contributor

@GroceryBoyJr GroceryBoyJr left a comment

Choose a reason for hiding this comment

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

LGTM

@GroceryBoyJr
Copy link
Contributor

/label peer-review-done
/remove-label peer-review-in-progress
/unassign GroceryBoyJr

@openshift-ci openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR labels Apr 2, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Apr 3, 2025

@max-cx: This pull request references OBSDOCS-1596 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the task to target the "4.19.0" version, but no target version was set.

In response to this:

Version(s): 4.12, 4.13, 4.14, 4.15, 4.16, 4.17, 4.18, 4.19

Issue: https://issues.redhat.com/browse/OBSDOCS-1596

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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.

@max-cx
Copy link
Contributor Author

max-cx commented Apr 3, 2025

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Apr 3, 2025
@xenolinux xenolinux added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR labels Apr 3, 2025
Copy link
Contributor

@xenolinux xenolinux left a comment

Choose a reason for hiding this comment

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

Posted a few comments to consider before merging the PR. Overall lgtm

[id="distr-tracing_3-5_tempo-release-notes_known-issues_{context}"]
==== Known issues

There is currently a known issue:
Copy link
Contributor

Choose a reason for hiding this comment

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

this can be rephrased something like the following (if it doesn't hinder largely with the consistency in other files):

Suggested change
There is currently a known issue:
{TempoName} 3.5 has the following known issue:

Copy link
Contributor Author

@max-cx max-cx Apr 3, 2025

Choose a reason for hiding this comment

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

Thank you for the suggestion.
Indeed, this would be a consistency issue for all other entries on this page.
To give you the context: I have used this wording based on guidance in https://redhat-documentation.github.io/supplementary-style-guide/#_known_issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

However, I like your suggestion because it eliminates the word currently from the lead-in sentence.
I have applied your suggestion above and in the other comment.
Thank you.


The {TempoName} 3.5.1 update introduces the following breaking change:

* With this update, for a user to create or modify a `TempoStack` or `TempoMonolithic` custom resource with enabled multi-tenancy, the user must have permissions to create a TokenReview and SubjectAccessReview.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* With this update, for a user to create or modify a `TempoStack` or `TempoMonolithic` custom resource with enabled multi-tenancy, the user must have permissions to create a TokenReview and SubjectAccessReview.
* With this update, for a user to create or modify a `TempoStack` or `TempoMonolithic` custom resource with enabled multi-tenancy, the user must have permissions to create the `TokenReview` and `SubjectAccessReview` permissions for authorization.

Copy link
Contributor Author

@max-cx max-cx Apr 3, 2025

Choose a reason for hiding this comment

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

Thank you for the suggestion.
I reworded it differently based on an OpenShift reference:

... the user must have permissions to create a `TokenReview`
and `SubjectAccessReview` authorization objects.

[id="distr-tracing_3-5-1_tempo-release-notes_known-issues_{context}"]
==== Known issues

There is currently a known issue:
Copy link
Contributor

Choose a reason for hiding this comment

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

Same comment as earlier

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the suggestion.
Same reply as in #91498 (comment).

@xenolinux xenolinux removed the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Apr 3, 2025
@max-cx max-cx force-pushed the OBSDOCS-1596 branch 3 times, most recently from b3e3202 to 7285e5b Compare April 3, 2025 14:27
Copy link

openshift-ci bot commented Apr 3, 2025

@max-cx: 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. peer-review-done Signifies that the peer review team has reviewed this PR size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants