Skip to content

Conversation

@max-cx
Copy link
Contributor

@max-cx max-cx commented Feb 22, 2024

⚠️ We are aware of the merge freeze in effect. However, this PR is tied to a product release date, which is currently set to February 26.

💡 Please note that the XXL size of this PR is misleading: content from many pages was collected into fewer pages (the pages with the release notes for past releases), and several sections were migrated into separate pages (OpenTelemetry). So this shows up like a lot of new content in the diffs, which is in fact not the case.

⚠️ This PR aggregates cherry-picked commits from the following peer-reviewed PRs:

#70943
#71565
#69962
#71074

Version(s):

4.12, 4.13, 4.14, 4.15, 4.16

Manual cherry-picks to OCP 4.12, 4.13, 4.14:
#72123
#72127
#72128

Issue:

https://issues.redhat.com/browse/OBSDOCS-764
https://issues.redhat.com/browse/OBSDOCS-790
https://issues.redhat.com/browse/OBSDOCS-811
https://issues.redhat.com/browse/TRACING-3574
https://issues.redhat.com/browse/TRACING-3802

Link to docs preview:

New content:
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/distr_tracing/distr_tracing_rn/distr-tracing-rn-3-1
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/otel/otel_rn/otel-rn-3.1
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/distr_tracing/distr_tracing_tempo/distr-tracing-tempo-configuring#span-red-metrics-and-alerting-rules
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/otel/otel-configuration-of-otel-collector#otel-config-target-allocator_otel-configuration-of-otel-collector

Reorganized content:
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/distr_tracing/distr_tracing_rn/distr-tracing-rn-past-releases
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/otel/otel_rn/otel-rn-past-releases
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/otel/otel-configuration-of-otel-collector
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/otel/otel-configuration-of-instrumentation
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/otel/otel-sending-traces-and-metrics-to-otel-collector
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/otel/otel-config-send-metrics-monitoring-stack
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/otel/otel-forwarding
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/otel/otel-configuring-otelcol-metrics
https://72079--ocpdocs-pr.netlify.app/openshift-enterprise/latest/otel/otel-config-multicluster

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci openshift-ci bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Feb 22, 2024
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Feb 22, 2024

🤖 Mon Feb 26 16:51:47 - Prow CI generated the docs preview: https://72079--ocpdocs-pr.netlify.app

@max-cx
Copy link
Contributor Author

max-cx commented Feb 22, 2024

/label peer-review-done
(see description for an explanation)

@openshift-ci openshift-ci bot added the peer-review-done Signifies that the peer review team has reviewed this PR label Feb 22, 2024
@max-cx
Copy link
Contributor Author

max-cx commented Feb 22, 2024

/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 Feb 22, 2024
@max-cx max-cx changed the title Distributed tracing and Red Hat build of OpenTelemetry 3.1 Distributed tracing and Red Hat build of OpenTelemetry 3.1 release Feb 22, 2024
@kalexand-rh
Copy link
Contributor

@max-cx, there's no way to tell what has and has not been changed in the diffs. Is there a particular reason why you're putting an aggregate PR up instead of the original, smaller PRs? If we reviewed this, it would be a larger burden on the review squad.

@max-cx
Copy link
Contributor Author

max-cx commented Feb 26, 2024

@kalexand-rh, yes, I aggregated the PRs because

  1. All of this content has to be merged as one single 3.1 docs release (imagine merging bits of the OCP 4.15 release in different PRs at different times).
  2. Having this one PR avoids merge conflicts among the incorporated PRs.
  3. The commits of the incorporated PRs have been cherry-picked in this branch, so the changes are the same.
  4. The amount of changes is the same as is the amount of effort to review them, whether it's several PRs or one PR.

there's no way to tell what has and has not been changed in the diffs

Unfortunately, this is a consequence of content reorganization. I made it as user-friendly as possible to review by first having it reviewed as separate smaller PRs and then linking to the preview pages of the specific new content in the PR description.

@kcarmichael08 kcarmichael08 added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Feb 26, 2024
@max-cx max-cx force-pushed the dt3.1 branch 2 times, most recently from 81afe87 to e9e8fc6 Compare February 26, 2024 15:23
Copy link
Contributor

@kcarmichael08 kcarmichael08 left a comment

Choose a reason for hiding this comment

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

First batch of comments

Copy link
Contributor

@kcarmichael08 kcarmichael08 left a comment

Choose a reason for hiding this comment

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

Can you go through and make sure that all of your xrefs contain Anchor IDs? They will work on docs.openshift.com usually without this, but I think they can break the customer portal or not work in certain situations if they don't have this.

Copy link
Contributor

@kcarmichael08 kcarmichael08 left a comment

Choose a reason for hiding this comment

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

next batch of comments (above)

@max-cx max-cx force-pushed the dt3.1 branch 2 times, most recently from 41e8869 to dfbe120 Compare February 26, 2024 16:32
Copy link
Contributor

@kcarmichael08 kcarmichael08 left a comment

Choose a reason for hiding this comment

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

I think you've already fixed some of these - if so, please ignore

Copy link
Contributor

@kalexand-rh kalexand-rh left a comment

Choose a reason for hiding this comment

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

When this passes merge review, it can be merged.

@kcarmichael08
Copy link
Contributor

Good to merge when finishes building.

@openshift-ci
Copy link

openshift-ci bot commented Feb 26, 2024

@max-cx: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

@kcarmichael08
Copy link
Contributor

/cherrypick enterprise-4.12

@openshift-cherrypick-robot

@kcarmichael08: #72079 failed to apply on top of branch "enterprise-4.12":

Applying: Distributed tracing and Red Hat build of OpenTelemetry 3.1 release
.git/rebase-apply/patch:3752: trailing whitespace.
* 
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	_attributes/common-attributes.adoc
M	_topic_maps/_topic_map.yml
M	distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
M	distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
M	modules/distr-tracing-product-overview.adoc
A	observability/index.adoc
M	welcome/index.adoc
Falling back to patching base and 3-way merge...
Auto-merging welcome/index.adoc
CONFLICT (content): Merge conflict in welcome/index.adoc
Removing otel/otel-release-notes.adoc
Removing otel/otel-configuring.adoc
CONFLICT (modify/delete): observability/index.adoc deleted in HEAD and modified in Distributed tracing and Red Hat build of OpenTelemetry 3.1 release. Version Distributed tracing and Red Hat build of OpenTelemetry 3.1 release of observability/index.adoc left in tree.
Auto-merging modules/distr-tracing-product-overview.adoc
CONFLICT (content): Merge conflict in modules/distr-tracing-product-overview.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-3-0.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-2.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-1.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-8.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-7.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-6.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-5.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-4.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-3.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-2.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-1.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-0.adoc
Auto-merging distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
Auto-merging distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
Auto-merging _topic_maps/_topic_map.yml
Auto-merging _attributes/common-attributes.adoc
CONFLICT (content): Merge conflict in _attributes/common-attributes.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Distributed tracing and Red Hat build of OpenTelemetry 3.1 release
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Details

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

/cherrypick enterprise-4.13

@kcarmichael08
Copy link
Contributor

/cherrypick enterprise-4.14

@kcarmichael08
Copy link
Contributor

/cherrypick enterprise-4.15

@openshift-cherrypick-robot

@kcarmichael08: #72079 failed to apply on top of branch "enterprise-4.13":

Applying: Distributed tracing and Red Hat build of OpenTelemetry 3.1 release
.git/rebase-apply/patch:3752: trailing whitespace.
* 
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	_attributes/common-attributes.adoc
M	_topic_maps/_topic_map.yml
M	distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
M	distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
M	modules/distr-tracing-product-overview.adoc
A	observability/index.adoc
M	welcome/index.adoc
Falling back to patching base and 3-way merge...
Auto-merging welcome/index.adoc
CONFLICT (content): Merge conflict in welcome/index.adoc
Removing otel/otel-release-notes.adoc
Removing otel/otel-configuring.adoc
CONFLICT (modify/delete): observability/index.adoc deleted in HEAD and modified in Distributed tracing and Red Hat build of OpenTelemetry 3.1 release. Version Distributed tracing and Red Hat build of OpenTelemetry 3.1 release of observability/index.adoc left in tree.
Auto-merging modules/distr-tracing-product-overview.adoc
CONFLICT (content): Merge conflict in modules/distr-tracing-product-overview.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-3-0.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-2.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-1.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-8.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-7.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-6.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-5.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-4.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-3.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-2.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-1.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-0.adoc
Auto-merging distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
Auto-merging distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-configuring.adoc
Auto-merging _topic_maps/_topic_map.yml
Auto-merging _attributes/common-attributes.adoc
CONFLICT (content): Merge conflict in _attributes/common-attributes.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Distributed tracing and Red Hat build of OpenTelemetry 3.1 release
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Details

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.

@openshift-cherrypick-robot

@kcarmichael08: #72079 failed to apply on top of branch "enterprise-4.14":

Applying: Distributed tracing and Red Hat build of OpenTelemetry 3.1 release
.git/rebase-apply/patch:3752: trailing whitespace.
* 
warning: 1 line adds whitespace errors.
Using index info to reconstruct a base tree...
M	_attributes/common-attributes.adoc
M	_topic_maps/_topic_map.yml
M	distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
M	welcome/index.adoc
Falling back to patching base and 3-way merge...
Auto-merging welcome/index.adoc
CONFLICT (content): Merge conflict in welcome/index.adoc
Removing otel/otel-release-notes.adoc
Removing otel/otel-configuring.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-3-0.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-2.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-9-1.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-8.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-7.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-6.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-5.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-4.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-3.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-2.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-1.adoc
Removing distr_tracing/distr_tracing_rn/distr-tracing-rn-2-0.adoc
Auto-merging distr_tracing/distr_tracing_jaeger/distr-tracing-jaeger-installing.adoc
Auto-merging _topic_maps/_topic_map.yml
CONFLICT (content): Merge conflict in _topic_maps/_topic_map.yml
Auto-merging _attributes/common-attributes.adoc
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 Distributed tracing and Red Hat build of OpenTelemetry 3.1 release
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

Details

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.

@openshift-cherrypick-robot

@kcarmichael08: new pull request created: #72118

Details

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.12 branch/enterprise-4.13 branch/enterprise-4.14 branch/enterprise-4.15 merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR peer-review-done Signifies that the peer review team has reviewed this PR size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants