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

Move performance to java agent, merge javadoc into API page #5590

Merged
merged 7 commits into from
Nov 15, 2024

Conversation

jack-berg
Copy link
Member

@jack-berg jack-berg commented Nov 11, 2024

Resolves #5211.

An alternative to #5522 based on the conversation here:

  • Move "Performance" page to "Zero-code Instrumentation -> Java -> Agent -> Performance"
  • Merge "Javadoc" into "Record Telemetry with API", page from "../api-components/" to "../api/".

Previews

content/en/docs/zero-code/java/agent/performance.md Outdated Show resolved Hide resolved
content/en/docs/languages/java/api.md Outdated Show resolved Hide resolved
content/en/docs/languages/java/api.md Outdated Show resolved Hide resolved
@jack-berg
Copy link
Member Author

/fix:htmltest-config

@opentelemetrybot
Copy link
Collaborator

You triggered fix:htmltest-config action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/11808233847

@opentelemetrybot
Copy link
Collaborator

fix:htmltest-config was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

@opentelemetrybot opentelemetrybot requested a review from a team November 13, 2024 14:17
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Works for me. @open-telemetry/docs-approvers any other feedback?

Once all checks are passing, of course ✅

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Blocking until I figure out how best to manage the broken links in non-en pages.

@chalin
Copy link
Contributor

chalin commented Nov 13, 2024

(Edited to include a full list)

@jack-berg - there are broken links in this en page that need to be fixed:

docs/collector/deployment/agent/index.html
  target does not exist --- docs/collector/deployment/agent/index.html --> /docs/languages/java/api-components/#meterprovider
docs/zero-code/java/agent/performance/index.html
  target does not exist --- docs/zero-code/java/agent/performance/index.html --> ../sdk/#sampler
  hash does not exist --- docs/zero-code/java/agent/performance/index.html --> ../getting-started/#prerequisites
docs/languages/java/instrumentation/index.html
  target does not exist --- docs/languages/java/instrumentation/index.html --> ../api-components/
  target does not exist --- docs/languages/java/instrumentation/index.html --> ../api-components/
  target does not exist --- docs/languages/java/instrumentation/index.html --> ../api-components/#context-api
  target does not exist --- docs/languages/java/instrumentation/index.html --> ../api-components/#contextpropagators
  target does not exist --- docs/languages/java/instrumentation/index.html --> ../api-components/#contextpropagators
  target does not exist --- docs/languages/java/instrumentation/index.html --> ../api-components/#context
  target does not exist --- docs/languages/java/instrumentation/index.html --> ../api-components/#semantic-attributes
  target does not exist --- docs/languages/java/instrumentation/index.html --> ../api-components/#loggerprovider
  target does not exist --- docs/languages/java/instrumentation/index.html --> ../api-components/#logger
  target does not exist --- docs/languages/java/instrumentation/index.html --> ../api-components/#tracerprovider
  target does not exist --- docs/languages/java/instrumentation/index.html --> ../api-components/#meterprovider
docs/languages/java/sdk/index.html
  target does not exist --- docs/languages/java/sdk/index.html --> ../api-components/
  target does not exist --- docs/languages/java/sdk/index.html --> ../api-components/#opentelemetry
  target does not exist --- docs/languages/java/sdk/index.html --> ../api-components/#tracerprovider
  target does not exist --- docs/languages/java/sdk/index.html --> ../api-components/#meterprovider
  target does not exist --- docs/languages/java/sdk/index.html --> ../api-components/#loggerprovider
docs/concepts/instrumentation/libraries/index.html
  target does not exist --- docs/concepts/instrumentation/libraries/index.html --> /docs/languages/java/api-components/#contextpropagators
docs/languages/java/intro/index.html
  target does not exist --- docs/languages/java/intro/index.html --> ../api-components/
  target does not exist --- docs/languages/java/intro/index.html --> ../performance/
docs/languages/java/configuration/index.html
  target does not exist --- docs/languages/java/configuration/index.html --> ../api-components/
========================================================================
✘✘✘ failed in 40.707039223s
23 errors in 1988 documents

@opentelemetrybot opentelemetrybot requested review from a team and TylerHelmuth and removed request for a team November 13, 2024 21:51
@jack-berg
Copy link
Member Author

jack-berg commented Nov 13, 2024

Blocking until I figure out how best to manage the broken links in non-en pages.

I've fixed all the links and believe there weren't any broken links in non-en pages

Copy link
Member

@svrnm svrnm left a comment

Choose a reason for hiding this comment

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

LGTM, will wait for @chalin to re-review.

@svrnm svrnm requested a review from chalin November 14, 2024 11:52
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

It seems like the non-en link-check failures were in en fallback pages.

LGTM

@chalin
Copy link
Contributor

chalin commented Nov 15, 2024

It seems that we need one more approval from @open-telemetry/java-approvers.

@jack-berg
Copy link
Member Author

It seems that we need one more approval from @open-telemetry/java-approvers.

We've got an approval from java-approver @jaydeluca. Do we need a second? In the past, one java-approver approval has been enough. Not expressing an opinion on whether we should have one or two approvals required - just clarifying my understanding. 🙂

@chalin
Copy link
Contributor

chalin commented Nov 15, 2024

I'm not sure what the policy is; I'll let @svrnm chime in. Also, I don't see @jaydeluca listed in @open-telemetry/java-approvers, which matches what GH reported above:

image

@jack-berg
Copy link
Member Author

Also, I don't see @jaydeluca listed in @open-telemetry/java-approvers, which matches what GH reported above:

Ah that's right. Yeah we have a bit of a weird thing going on where we have two partially independent / partially overlapping groups of approvers in the java SIG: @open-telemetry/java-approvers and @open-telemetry/java-instrumentation-approvers. Both groups are trusted collaborators in the Java SIG, but the @open-telemetry/java-instrumentation-approvers tend to contribute more to the opentelemetry-java-instrumentation repo while the @open-telemetry/java-approvers tend to contribute more to the opentelemetry-java repo.

In my head, the set of people trusted to approve java opentelemetry.io PRs is the superset of both groups, since the docs have much less strict delineation between content related to opentelemetry-java-instrumentation and opentelemetry-java.

Some instances where an approval from a @open-telemetry/java-instrumentation-approvers has been sufficient: #5471, #5275, #4966

@chalin
Copy link
Contributor

chalin commented Nov 15, 2024

Thanks for the explanation @jack-berg. That works for me. Adding this to the merge queue.

@chalin chalin added this pull request to the merge queue Nov 15, 2024
@trask
Copy link
Member

trask commented Nov 15, 2024

In my head, the set of people trusted to approve java opentelemetry.io PRs is the superset of both groups

👍

Merged via the queue into open-telemetry:main with commit d657980 Nov 15, 2024
17 checks passed
drewby pushed a commit to drewby/opentelemetry.io that referenced this pull request Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Finish refactoring Java information architecture
7 participants