Skip to content

Restore /guide navigation experience in Reference section of /docs #1644

Open
@KOTungseth

Description

@KOTungseth

Description

We have received feedback that the new goal-based structure makes it difficult for users who are accustomed to the /guide product-based navigation.

The reorganization around user tasks rather than products has disrupted how many users search for and consume documentation.

For example, users managing specific clusters or studying for certifications struggle to find the right documentation.

Solution

Restore a familiar experience by replicating the elastic.co/guide/index.html structure at elastic.co/docs/reference, mirroring the navigation used in versions 8.18 and earlier.

Proposed tasks

  • Create a dedicated Elastic APIs page
  • Pull the following into Elasticsearch:
    - Text analysis: Built in analyzer, Tokenizer, Token filter, Characters filter, Normalizers
    - Ingest processor
    - Query DSL
    - Aggregations
    - Search connectors
    - Search UI
    - EQL
    - ES|QL
    - SQL
  • Pull Infrastructure app metrics reference content into Elastic Observability section
  • Pull Kibana Query Language and Canvas functions into Kibana section
  • Create a new Machine learning page and pull in the following:
    - Supplied configurations
    - Analysis functions
  • Pull all Logstash content into a dedicated Logstash section
  • Reorganize the Reference landing page to replicate the /guide docs landing page

Landing page restructure

Elasticsearch
Elasticsearch reference
Elasticsearch APIs
Elasticsearch Serverless APIs
Elasticsearch Clients
Elasticsearch for Apache Hadoop
Curator Index Management
Painless scripting language
Elasticsearch plugins

Elastic Observability
Elastic Observability reference
Elastic Distributions of OpenTelemetry (EDOT)
APM
APM Server APIs
Observability intake Serverless APIs

Elastic Security
Elastic Security reference
Elastic Security APIs

Elastic Stack
Elastic Common Schema (ECS)
Kibana
Kibana APIs
Kibana Serverless APIs
Machine learning (new page)

Ingest
Fleet and Elastic Agent
Elastic integrations
Logstash
Logstash APIs
Logstash Plugins
Logstash Versioned Plugins
Beats
Auditbeat
Filebeat
Heartbeat
Metricbeat
Packetbeat
Winlogbeat
Elastic logging plugin for Docker
Elastic Serverless Forwarder for AWS

Cloud
Elastic Cloud Hosted
Elastic Cloud Hosted APIs
Elastic Cloud Serverless APIs
Elastic Cloud Enterprise
Elastic Cloud Enterprise APIs
Elastic Cloud on Kubernetes
Elastic Cloud on Kubernetes APIs
Elastic Cloud billing APIs
Elastic Cloud Control (ECCTL)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:ProjectsIssues owned by the Docs OrgenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions