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

Add navigation banner to "classic" docs #3039

Open
dedemorton opened this issue Jul 25, 2024 · 1 comment
Open

Add navigation banner to "classic" docs #3039

dedemorton opened this issue Jul 25, 2024 · 1 comment
Labels
asciidoc Asciidoc and our Asciidoctor extensions

Comments

@dedemorton
Copy link
Contributor

dedemorton commented Jul 25, 2024

Problem description

The serverless docs have a navigation banner that allows users to navigate back to the main docs landing page easily. The banner also has links to API and release docs:
image

The stateful docs do not have this banner. To navigate back to the main docs landing page, you need to click Elastic Docs in the breadcrumb trail.
image

Navigation is complicated by a couple of factors:

  • The product-level landing pages (such as https://www.elastic.co/guide/en/observability/current/index.html) do not have the breadcrumb trail because those pages live outside of the generated pages for the "book."
  • It's easy to accidentally trigger the Elastic site navigation when you try to click a link in the breadcrumb trail. This is super annoying because the popups are huge.

How to fix the problem

The fix for this problem is a quick win. We need to:

  • Add the navigation banner to the HTML template used by doc build.
  • Add the navigation banner to the product-level landing pages.
  • Add the required styles to the docs CSS.
  • For consistency, rename the breadcrumb text "Elastic Docs" to "Documentation" (or remove it)

Benefits of fixing this problem:

  • Navigation across all doc pages is more consistent.
  • Navigation back to the main docs landing page is easier.
  • Links to the API and release docs appear on every page in the docs.
  • Breadcrumb trail appears further down on the page and does not interfere with the site navigation.
@dedemorton dedemorton added the asciidoc Asciidoc and our Asciidoctor extensions label Jul 25, 2024
@dedemorton
Copy link
Contributor Author

dedemorton commented Jul 29, 2024

For consistency, rename the breadcrumb text "Elastic Docs" to "Documentation" (or remove it)

Correction, we should use the home icon. While we have the file open, we might also want to change the breadcrumb separator from > go /.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
asciidoc Asciidoc and our Asciidoctor extensions
Projects
None yet
Development

No branches or pull requests

1 participant