Skip to content
Merged
70 changes: 58 additions & 12 deletions src/docs-assembler/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -174,13 +174,13 @@ toc:
# JavaScript
# ✅ https://github.com/elastic/elasticsearch-js/blob/main/docs/reference/toc.yml
- toc: elasticsearch-js://reference
path_prefix: reference/elasticsearch/clients/js
path_prefix: reference/elasticsearch/clients/javascript
# Children include the entire AsciiDoc book

# .NET
# ✅ https://github.com/elastic/elasticsearch-net/blob/main/docs/reference/toc.yml
- toc: elasticsearch-net://reference
path_prefix: reference/elasticsearch/clients/net
path_prefix: reference/elasticsearch/clients/dotnet
# Children include the entire AsciiDoc book

# PHP
Expand All @@ -192,7 +192,7 @@ toc:
# Python
# ✅ https://github.com/elastic/elasticsearch-py/blob/main/docs/reference/toc.yml
- toc: elasticsearch-py://reference
path_prefix: reference/elasticsearch/clients/py
path_prefix: reference/elasticsearch/clients/python
# Children include the entire AsciiDoc book

# Ruby
Expand All @@ -204,29 +204,61 @@ toc:
# Rust
# ✅ https://github.com/elastic/elasticsearch-rs/blob/main/docs/reference/toc.yml
- toc: elasticsearch-rs://reference
path_prefix: reference/elasticsearch/clients/rs
path_prefix: reference/elasticsearch/clients/rust
# Children include the entire AsciiDoc book

# Community-contributed clients
# 📝 TO DO: Directory depth in elasticsearch repo: would require toc 2 levels down
# 🔜 https://github.com/colleenmcginnis/elasticsearch/blob/docs-assembler-prep/docs/reference/community-contributed/toc.yml
- toc: elasticsearch://reference/community-contributed
path_prefix: reference/elasticsearch/clients/community-contributed
path_prefix: reference/elasticsearch/clients/community

# Ingestion tools
# 🔜 https://github.com/elastic/docs-content/blob/prepare-for-assembler/reference/ingestion-tools/toc.yml
- toc: docs-content://reference/ingestion-tools
path_prefix: reference/ingestion-tools
children:
# I don't know (TODO discuss with Colleen)

# In https://github.com/elastic/elasticsearch/pull/125118 I'm proposing we move
# reference/ingestion-tools/enrich-processor/toc.yml to
# reference/enrich-processor/toc.yml AND move all the related Markdown files from
# reference/ingestion-tools/enrich-processor/*.md to
# reference/enrich-processor/*.md
#
# If we merge that PR, would that remove the need for this item?
- toc: elasticsearch://reference/ingestion-tools/enrich-processor
path_prefix: reference/elasticsearch/enrich-processor
Comment thread
colleenmcginnis marked this conversation as resolved.
Outdated

# In https://github.com/elastic/elasticsearch/pull/125118 I'm proposing we move
# reference/ingestion-tools/search-connectors/toc.yml to
# reference/search-connectors/toc.yml AND move all the related Markdown files from
# reference/ingestion-tools/search-connectors/*.md to
# reference/search-connectors/*.md
#
# If we merge that PR, would that remove the need for this item?
- toc: elasticsearch://reference/ingestion-tools/search-connectors
path_prefix: reference/elasticsearch/search-connectors
Comment thread
colleenmcginnis marked this conversation as resolved.
Outdated

# I'm not sure what's going on with this one because there is no
# toc.yml in reference/elasticsearch/data-analysis/* on `main`.
# Currently these pages are captured in the higher level reference/toc.yml.
# In https://github.com/elastic/elasticsearch/pull/125118 I'm proposing we remove
# reference/toc.yml and distribute the contents across 9 individual toc.yml files.
- toc: elasticsearch://reference/data-analysis
path_prefix: reference/elasticsearch/data-analysis
Comment thread
colleenmcginnis marked this conversation as resolved.
Outdated

# This makes sense for now. I'm not sure when these files will be
# moved to https://github.com/elastic/detection-rules.
- toc: security-docs://reference/prebuilt-rules
path_prefix: reference/prebuilt-rules

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be moved up to replace lines 161-162.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


# In https://github.com/elastic/elasticsearch/pull/125118 I'm proposing we remove
# reference/toc.yml altogether because the contents of that file will be
# distributed across 9 individual toc.yml files in subdirectories alongside the
# related Markdown files.
#
# If we merge that PR, would that remove the need for this item?
- toc: elasticsearch://reference
path_prefix: reference/elasticsearch
Comment thread
colleenmcginnis marked this conversation as resolved.
Outdated

Expand Down Expand Up @@ -340,16 +372,30 @@ toc:
path_prefix: reference/logstash
# Children include the entire AsciiDoc book

# Logstash plugins
# 📝 TO DO: Migrate all files and create toc.yml
- toc: logstash-docs://reference
path_prefix: reference/logstash/plugins
# Children include the entire AsciiDoc book
# Commenting out because these don't exist yet!!
# 📝 TO DO: Get @karenzone's thoughts
#
# # Logstash plugins (LSR)
# # 📝 TO DO: Migrate all files and create toc.yml
# - 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
Comment thread
colleenmcginnis marked this conversation as resolved.
Outdated

# 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/elastic-serverless-forwarder
path_prefix: reference/aws-forwarder
Comment thread
colleenmcginnis marked this conversation as resolved.
# Children include the entire AsciiDoc book

# Search connectors
Expand Down Expand Up @@ -381,7 +427,7 @@ toc:
# 📝 TO DO: Directory depth in elasticsearch repo: would require toc 2 levels down
# 🔜 https://github.com/colleenmcginnis/elasticsearch/blob/docs-assembler-prep/docs/reference/elasticsearch-plugins/toc.yml
- toc: elasticsearch://reference/elasticsearch-plugins
path_prefix: reference/elasticsearch-plugins
path_prefix: reference/elasticsearch/plugins

# Query languages
# 📝 TO DO: Directory depth in elasticsearch repo: would require toc 2 levels down
Expand Down