-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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
REST API compatiblity documentation #83487
Conversation
Pinging @elastic/es-docs (Team:Docs) |
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.
I added some editorial suggestions & tried to streamline this a bit.
Let me know if you have questions!
docs/reference/upgrade.asciidoc
Outdated
@@ -5,12 +5,12 @@ | |||
-- | |||
ifeval::["{release-state}"!="released"] | |||
[[upgrade-pre-release]] | |||
IMPORTANT: This documentation is for a pre-release of {es} {minor-version}. | |||
IMPORTANT: This documentation is for a pre-release of {es} {minor-version}. |
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.
I've got changes to this topic in flight. Revert these & I'll add the compatibility info where needed. (And link to the new topic.)
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.
The whitespace changes were accidental and have been removed from the PR. Did you mean just the white space or the entire file ?
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
@elasticmachine run elasticsearch-ci/docs |
This reverts commit e51189b.
"application/vnd.elasticsearch+smile;compatible-with=7" | ||
"application/vnd.elasticsearch+cbor;compatible-with=7" | ||
------------------------------------------------------------ | ||
The [link:/guide](https://www.elastic.co/guide/en/elasticsearch/client/index.html)[officially supported {es} clients] |
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.
@debadair - can you help out again with this link the build still claims this as broken:
13:02:16 INFO:build_docs: /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/master/rest-api-compatibility.html contains broken links to:
13:02:16 INFO:build_docs: - en/elasticsearch/client/index.html)
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.
Left a suggestion that should fix the link.
Co-authored-by: debadair <debadair@elastic.co>
Thank you @debadair - your edits were really good ! |
Co-authored-by: debadair <debadair@elastic.co>
Co-authored-by: debadair <debadair@elastic.co>
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.
LGTM, sorry for the delay
* REST API compatiblity documentation (#83487) Co-authored-by: debadair <debadair@elastic.co> * Switch xrefs to external links Co-authored-by: debadair <debadair@elastic.co> Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
We reuse our breaking changes in the [Elastic Installation and Upgrade Guide](https://www.elastic.co/guide/en/elastic-stack/current/index.html). To prevent broken links, we have to use external links rather than xrefs inside breaking changes. Relates to #83487.
We reuse our breaking changes in the [Elastic Installation and Upgrade Guide](https://www.elastic.co/guide/en/elastic-stack/current/index.html). To prevent broken links, we have to use external links rather than xrefs inside breaking changes. Relates to #83487. (cherry picked from commit 02ea65a)
related: #51816
Preview
https://elasticsearch_83487.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/rest-api-compatibility.html
https://elasticsearch_83487.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/migrating-8.0.html#breaking_80_rest_api_changes
https://elasticsearch_83487.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/setup-upgrade.html