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

REST API compatiblity documentation #83487

Merged
merged 30 commits into from
Feb 4, 2022

Conversation

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link
Contributor

@debadair debadair left a 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/rest-api/rest-api-compatibility.asciidoc Outdated Show resolved Hide resolved
docs/reference/rest-api/rest-api-compatibility.asciidoc Outdated Show resolved Hide resolved
docs/reference/rest-api/rest-api-compatibility.asciidoc Outdated Show resolved Hide resolved
docs/reference/rest-api/rest-api-compatibility.asciidoc Outdated Show resolved Hide resolved
@@ -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}.
Copy link
Contributor

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.)

Copy link
Contributor Author

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 ?

jakelandis and others added 14 commits February 4, 2022 11:17
@jakelandis
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/docs

"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]
Copy link
Contributor Author

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)

Copy link
Contributor

@debadair debadair left a 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.

docs/reference/rest-api/rest-api-compatibility.asciidoc Outdated Show resolved Hide resolved
@jakelandis
Copy link
Contributor Author

Thank you @debadair - your edits were really good !

@jakelandis jakelandis merged commit 5c73ad1 into elastic:master Feb 4, 2022
@jakelandis jakelandis deleted the compat_rest_api_doc branch February 4, 2022 22:32
jakelandis added a commit to jakelandis/elasticsearch that referenced this pull request Feb 4, 2022
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.0
8.1

jakelandis added a commit to jakelandis/elasticsearch that referenced this pull request Feb 4, 2022
elasticsearchmachine pushed a commit that referenced this pull request Feb 4, 2022
Copy link
Contributor

@pgomulka pgomulka left a 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

elasticsearchmachine pushed a commit that referenced this pull request Feb 7, 2022
* REST API compatiblity documentation (#83487)

Co-authored-by: debadair <[email protected]>

* Switch xrefs to external links

Co-authored-by: debadair <[email protected]>
Co-authored-by: James Rodewig <[email protected]>
jrodewig added a commit that referenced this pull request Feb 7, 2022
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.
elasticsearchmachine pushed a commit that referenced this pull request Feb 7, 2022
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)
jrodewig added a commit that referenced this pull request Feb 8, 2022
Adds a release highlight for the 7.x REST API compatibility headers.

Relates to #51816 and #83487
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Team:Docs Meta label for docs team v8.0.0 v8.0.1 v8.1.0 v8.1.1 v8.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants