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

Reorganize Spring Boot content #4554

Merged
merged 31 commits into from
May 30, 2024

Conversation

jeanbisutti
Copy link
Member

@jeanbisutti jeanbisutti commented May 28, 2024

This PR reorganizes the Spring Boot content following the discussions in #4324.

Further improvements could certainly be made to the Spring Boot content. This PR focuses on the reorganization discussed in #4324.

Preview: https://deploy-preview-4554--opentelemetry.netlify.app/docs/zero-code/java/spring-boot-starter/

Fix #4324

@jeanbisutti jeanbisutti requested review from a team May 28, 2024 15:03
@jeanbisutti jeanbisutti marked this pull request as draft May 28, 2024 16:31
@jeanbisutti
Copy link
Member Author

/fix:format

@opentelemetrybot
Copy link
Collaborator

@jeanbisutti jeanbisutti reopened this May 29, 2024
@jeanbisutti jeanbisutti force-pushed the spring-boot-reorganization branch from e4df8ec to 423e491 Compare May 29, 2024 09:11
@jeanbisutti jeanbisutti marked this pull request as ready for review May 29, 2024 09:22
@jeanbisutti
Copy link
Member Author

/fix:format

@opentelemetrybot
Copy link
Collaborator

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.

Hmm, the page org isn't quite working -- e.g., if there's a starter section then it needs an index page. But before making that change, consider this question: will there ever be content under content/en/docs/zero-code/java/spring-boot other than for the SB Starter? If not, how about renaming the folder to content/en/docs/zero-code/java/spring-boot-start.

Even if there is, maybe what we want is:

docs/zero-code/java
  - agent
  - spring-boot
  - spring-boot-starter

I recall that we had started discussing such options elsewhere. I guess that now's the time to come to a consensus.

@chalin
Copy link
Contributor

chalin commented May 29, 2024

@jeanbisutti - please resolve conflicts by rebasing.

@jeanbisutti jeanbisutti force-pushed the spring-boot-reorganization branch from ecf8c0e to 056fd13 Compare May 29, 2024 11:51
@jeanbisutti
Copy link
Member Author

@chalin

I have rebased.

will there ever be content under content/en/docs/zero-code/java/spring-boot other than for the SB Starter? If not, how about renaming the folder to content/en/docs/zero-code/java/spring-boot-start.

I don't think we will have content under content/en/docs/zero-code/java/spring-boot other than for the Spring Boot starter.

So, I agree to rename the folder, which would reflect the new menu content:

image

The new folder name would be content/en/docs/zero-code/java/spring-boot-start or content/en/docs/zero-code/java/spring-boot-starter?

@zeitlinger @svrnm WDYT?

@zeitlinger
Copy link
Member

@zeitlinger @svrnm WDYT?

/docs/zero-code/java/spring-boot-start/getting-started/ or /docs/zero-code/java/spring-boot-starter/getting-started/ sounds good

@jeanbisutti
Copy link
Member Author

/fix:format

@opentelemetrybot
Copy link
Collaborator

@jeanbisutti
Copy link
Member Author

/fix:all

@opentelemetrybot
Copy link
Collaborator

@jeanbisutti
Copy link
Member Author

/fix:all

@opentelemetrybot
Copy link
Collaborator

@jeanbisutti
Copy link
Member Author

/fix:all

@opentelemetrybot
Copy link
Collaborator

@cartermp cartermp merged commit 90da157 into open-telemetry:main May 30, 2024
15 checks passed
@chalin chalin mentioned this pull request May 30, 2024
@chalin
Copy link
Contributor

chalin commented May 30, 2024

Cross-reference to my comments about this PR: #4562 (comment).

---

The OpenTelemetry Spring Boot starter provides of the box
instrumentation](../out-of-the-box-instrumentation) that you can complete with
Copy link
Contributor

Choose a reason for hiding this comment

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

The link syntax is invalid here.

---
title: Annotations
description: Using instrumentation annotations with the Spring starter.
aliases: [../annotations]
Copy link
Contributor

Choose a reason for hiding this comment

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

There shouldn't be this alias here.

---
title: Out of the box instrumentation
description: Out of the box instrumentation for the starter
aliases: [../annotations]
Copy link
Contributor

Choose a reason for hiding this comment

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

There shouldn't be this alias here either. I'm curious what you had in mind @jeanbisutti, what were you trying to acheive?

@zeitlinger zeitlinger deleted the spring-boot-reorganization branch May 31, 2024 07:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reorganize spring boot starter page
5 participants