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

[DOCS] Add collapsible sections to 8.0 breaking changes [Part 2] #55862

Merged
merged 3 commits into from
May 5, 2020
Merged

[DOCS] Add collapsible sections to 8.0 breaking changes [Part 2] #55862

merged 3 commits into from
May 5, 2020

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Apr 28, 2020

Adds collapsible sections to the 8.0 breaking changes.

To make reviews easier and avoid introducing errors, I've
tried to limit my changes to formatting, with the exception
of rewording heading as sentences.

I'm also splitting this effort over several PRs to make reviews
manageable.

Relates to #55629 and #53229

Preview

http://elasticsearch_55862.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/breaking-changes-8.0.html

@jrodewig jrodewig added >docs General docs changes :Docs v8.0.0 labels Apr 28, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>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.

Suggested some changes. If you opt to lead with the recommended action in the Impact sections, the change should be made throughout.

*Impact* +
To avoid errors, discontinue use of the `POST
/_cluster/voting_config_exclusions/{node_filter}` API endpoint.
Use `POST /_cluster/voting_config_exclusions?node_ids=...` instead.
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd be inclined to flip this around to lead with what you should do:

Use POST /_cluster/voting_config_exclusions?node_ids=... and specify the nodes to exclude instead of using a node filter. Submitting requests to the /_cluster/voting_config_exclusions/{node_filter}` endpoint will throw an error.

@@ -37,3 +39,7 @@ are no longer supported. In particular, this includes:
- `discovery.zen.master_election.wait_for_joins_timeout`
- `discovery.zen.master_election.ignore_non_master_pings`
- `discovery.zen.publish.max_pending_cluster_states`

*Impact* +
To avoid errors, unset and discontinue use of any `discovery.zen.` settings.
Copy link
Contributor

Choose a reason for hiding this comment

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

"unset and discontinue use" seems redundant. Again, I'd lead with the recommended action, something like:

Discontinue using the discovery.zen settings. Specifying these settings in elasticsearch.yml will result in an error on startup.

[float]
==== Removal of types
*Impact* +
To avoid errors, use no more than 10 completion contexts within a single
Copy link
Contributor

Choose a reason for hiding this comment

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

As above (if you go that route):

Use a maximum of 10 completion contexts in a completion field. Specifying more than 10 completions context will throw an error.

Same applies to the other impact sections.

@jrodewig
Copy link
Contributor Author

jrodewig commented May 4, 2020

Thanks for the suggestions @debadair. I cleaned up the impact sentences with 89fd9e2 and 5fb4229. I'll do something similar in #55811.

@jrodewig jrodewig requested a review from debadair May 4, 2020 19:36
@rjernst rjernst added the Team:Docs Meta label for docs team label May 4, 2020
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.

LGTM

@jrodewig jrodewig merged commit e3e1e3e into elastic:master May 5, 2020
@jrodewig jrodewig deleted the docs__collapse-breaking-changes-pt-2 branch May 5, 2020 13:44
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-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants