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] Breaking changes docs are difficult to use #53229

Closed
3 of 5 tasks
jrodewig opened this issue Mar 6, 2020 · 2 comments
Closed
3 of 5 tasks

[DOCS] Breaking changes docs are difficult to use #53229

jrodewig opened this issue Mar 6, 2020 · 2 comments
Assignees
Labels
Team:Docs Meta label for docs team

Comments

@jrodewig
Copy link
Contributor

jrodewig commented Mar 6, 2020

Several users have notes that the Elasticsearch breaking changes is hard-to-digest and difficult to use.

Running list of issues

Next steps

The @esdocs team should explore a new template and/or layout for breaking changes to address some of these issues.

CC @zuketo

@jrodewig jrodewig added the :Docs label Mar 6, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (:Docs)

@jrodewig
Copy link
Contributor Author

jrodewig commented May 12, 2020

With #55629, we creatieda collapsible template for breaking docs that includes an Impact section for solutions/workarounds.

This should make it possible for us to keep breaking changes an a single page starting in 8.x. It should also make labelling easier.

Closing this ticket for now. We can re-open if further improvements or iterations are needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Team:Docs Meta label for docs team
Projects
None yet
Development

No branches or pull requests

3 participants