Skip to content

Update navigation.yml #845

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

Merged
merged 5 commits into from
Mar 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions src/docs-assembler/assembler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,10 @@ references:
cloud-on-k8s:
cloud:
current: master
# curator:
# skip: true
# current: master
# ecctl:
# current: master
# skip: true
curator:
current: master
ecctl:
current: master
ecs-dotnet:
ecs-logging-go-logrus:
ecs-logging-go-zap:
Expand Down Expand Up @@ -75,7 +73,6 @@ references:
integrations:
kibana:
logstash-docs-md:
skip: true
logstash:
search-ui:
integration-docs:
Expand Down
198 changes: 102 additions & 96 deletions src/docs-assembler/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
# That are not linked in the global toc but all the children toc they define are.
phantoms:
- toc: elasticsearch://reference
- toc: docs-content://release-notes
- toc: cloud://release-notes

toc:
#############
Expand Down Expand Up @@ -43,60 +45,88 @@ toc:
#################
# RELEASE NOTES #
#################
# I didn't touch this section (yet?)
- toc: release-notes
# Context:
# I want to start with just this one page:
# https://github.com/elastic/docs-content/blob/main/release-notes/index.md
# And include other tocs from docs-content later in this file.
#
# Why:
# We need to assign different a `path_prefix` to the Fleet, Observability, Security,
# and Serverless release notes, which all live in the docs-content repo.
#
# What I tried:
# In docs-content, I tried moving release-notes/index.md to release-notes/intro/index.md
# and creating a release-notes/intro/toc.yml file that contains just that page,
# but I still couldn't get it to work.
- toc: docs-content://release-notes/intro
path_prefix: release-notes
children:
# repo is short for
# - toc: <repo>://<parent_toc>
# path_prefix: <parent_toc>/<repo>
- repo: apm-agent-android
- repo: apm-agent-dotnet
- repo: apm-agent-go
- repo: apm-agent-ios
- repo: apm-agent-java
- repo: apm-agent-nodejs
- repo: apm-agent-php
- repo: apm-agent-python
- repo: apm-agent-ruby
- repo: apm-agent-rum-js
- repo: apm-aws-lambda
# - repo: apm-k8s-attacher
- repo: apm-server
- repo: beats
- repo: cloud-on-k8s
- repo: cloud
# - repo: curator
#- repo: ecctl
# - repo: ecs-dotnet
# - repo: ecs-logging-go-logrus
# - repo: ecs-logging-go-zap
# - repo: ecs-logging-go-zerolog
#- repo: ecs-logging-java
# - repo: ecs-logging-nodejs
#- repo: ecs-logging-php
# - repo: ecs-logging-python
# - repo: ecs-logging-ruby
# - repo: ecs-logging
# - repo: ecs
#- repo: eland
#- repo: elastic-serverless-forwarder
- repo: elasticsearch-hadoop
- repo: elasticsearch-java
- repo: elasticsearch-js
- repo: elasticsearch-net
- repo: elasticsearch-php
- repo: elasticsearch-py
# - repo: elasticsearch-rs
- repo: elasticsearch-ruby
- repo: elasticsearch
# - repo: go-elasticsearch
#- repo: integrations
- repo: kibana
# - repo: logstash-docs
- repo: logstash
# - repo: search-ui
# - repo: integration-docs
# - repo: security-docs
- toc: apm-agent-android://release-notes
path_prefix: release-notes/apm/agents/android
- toc: apm-agent-dotnet://release-notes
path_prefix: release-notes/apm/agents/dotnet
- toc: apm-agent-go://release-notes
path_prefix: release-notes/apm/agents/go
- toc: apm-agent-ios://release-notes
path_prefix: release-notes/apm/agents/ios
- toc: apm-agent-java://release-notes
path_prefix: release-notes/apm/agents/java
- toc: apm-agent-nodejs://release-notes
path_prefix: release-notes/apm/agents/nodejs
- toc: apm-agent-php://release-notes
path_prefix: release-notes/apm/agents/php
- toc: apm-agent-python://release-notes
path_prefix: release-notes/apm/agents/python
- toc: apm-agent-ruby://release-notes
path_prefix: release-notes/apm/agents/ruby
- toc: apm-agent-rum-js://release-notes
path_prefix: release-notes/apm/agents/rum-js
- toc: apm-aws-lambda://release-notes
path_prefix: release-notes/apm/aws-lambda
- toc: apm-server://release-notes
path_prefix: release-notes/apm
- toc: beats://release-notes
path_prefix: release-notes/beats
- toc: cloud-on-k8s://release-notes
path_prefix: release-notes/cloud-on-k8s
# We probably need to add `max_toc_depth: 2` to
# https://github.com/elastic/cloud/blob/master/docs/docset.yml
- toc: cloud://release-notes/cloud-hosted
path_prefix: release-notes/cloud-hosted
- toc: cloud://release-notes/cloud-enterprise
path_prefix: release-notes/cloud-enterprise
# Comes from docs-content
- toc: docs-content://release-notes/elastic-cloud-serverless
path_prefix: release-notes/cloud-serverless
- toc: elasticsearch://release-notes
path_prefix: release-notes/elasticsearch
- toc: elasticsearch-hadoop://release-notes
path_prefix: release-notes/elasticsearch-hadoop
- toc: elasticsearch-java://release-notes
path_prefix: release-notes/elasticsearch/clients/java
- toc: elasticsearch-js://release-notes
path_prefix: release-notes/elasticsearch/clients/javascript
- toc: elasticsearch-net://release-notes
path_prefix: release-notes/elasticsearch/clients/dotnet
- toc: elasticsearch-php://release-notes
path_prefix: release-notes/elasticsearch/clients/php
- toc: elasticsearch-py://release-notes
path_prefix: release-notes/elasticsearch/clients/python
- toc: elasticsearch-ruby://release-notes
path_prefix: release-notes/elasticsearch/clients/ruby
# Comes from docs-content
- toc: docs-content://release-notes/fleet-elastic-agent
path_prefix: release-notes/fleet
- toc: kibana://release-notes
path_prefix: release-notes/kibana
- toc: logstash://release-notes
path_prefix: release-notes/logstash
# Comes from docs-content
- toc: docs-content://release-notes/elastic-observability
path_prefix: release-notes/observability
# Comes from docs-content
- toc: docs-content://release-notes/elastic-security
path_prefix: release-notes/security

#############
# REFERENCE #
Expand Down Expand Up @@ -146,15 +176,14 @@ toc:

# Curator
# ✅ https://github.com/elastic/curator/blob/master/docs/reference/toc.yml
# TODO MARTIJN: needs to run once more on master for the link index
#- toc: curator://reference
# path_prefix: reference/elasticsearch/curator
- toc: curator://reference
path_prefix: reference/elasticsearch/curator
# Children include the entire AsciiDoc book

# Clients
# ✅ https://github.com/elastic/docs-content/blob/main/reference/elasticsearch-clients/toc.yml
- toc: docs-content://reference/elasticsearch-clients
path_prefix: reference/elasticsearch/clients
path_prefix: reference/elasticsearch-clients
children:

# Eland
Expand Down Expand Up @@ -249,7 +278,7 @@ toc:
# APM agents
# ✅ https://github.com/elastic/docs-content/blob/main/reference/apm-agents/toc.yml
- toc: docs-content://reference/apm-agents
path_prefix: reference/apm/agents
path_prefix: reference/apm-agents
children:
# APM Android agent
# ✅ https://github.com/elastic/apm-agent-android/blob/main/docs/reference/toc.yml
Expand Down Expand Up @@ -330,27 +359,18 @@ toc:
path_prefix: reference/logstash
# Children include the entire AsciiDoc book

# Commenting out because these aren't stable yet!!

# # Logstash plugins (LSR)
# # 📝 TO DO: Migrate all files and create toc.yml
# - toc: logstash-docs-md://lsr
# path_prefix: reference/logstash/plugins
- toc: logstash-docs-md://lsr
path_prefix: reference/logstash/plugins
# # Children include the entire AsciiDoc book

# # Logstash versioned plugins (VPR)
# # 📝 TO DO: Migrate all files and create toc.yml
# - toc: logstash-docs-md://vpr
# path_prefix: reference/logstash/versioned-plugins
# # Children include the entire AsciiDoc book
- toc: logstash-docs-md://vpr
path_prefix: reference/logstash/versioned-plugins
# Children include the entire AsciiDoc book

# Elastic Serverless Forwarder for AWS
# ✅ https://github.com/elastic/elastic-serverless-forwarder/blob/main/docs/reference/toc.yml
# 📝 TO DO: Answer the question below
# This is the first URL that has "serverless" in the path. It's
# https://www.elastic.co/guide/en/esf/current/aws-elastic-serverless-forwarder.html
# so not really the first thing we want folks to land on if path has a lot of impact
# on search results. @KOTungseth WDYT?
- toc: elastic-serverless-forwarder://reference
path_prefix: reference/aws-forwarder
# Children include the entire AsciiDoc book
Expand Down Expand Up @@ -395,17 +415,11 @@ toc:
path_prefix: reference/scripting-languages

# ECS
# ✅ https://github.com/elastic/docs-content/blob/main/reference/ecs/toc.yml
- toc: docs-content://reference/ecs
path_prefix: reference/ecs/overview
# ✅ https://github.com/elastic/ecs/blob/main/docs/reference/toc.yml
- toc: ecs://reference
path_prefix: reference/ecs
# Children include the entire AsciiDoc book
children:
# ECS reference
# ✅ https://github.com/elastic/ecs/blob/main/docs/reference/toc.yml
# TODO MARTIJN conflicting path_prefix
- toc: ecs://reference
path_prefix: reference/ecs
# Children include the entire AsciiDoc book

# ECS logging libraries
# ✅ https://github.com/elastic/ecs-logging/blob/main/docs/reference/toc.yml
- toc: ecs-logging://reference
Expand Down Expand Up @@ -481,19 +495,11 @@ toc:
path_prefix: reference/aggregations

# Cloud
# ✅ https://github.com/elastic/docs-content/blob/main/reference/cloud/toc.yml
- toc: docs-content://reference/cloud
path_prefix: reference/cloud/overview
# ✅ https://github.com/elastic/cloud/blob/master/docs/reference/toc.yml
- toc: cloud://reference
path_prefix: reference/cloud
# Children include Elastic Cloud Enterprise, Elastic Cloud Hosted
children:
# Elastic Cloud Enterprise
# Elastic Cloud Hosted
# ✅ https://github.com/elastic/cloud/blob/master/docs/reference/toc.yml
# TODO Martijn: conflicting path_prefix
- toc: cloud://reference
path_prefix: reference/cloud
# Children include the entire AsciiDoc book
# (minus pages moved to docs-content)

# Elastic Cloud on Kubernetes
# ✅ https://github.com/elastic/cloud-on-k8s/blob/main/docs/reference/toc.yml
- toc: cloud-on-k8s://reference
Expand All @@ -503,8 +509,8 @@ toc:

# Elastic cloud control (ECCTL)
# ✅ https://github.com/elastic/ecctl/blob/master/docs/reference/toc.yml
#- toc: ecctl://reference
# path_prefix: reference/ecctl
- toc: ecctl://reference
path_prefix: reference/ecctl
# Children include the entire AsciiDoc book
# (minus pages moved to docs-content)

Expand Down
Loading