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

[demo] Add Cart service exemplars doc #5788

Merged

Conversation

julianocosta89
Copy link
Member

This PR adds documentation to the Exemplars added to the Cart service in the Demo.

It depends on the following issues to be merged:

@julianocosta89 julianocosta89 requested a review from a team as a code owner December 13, 2024 12:48
@opentelemetrybot opentelemetrybot requested a review from a team December 13, 2024 12:48
@julianocosta89
Copy link
Member Author

npm run fix:htmltest-config is not changing anything 🤔

Copy link
Contributor

@puckpuck puckpuck left a comment

Choose a reason for hiding this comment

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

One grammar nitpick, but this looks great otherwise.

@opentelemetrybot opentelemetrybot requested a review from a team December 14, 2024 07:47
@julianocosta89
Copy link
Member Author

I need to update the screenshot based on @puckpuck's change in the Dashboard

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.

Since the image is specific to the cart service, I suggest the following:

  • Create content/en/docs/demo/services/cart/
  • Move and rename content/en/docs/demo/services/cart.md to content/en/docs/demo/services/cart/index.md
  • Move and rename content/en/docs/demo/screenshots/cart-service-exemplars.png to content/en/docs/demo/services/cart/exemplars.png
  • Adjust the in-page link to the image: ![Cart Service Exemplars](exemplars.png)

/cc @svrnm

@julianocosta89
Copy link
Member Author

@chalin thanks for the suggestions.
I've applied it, updated the screenshot and improved the grammar.
This should be good to go 🚀

@chalin
Copy link
Contributor

chalin commented Dec 16, 2024

/fix:refcache

@opentelemetrybot
Copy link
Collaborator

You triggered fix:refcache action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/12353560584

@opentelemetrybot
Copy link
Collaborator

fix:refcache was successful.

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

@chalin
Copy link
Contributor

chalin commented Dec 16, 2024

/fix:all

@opentelemetrybot
Copy link
Collaborator

@opentelemetrybot
Copy link
Collaborator

fix:all was successful.

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

@chalin chalin force-pushed the demo/add-cart-service-exemplars-doc branch from 1f0edfa to db5e629 Compare December 16, 2024 14:14
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.

I won't have time to do a detailed review of the prose, but overall LGTM, as does the PR structure.

@chalin
Copy link
Contributor

chalin commented Dec 16, 2024

We have all necessary approvals. Merging.

@chalin chalin merged commit 266e739 into open-telemetry:main Dec 16, 2024
17 checks passed
@julianocosta89 julianocosta89 deleted the demo/add-cart-service-exemplars-doc branch December 16, 2024 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants