openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

OBSDOCS-892: Improve the release notes text in response to user feedback

Open max-cx opened this issue 1 year ago • 7 comments
trafficstars

Version(s):

4.16, 4.15, 4.14, 4.13, 4.12

Issue:

https://issues.redhat.com/browse/OBSDOCS-892

Link to docs preview:

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases#distributed-tracing-rn_3-1_tempo-release-notes_new-features-and-enhancements

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases#distributed-tracing-rn_3-1_jaeger-release-notes_new-features-and-enhancements

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/otel/otel_rn/otel-rn-past-releases#otel-rn_3-1_new-features-and-enhancements

QE review:

  • [ ] QE has approved this change.

Additional information:

max-cx avatar Mar 21 '24 20:03 max-cx

@max-cx: This pull request references OBSDOCS-892 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 bug to target the "4.16.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-robot avatar Mar 21 '24 20:03 openshift-ci-robot

🤖 Mon Apr 15 16:29:55 - Prow CI generated the docs preview: https://73592--ocpdocs-pr.netlify.app Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

ocpdocs-previewbot avatar Mar 21 '24 20:03 ocpdocs-previewbot

@max-cx: This pull request references OBSDOCS-892 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 bug to target the "4.16.0" version, but no target version was set.

In response to this:

Version(s):

4.16, 4.15, 4.14, 4.13, 4.12

Issue:

https://issues.redhat.com/browse/OBSDOCS-892

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 avatar Mar 22 '24 14:03 openshift-ci-robot

/test all

max-cx avatar Mar 25 '24 10:03 max-cx

/test validate-asciidoc

max-cx avatar Mar 25 '24 10:03 max-cx

@max-cx: This pull request references OBSDOCS-892 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 bug to target the "4.16.0" version, but no target version was set.

In response to this:

Version(s):

4.16, 4.15, 4.14, 4.13, 4.12

Issue:

https://issues.redhat.com/browse/OBSDOCS-892

Link to docs preview:

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases#distributed-tracing-rn_3-1_tempo-release-notes_new-features-and-enhancements

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases#distributed-tracing-rn_3-1_jaeger-release-notes_new-features-and-enhancements

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/otel/otel_rn/otel-rn-past-releases#otel-rn_3-1_new-features-and-enhancements

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 avatar Mar 25 '24 16:03 openshift-ci-robot

@max-cx: This pull request references OBSDOCS-892 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 bug to target the "4.16.0" version, but no target version was set.

In response to this:

Because the OTEL docs are no longer part of the distributed tracing docs, I replaced the list of three components (Tempo, OTEL, Jaeger) by linking to OTEL in a separate sentence and by mentioning Tempo and (deprecated) Jaeger together to preare for the removal of the soon-to-be-removed Jeager docs.

I combined the per-component links to the upstream projects with the per-component "Component versions" table, and move this information to a list item in the per-component section "New features and enhancements". This results in removal of the "Component versions" section.

Version(s):

4.16, 4.15, 4.14, 4.13, 4.12

Issue:

https://issues.redhat.com/browse/OBSDOCS-892

Link to docs preview:

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases#distributed-tracing-rn_3-1_tempo-release-notes_new-features-and-enhancements

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases#distributed-tracing-rn_3-1_jaeger-release-notes_new-features-and-enhancements

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/otel/otel_rn/otel-rn-past-releases#otel-rn_3-1_new-features-and-enhancements

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 avatar Mar 27 '24 21:03 openshift-ci-robot

@max-cx: This pull request references OBSDOCS-892 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 bug to target the "4.16.0" version, but no target version was set.

In response to this:

Because the OTEL docs are no longer part of the distributed tracing docs, I replaced the list of three components (Tempo, OTEL, Jaeger) by linking to OTEL in a separate sentence and by mentioning Tempo and (deprecated) Jaeger together to preare for the removal of the soon-to-be-removed Jeager docs.

I combined the per-component links to the upstream projects with the per-component "Component versions" table, and moved this information to a list item in the per-component section "New features and enhancements". This resulted in removal of the "Component versions" section.

Version(s):

4.16, 4.15, 4.14, 4.13, 4.12

Issue:

https://issues.redhat.com/browse/OBSDOCS-892

Link to docs preview:

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases#distributed-tracing-rn_3-1_tempo-release-notes_new-features-and-enhancements

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases#distributed-tracing-rn_3-1_jaeger-release-notes_new-features-and-enhancements

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/otel/otel_rn/otel-rn-past-releases#otel-rn_3-1_new-features-and-enhancements

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 avatar Mar 28 '24 13:03 openshift-ci-robot

/label peer-review-needed

max-cx avatar Apr 08 '24 12:04 max-cx

@max-cx: This pull request references OBSDOCS-892 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 bug to target the "4.16.0" version, but no target version was set.

In response to this:

Because the OTEL docs are no longer part of the distributed tracing docs, I replaced the list of three components (Tempo, OTEL, Jaeger) by linking to OTEL in a separate sentence and by mentioning Tempo and (deprecated) Jaeger together to preare for the removal of the soon-to-be-removed Jeager docs.

I combined the per-component links to the upstream projects with the per-component "Component versions" table, and moved this information to a list item in the per-component section "New features and enhancements". This resulted in removal of the "Component versions" section.

Version(s):

4.16, 4.15, 4.14, 4.13, 4.12

Issue:

https://issues.redhat.com/browse/OBSDOCS-892

Link to docs preview:

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1-1

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases#distributed-tracing-rn_3-1_tempo-release-notes_new-features-and-enhancements

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases#distributed-tracing-rn_3-1_jaeger-release-notes_new-features-and-enhancements

https://73592--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/otel/otel_rn/otel-rn-past-releases#otel-rn_3-1_new-features-and-enhancements

QE review:

  • [x] 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 avatar Apr 08 '24 12:04 openshift-ci-robot

Note: it might be worth checking if you need to do change management since this PR is removing a section from published release notes it seems like?

abrennan89 avatar Apr 08 '24 15:04 abrennan89

@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/test-infra repository. I understand the commands that are listed here.

openshift-ci[bot] avatar Apr 15 '24 16:04 openshift-ci[bot]

/label merge-review-needed

max-cx avatar Apr 15 '24 16:04 max-cx

lgtm!

kcarmichael08 avatar Apr 15 '24 17:04 kcarmichael08

/cherrypick enterprise-4.12

kcarmichael08 avatar Apr 15 '24 17:04 kcarmichael08

/cherrypick enterprise-4.13

kcarmichael08 avatar Apr 15 '24 17:04 kcarmichael08

/cherrypick enterprise-4.14

kcarmichael08 avatar Apr 15 '24 17:04 kcarmichael08

/cherrypick enterprise-4.15

kcarmichael08 avatar Apr 15 '24 17:04 kcarmichael08

/cherrypick enterprise-4.16

kcarmichael08 avatar Apr 15 '24 17:04 kcarmichael08

@kcarmichael08: new pull request created: #74667

In response to this:

/cherrypick enterprise-4.12

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/test-infra repository.

@kcarmichael08: new pull request created: #74668

In response to this:

/cherrypick enterprise-4.14

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/test-infra repository.

@kcarmichael08: new pull request created: #74669

In response to this:

/cherrypick enterprise-4.13

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/test-infra repository.

@kcarmichael08: new pull request created: #74670

In response to this:

/cherrypick enterprise-4.15

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/test-infra repository.

@kcarmichael08: new pull request created: #74671

In response to this:

/cherrypick enterprise-4.16

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/test-infra repository.