-
Notifications
You must be signed in to change notification settings - Fork 889
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
Comments
@zeitlinger Could you please add the |
let's do this after #9950 |
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. |
@Tejasker @zeitlinger Are you interested in doing it this week? If not, I could create a PR next Wednesday or next Thursday. |
@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 |
@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! |
@jeanbisutti I started a draft PR: 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. |
@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.
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! |
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 |
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
The text was updated successfully, but these errors were encountered: