Adds links that point to the API contrib guidelines to repo docs #5131
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Following you can find the validation changes against the target branch for the APIs. No changes detected. You can validate these APIs yourself by using the |
pquentin
reviewed
Aug 12, 2025
Co-authored-by: Quentin Pradet <[email protected]>
…ic/elasticsearch-specification into szabosteve/update-docs-guide-links
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR adds links throughout the repository to the new API docs contribution guidelines. These guidelines serve as the source of truth for creating API documentation, consolidating accurate and up-to-date information from various sources (Confluence pages and internal documents).
Since most of the content in the
elasticsearch-specificationrepo relates to defining API endpoints, linking to these guidelines provides helpful context for those who want to contribute to API docs.