Skip to content

Add search/query pages#3094

Draft
leemthompo wants to merge 5 commits intonav-v2from
leemthompo/search-query-nav
Draft

Add search/query pages#3094
leemthompo wants to merge 5 commits intonav-v2from
leemthompo/search-query-nav

Conversation

@leemthompo
Copy link
Copy Markdown
Member

WIP

@leemthompo leemthompo self-assigned this Apr 13, 2026
@leemthompo leemthompo added the documentation Improvements or additions to documentation label Apr 13, 2026
theletterf added a commit that referenced this pull request May 8, 2026
* Wire most of nav v1 content into nav v2

Closes 93% of the gap between nav v1 (config/navigation.yml + .artifacts
toc.yml graph) and nav v2 (config/navigation-v2.yml): 2,733 → 181 missing
pages.

- Re-enabled the commented Reference block (~1,222 pages: elasticsearch,
  kibana, cloud, ECS, search-ui, ECCTL, plus aggregations, query-languages,
  scripting, enrich-processor, text-analysis).
- Ported the per-product release notes tree from v1 (~126 pages: cloud
  hosted/enterprise, cloud-on-k8s, all APM agents, all EDOT SDKs, beats,
  logstash, elastic-agent, fleet-server, ECS, ECCTL, security, observability,
  serverless).
- Added per-product reference tocs grouped by family (~777 pages: ES clients,
  APM, OpenTelemetry/EDOT, ECS Logging) plus elasticsearch-plugins and
  community-contributed.
- Wired children of 12 deploy-manage landings (security, users-roles,
  monitor, tools, remote-clusters, upgrade, cloud-organization, maintenance,
  api-keys, autoscaling, license, uninstall) using hand-listed children to
  preserve the curated v2 group titles (~369 pages).
- Removed the dead Troubleshoot comment block (already covered by
  - toc: docs-content://troubleshoot).
- Brought in Liam's Search and query rewrite from PR #3094.

Co-Authored-By: Liam Thompson <leemthompo@gmail.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* Wire missing observability pages into nav v2

Adds the 10 observability pages that v1 surfaces but v2 was missing,
slotted next to their existing siblings to preserve v2's curated order:

- APM > View and analyze data: discover-traces.md (between Drill down into
  data and Filter and search data, mirroring v1).
- OpenTelemetry use cases: llms/index.md as a sibling of Kubernetes
  observability under Get started.
- Streams > Process documents: concat, join, lowercase, uppercase, trim,
  redact, network-direction processors (appended after existing string-op
  processors, before manual-pipeline-configuration).
- Streams: streamlang.md as a sibling of Process documents.

Also fixes a counting bug in the offline diff script — it now honors the
`folder:` keyword in toc.yml, which removed ~75 false-positive "missing"
pages caused by treating apm-server filenames as living at solutions/ root.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* Wire Production guidance children into nav v2

Per Shaina, the remaining Deploy and manage misses sit under the two
existing production-guidance landings. Converts those flat entries into
groups and lists their canonical children from v1's deploy-manage toc:

- Run Elasticsearch in production
  - Design for resilience (3 children: small clusters, larger clusters,
    ECH and ECE)
  - Scaling considerations
  - Performance optimizations (6 children: general recommendations,
    indexing speed, search speed, approximate kNN, disk usage, size shards)
- Run Kibana in production
  - High availability and load balancing, configure memory, manage
    background tasks, traffic scaling, alerting, reporting (6 children)

18 pages recovered. Gap: 151 → 133.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* Wire remaining D&M, ingest architectures, and Contribute island

Closes the rest of the actionable gap (133 → 68; the 50 remaining are
explore-analyze pages intentionally left for separate IA work):

- Distributed architecture: converts three flat entries into groups with
  canonical children — clusters-nodes-shards (node-roles),
  shard-allocation-relocation-recovery (shard-allocation-awareness +
  index-level-shard-allocation with delaying-allocation-when-node-leaves),
  and discovery-cluster-formation (6 children: hosts-providers, quorums,
  voting, bootstrap-cluster, cluster-state, cluster-fault-detection).
- Deploy orchestrators: adds deploy-an-orchestrator.md as a peer page
  under Elastic Cloud Enterprise, and as the landing of the existing
  "Deploy an orchestrator" group under Elastic Cloud on Kubernetes
  (with install.md demoted to first child to match v1 hierarchy).
- Ingest architectures: converts the leaf entry into a group with the
  canonical 16 children grouped by architecture (Agent to Elasticsearch,
  Agent with Logstash, Agent with Kafka, Air-gapped, Logstash as input,
  Agent through a proxy). Sets ingesting-data-for-elastic-solutions.md
  as the "Ingest by solution" group landing. Surfaces tools.md alongside
  the existing API/upload entries.
- Contribute: new isolated section pulling docs-content://contribute-docs
  via toc, mirroring the Extension points pattern. Surfaces all 35
  contribute-docs pages (api-docs, content-types, how-to, style-guide,
  plus the standalone guides) without disturbing the main top-bar layout.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* Disable contribute-docs island pending decision

Comments out the new isolated Contribute section we added in the previous
commit. Whether to surface contribute-docs in the public site is still
open, so keep the entry as a ready-to-uncomment block rather than a
shipped section. The toc graph is unchanged; only the v2 surface is.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* fixes

* Replace remaining {{templated}} group labels in nav titles

Eight `- group:` labels still contained `{{...}}` substitutions after
Shaina's fix pass — `{{apm-server}}` (2), `{{aws}}` (2), and
`{{elastic-defend}}` (4). The nav-v2 renderer does not expand these,
so they showed up literally in the sidebar. Replaced with their
canonical expansions per docs-content/docset.yml::features:
- {{apm-server}} -> APM Server
- {{aws}} -> AWS
- {{elastic-defend}} -> Elastic Defend

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Liam Thompson <leemthompo@gmail.com>
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-authored-by: shainaraskas <shaina.raskas@elastic.co>
theletterf added a commit that referenced this pull request May 8, 2026
Backports the YAML fill from demo/findability (PR #3268). Pure additions
to config/navigation-v2.yml within the existing structure — no schema
changes, no new directives. Closes most of the gap between v1 nav and
the nav-v2 prototype.

- Re-enable the commented Reference label and expand it: docs-content
  reference (top-level fanout), elasticsearch core/plugins/community-
  contributed, kibana, Cloud (cloud + cloud-on-k8s), Elasticsearch
  clients (java/js/dsl-js/.net/php/py/ruby/rs, eland, go-elasticsearch,
  curator), APM (k8s-attacher, aws-lambda, all agent libs), OpenTelemetry
  (opentelemetry root + motlp + edot-cloud-forwarder for AWS/Azure/GCP,
  edot-collector, all EDOT SDKs), ECS Logging (root + all per-language
  libs), beats, logstash, integration-docs, elasticsearch-hadoop,
  elastic-serverless-forwarder, ecs, search-ui, ecctl, plus
  aggregations/enrich-processor/query-languages/scripting-languages/
  text-analysis. ~1,200 pages.

- Wire children of 12 deploy-manage landings (security, users-roles,
  monitor, tools, remote-clusters, upgrade, cloud-organization,
  maintenance, api-keys, autoscaling, license, uninstall) under each
  existing `- group:` to preserve curated titles. ~370 pages.

- Convert distributed-architecture leaf entries into groups with
  canonical children: clusters-nodes-shards (node-roles),
  shard-allocation-relocation-recovery (shard-allocation-awareness +
  index-level-shard-allocation w/ delaying-allocation-when-node-leaves),
  discovery-cluster-formation (6 children).

- Convert production-guidance leaf entries into groups with their
  full canonical structure: Run Elasticsearch in production (Design
  for resilience [3 children], Scaling considerations, Performance
  optimizations [6 children]); Run Kibana in production (6 children).

- Convert ingest-reference-architectures leaf into a group with the
  16 canonical children grouped by architecture (Agent to Elasticsearch,
  Agent with Logstash, Agent with Kafka, Air-gapped, Logstash as input,
  Agent through a proxy). Set ingesting-data-for-elastic-solutions.md
  as the "Ingest by solution" group landing. Surface
  manage-data/ingest/tools.md alongside the existing API/upload entries.

- Add Release notes top-level label with the per-product release-notes
  tree (Elasticsearch + clients + Hadoop, Kibana, Elastic Agent,
  Fleet Server, Logstash, Beats, Serverless, Cloud Hosted, Cloud
  Enterprise, Cloud on K8s, Observability with EDOT SDKs and APM
  agents, Security, ECS, ECCTL).

- Add Troubleshoot top-level label as `- toc: docs-content://troubleshoot`
  (covers ~190 pages). Delete the dead Troubleshooting comment block
  whose entries are all already reachable via that toc.

- Replace 57 `{{templated}}` substitution tokens (in titles AND group
  labels) with their literal expansions per docs-content/docset.yml::
  features. The nav renderer does not expand `{{...}}` so leaving
  them caused literal `{{ece}}` etc. to render in the sidebar.

Skipped (depends on features added in later layers of the stack):
- Liam's Search and query rewrite (PR #3094, against this branch).
- Products section (introduced in hub-pages).
- island: entries (Logstash plugins/versioned plugins; needs
  nav-v2-sections).
- Observability page additions on demo (slot under groups added in
  hub-pages stack).

YAML valid. 173/173 navigation tests pass.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant