-
Notifications
You must be signed in to change notification settings - Fork 108
Adds links that point to the API contrib guidelines to repo docs #5131
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
Conversation
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 |
Co-authored-by: Quentin Pradet <[email protected]>
…ic/elasticsearch-specification into szabosteve/update-docs-guide-links
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Since our contribution guide is already "CONTRIBUTING.md", I've tried to use a consistent but precise name for the new docs.
Co-authored-by: Quentin Pradet <[email protected]>
* Adds links that point to the API contrib guidelines to repo docs. * Apply suggestions from code review Co-authored-by: Quentin Pradet <[email protected]> * Addresses feedback. * Apply suggestions from code review Co-authored-by: Quentin Pradet <[email protected]> --------- Co-authored-by: Quentin Pradet <[email protected]> (cherry picked from commit cdadc11)
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.0 9.0
# Navigate to the new working tree
cd .worktrees/backport-9.0
# Create a new branch
git switch --create backport-5131-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 cdadc11ed3066e320241418f50500abdef24938e
# Push it to GitHub
git push --set-upstream origin backport-5131-to-9.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.0 Then, create a pull request where the |
* Adds links that point to the API contrib guidelines to repo docs. * Apply suggestions from code review Co-authored-by: Quentin Pradet <[email protected]> * Addresses feedback. * Apply suggestions from code review Co-authored-by: Quentin Pradet <[email protected]> --------- Co-authored-by: Quentin Pradet <[email protected]> (cherry picked from commit cdadc11)
…) (#5162) * Adds links that point to the API contrib guidelines to repo docs. * Apply suggestions from code review * Addresses feedback. * Apply suggestions from code review --------- (cherry picked from commit cdadc11) Co-authored-by: István Zoltán Szabó <[email protected]> Co-authored-by: Quentin Pradet <[email protected]>
…) (#5161) * Adds links that point to the API contrib guidelines to repo docs. * Apply suggestions from code review * Addresses feedback. * Apply suggestions from code review --------- (cherry picked from commit cdadc11) Co-authored-by: István Zoltán Szabó <[email protected]> Co-authored-by: Quentin Pradet <[email protected]>
* Adds links that point to the API contrib guidelines to repo docs. * Apply suggestions from code review Co-authored-by: Quentin Pradet <[email protected]> * Addresses feedback. * Apply suggestions from code review Co-authored-by: Quentin Pradet <[email protected]> --------- Co-authored-by: Quentin Pradet <[email protected]>
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-specification
repo relates to defining API endpoints, linking to these guidelines provides helpful context for those who want to contribute to API docs.