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 the Spring Auto-Configuration doc to opentelemetry.io #10083

Closed
jeanbisutti opened this issue Dec 15, 2023 · 15 comments
Closed

Move the Spring Auto-Configuration doc to opentelemetry.io #10083

jeanbisutti opened this issue Dec 15, 2023 · 15 comments
Assignees
Labels

Comments

@jeanbisutti
Copy link
Member

Is your feature request related to a problem? Please describe.

Move the Spring Auto-Configuration documentation to the opentelemetry.io website

Describe the solution you'd like

Move and adapt the documentation Readme: https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/spring/spring-boot-autoconfigure/README.md

Describe alternatives you've considered

No response

Additional context

No response

@jeanbisutti jeanbisutti added enhancement New feature or request needs triage New issue that requires triage labels Dec 15, 2023
@jeanbisutti
Copy link
Member Author

@zeitlinger Could you please add the spring boot starter label?

@zeitlinger
Copy link
Member

let's do this after #9950

@Tejasker
Copy link

Hi @jeanbisutti , @zeitlinger is this issue related to a modification in the Document ie adding the Spring Auto-Configuration & modify the original Read.me then I can take up the issue & try to resolve it (Ie make modifications accordingly)

@jeanbisutti
Copy link
Member Author

Hi @jeanbisutti , @zeitlinger is this issue related to a modification in the Document ie adding the Spring Auto-Configuration & modify the original Read.me then I can take up the issue & try to resolve it (Ie make modifications accordingly)

@Tejasker The goal is to add and adapt the content of this Readme to this website page.

@jeanbisutti jeanbisutti removed the needs triage New issue that requires triage label Jan 5, 2024
@jeanbisutti
Copy link
Member Author

@Tejasker @zeitlinger Are you interested in doing it this week? If not, I could create a PR next Wednesday or next Thursday.

@Tejasker
Copy link

Tejasker commented Jan 8, 2024

@jeanbisutti, thanks for asking but I am new to open source, and while stumbling upon the large code base of open-telemetry either for front-end or other services, feels like much overwhelming. not exactly sure where to start but
I hope I can learn from your contribution✌️✌️.
Next time with the relativeness of your contribution I can move forward and will contribute 🤞🤞

@jeanbisutti
Copy link
Member Author

@Tejasker The conversion of Groovy tests to Java could be a good way to start contributing: #7195

@jaydeluca
Copy link
Member

@jeanbisutti if you haven't started this yet, I could take a shot at it

@jeanbisutti
Copy link
Member Author

@jeanbisutti if you haven't started this yet, I could take a shot at it

Not yet @jaydeluca. Great, don't hesitate to create a PR (even in draft) in the official documentation repo. I could have a look and provide feedback. Thanks!

@jaydeluca
Copy link
Member

@jeanbisutti I started a draft PR:
open-telemetry/opentelemetry.io#3758

I was unsure where to include the "Quickstart" instructions and the associated Dependency information. It seems like we want to distinguish between using the starter library and configuring everything separately, yes?

@jeanbisutti
Copy link
Member Author

@jeanbisutti I started a draft PR: open-telemetry/opentelemetry.io#3758

I was unsure where to include the "Quickstart" instructions and the associated Dependency information. It seems like we want to distinguish between using the starter library and configuring everything separately, yes?

@jaydeluca Thank you very much! By reading the new page, some sections could perhaps be moved to have on the same place the feature description and the necessary dependency. That may ease the reading. I will start to add comments to the draft PR.

@jaydeluca
Copy link
Member

@jeanbisutti I was thinking we could update the existing docs in this repo as well with some of the changes made to the documentation site updates.

  • Update default value of otel.exporter.otlp.endpoint to <http://localhost:4318>
  • Update default value of otel.exporter.otlp.protocol to http/protobuf

If you agree, I can make the changes (and anything else you think might be worth changing)

@jeanbisutti
Copy link
Member Author

@jeanbisutti I was thinking we could update the existing docs in this repo as well with some of the changes made to the documentation site updates.

  • Update default value of otel.exporter.otlp.endpoint to <http://localhost:4318>
  • Update default value of otel.exporter.otlp.protocol to http/protobuf

If you agree, I can make the changes (and anything else you think might be worth changing)

@jaydeluca The goal is to move the documentation of the readme files to the opentelemetry.io website. We could perhaps redirect to the website from the autoconfigure readme and the Zipkin starter readme, as we have done for the OpenTelemetry starter readme.

What do you think?

If you agree, don't hesitate to create a PR in this repo!

@jaydeluca
Copy link
Member

Sounds good @jeanbisutti, I will take care of this. I'll wait until after open-telemetry/opentelemetry.io#3911 is done since the links will change from that.

@jeanbisutti
Copy link
Member Author

Sounds good @jeanbisutti, I will take care of this. I'll wait until after open-telemetry/opentelemetry.io#3911 is done since the links will change from that.

@jaydeluca we've actually kept a single page for Spring Boot, see open-telemetry/opentelemetry.io#3985

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

No branches or pull requests

4 participants