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

Move breaking changes to (or near) Upgrading Elasticsearch section #34251

Closed
ppf2 opened this issue Oct 2, 2018 · 6 comments
Closed

Move breaking changes to (or near) Upgrading Elasticsearch section #34251

ppf2 opened this issue Oct 2, 2018 · 6 comments
Labels
>docs General docs changes Team:Docs Meta label for docs team

Comments

@ppf2
Copy link
Member

ppf2 commented Oct 2, 2018

Somehow breaking changes section is ending up towards the very bottom of the table of contents for the Elasticsearch documentation.

image

Breaking changes is such an important section for upgrades. Let's move this back up towards the "Upgrade Elasticsearch" section, either as a section parallel to "Upgrade Elasticsearch", or as a subsection within "Upgrade Elasticsearch".

@ppf2 ppf2 added the >docs General docs changes label Oct 2, 2018
@colings86 colings86 added the :Docs label Oct 3, 2018
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@lcawl lcawl self-assigned this Oct 3, 2018
@lcawl
Copy link
Contributor

lcawl commented Oct 3, 2018

This was an intentional change in #33588 related to elastic/docs#382

@lcawl
Copy link
Contributor

lcawl commented Oct 3, 2018

I've verified that there's a link to the breaking changes in the "important" section of each of the following upgrade pages:
https://www.elastic.co/guide/en/logstash/master/upgrading-logstash.html
https://www.elastic.co/guide/en/elasticsearch/reference/master/setup-upgrade.html
https://www.elastic.co/guide/en/kibana/master/upgrade.html

If you have suggestions for other places to link from, though, let me know!

@ppf2
Copy link
Member Author

ppf2 commented Oct 3, 2018

Thanks @lcawl . While we are linking to breaking changes from https://www.elastic.co/guide/en/elasticsearch/reference/master/setup-upgrade.html and https://www.elastic.co/guide/en/elasticsearch/reference/master/release-highlights.html, as soon as the user starts clicking through the pages linked from these landing pages, they will no longer see the breaking changes link unless they go back to the main page (or scroll all the way down just to find the Breaking Changes section again).

It can be helpful to have the breaking changes section link be prominently displayed alongside "Upgrading ..." sections (below it), or as a subsection of "Upgrading ..." so that it is right there towards the top of the right navigation as a reminder regardless of what subpages they may end up on.

@debadair
Copy link
Contributor

[docs issue triage]

Related to ES reorg and general docs navigation. Leaving open for discussion.

@lcawl lcawl removed their assignment Feb 4, 2020
@rjernst rjernst added the Team:Docs Meta label for docs team label May 4, 2020
@jrodewig
Copy link
Contributor

We have some pending redesign and reorganization projects that will make this issue moot. Closing for now. We can re-open later if needed.

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
Projects
None yet
Development

No branches or pull requests

7 participants