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] Split the page Fix common cluster issues into separate pages #85610

Closed
alaudazzi opened this issue Apr 1, 2022 · 3 comments · Fixed by #88495
Closed

[DOCS] Split the page Fix common cluster issues into separate pages #85610

alaudazzi opened this issue Apr 1, 2022 · 3 comments · Fixed by #88495
Assignees
Labels
>docs General docs changes Team:Docs Meta label for docs team

Comments

@alaudazzi
Copy link
Contributor

alaudazzi commented Apr 1, 2022

The page Fix common cluster issues is one of the troubleshooting links that are going to be created on the deployment health banner to link error messages to relevant doc pages.

This page is too long and requires lots of scrolling. We can get a better user experience if we:

  • link from the UI to the specific sections of this page
    or
  • split the page into separate pages (better for SEO)

CC @debadair

Relates to https://github.com/elastic/cloud/issues/92183

@alaudazzi alaudazzi added >docs General docs changes Team:Docs Meta label for docs team labels Apr 1, 2022
@elasticmachine
Copy link
Collaborator

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

@debadair
Copy link
Contributor

Discussed with @alaudazzi. While there is a benefit to being able to see all the issues in one place, one large page is less than optimal for cross referencing a specific item as well as SEO. Plan is to create separate topics/pages for each entry, and include those individual entries on the main troubleshooting page. We can exclude the invidual pages from the TOC so that they do not appear twice.

@debadair debadair changed the title Split the page Fix common cluster issues into separate pages [DOCS] Split the page Fix common cluster issues into separate pages Apr 27, 2022
@kilfoyle
Copy link
Contributor

kilfoyle commented Apr 28, 2022

When the "Common cluster issues" page is split up, will the following URL still be available? Perhaps it could be retained as a parent to the soon to come sub-pages?
https://www.elastic.co/guide/en/elasticsearch/reference/current/fix-common-cluster-issues.html

The Cloud API has a hardcoded link to that page. It was added recently via https://github.com/elastic/cloud/pull/101302

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

Successfully merging a pull request may close this issue.

5 participants