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

Add /api-docs to make them easier to find #5190

Merged
merged 3 commits into from
Sep 16, 2024

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented Sep 13, 2024

This PR adds a top level /api-docs page that will simply list all the available API documentations available from the language SIGs. It's a convenience page, saving a few clicks, since I found myself multiple times to look for an API doc and then going docs.opentelemetry.io -> Languages -> that language -> API Docs

Preview: https://deploy-preview-5190--opentelemetry.netlify.app/api-docs/

@svrnm svrnm requested a review from a team September 13, 2024 10:06
@svrnm
Copy link
Member Author

svrnm commented Sep 13, 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.

Signed-off-by: svrnm <[email protected]>
@cartermp
Copy link
Contributor

@svrnm seems there's a build error somewhere

@svrnm svrnm added this pull request to the merge queue Sep 16, 2024
Merged via the queue into open-telemetry:main with commit d2204b1 Sep 16, 2024
17 checks passed
@svrnm svrnm deleted the add-top-level-api-docs branch September 16, 2024 07:34
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.

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

Successfully merging this pull request may close these issues.

4 participants