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 deprecation docs for cluster health HTTP code #79451

Conversation

DaveCTurner
Copy link
Contributor

@DaveCTurner DaveCTurner commented Oct 19, 2021

Documents the deprecation introduced in #78180 and adjusted in #79351.

@DaveCTurner DaveCTurner added >docs General docs changes :Distributed Indexing/Distributed A catch all label for anything in the Distributed Area. Please avoid if you can. v7.16.1 labels Oct 19, 2021
@DaveCTurner DaveCTurner requested a review from arteam October 19, 2021 11:25
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. labels Oct 19, 2021
@elasticmachine
Copy link
Collaborator

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

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@DaveCTurner
Copy link
Contributor Author

We should really have added this in #78940.

Documents the deprecation introduced in elastic#78180 and adjusted in elastic#79351.
@DaveCTurner DaveCTurner force-pushed the 2021-10-19-return_200_for_cluster_health_timeout-deprecation-docs branch from 8d644fc to b123408 Compare October 19, 2021 11:30
@arteam
Copy link
Contributor

arteam commented Oct 19, 2021

That's is amazing, thank you very much, David!

[%collapsible]
====
*Details* +
The <<cluster-health>> API includes options for waiting for certain health
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Drive-by comment: We can't use internal links (<<blah>>) in the migration guide. This will break when we reuse the docs in the Install and Upgrade Guide. We need to use external links instead.

Suggested change
The <<cluster-health>> API includes options for waiting for certain health
The {ref}/cluster-health.html[cluster health API] includes options for waiting for certain health

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bah I clicked the button without seeing this, ok I'll fix

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Sorry for commenting so late! Thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened #79486 suggesting that this should fail the build.

@DaveCTurner DaveCTurner merged commit 9184b4c into elastic:7.x Oct 19, 2021
@DaveCTurner DaveCTurner deleted the 2021-10-19-return_200_for_cluster_health_timeout-deprecation-docs branch October 19, 2021 15:12
DaveCTurner added a commit to DaveCTurner/elasticsearch that referenced this pull request Oct 19, 2021
In elastic#79451 we introduced an internal link in the migration guide, but
this has to be an external link so that these docs can be re-used in the
stack-wide guide too. This fixes that oversight.
DaveCTurner added a commit that referenced this pull request Oct 19, 2021
In #79451 we introduced an internal link in the migration guide, but
this has to be an external link so that these docs can be re-used in the
stack-wide guide too. This fixes that oversight.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Indexing/Distributed A catch all label for anything in the Distributed Area. Please avoid if you can. >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v7.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants