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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Add collapsible sections to 7.8 breaking changes #55334

Merged
merged 5 commits into from
Apr 22, 2020
Merged

[DOCS] Add collapsible sections to 7.8 breaking changes #55334

merged 5 commits into from
Apr 22, 2020

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Apr 16, 2020 •
edited
Loading

Adds collapsible sections and new format to the 7.8 breaking changes.

Relates to #53229.

Goals

  • Avoid a "wall of text." Let users quickly scan a list of changes to see what's applicable to them.
  • Add progressive disclosure, allowing users to get more details only if wanted.
  • Add an optional How to migrate section for documenting solutions/workarounds.

Out of scope

  • Changing the topic/grouping labels
  • Moving all breaking changes for versions within a major (7.x, 8.x, etc.) onto the same page.

However, we'll want to investigate these ideas more as part of #53229

Preview: http://elasticsearch_55334.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/7.x/breaking-changes-7.8.html

@jrodewig jrodewig added >docs General docs changes :Docs labels Apr 16, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (:Docs)

@jrodewig
Copy link
Contributor Author

If approved, I can make similar changes to the 8.0 breaking changes as part of another PR.

@jrodewig jrodewig requested a review from lcawl April 16, 2020 19:49
szabosteve
szabosteve approved these changes Apr 17, 2020
View reviewed changes
Copy link
Contributor

@szabosteve szabosteve left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

debadair
debadair approved these changes Apr 21, 2020
View reviewed changes
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

lcawl
lcawl approved these changes Apr 21, 2020
View reviewed changes
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@jrodewig
Copy link
Contributor Author

Thanks all!

@jrodewig jrodewig merged commit 8d05d7d into elastic:7.x Apr 22, 2020
@jrodewig jrodewig deleted the docs__add-collapsible-sections-breaking-changes branch April 22, 2020 14:56
@jrodewig jrodewig changed the title [DOCS] Add collapsible sections to 7.x breaking changes [DOCS] Add collapsible sections to 7.8 breaking changes Apr 22, 2020
@jrodewig jrodewig mentioned this pull request Apr 22, 2020
Closed
25 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lcawl lcawl lcawl approved these changes

@szabosteve szabosteve szabosteve approved these changes

@debadair debadair debadair approved these changes

@zuketo zuketo Awaiting requested review from zuketo

Assignees
No one assigned
Labels
>docs General docs changes v7.8.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jrodewig @elasticmachine @debadair @szabosteve @lcawl