Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 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
1 change: 1 addition & 0 deletions src/docs-assembler/assembler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ references:
skip: true
apm-aws-lambda:
apm-k8s-attacher:
apm-server:
beats:
skip: true
cloud-on-k8s:
Expand Down
224 changes: 161 additions & 63 deletions src/docs-assembler/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,60 +37,112 @@ toc:
#################
# RELEASE NOTES #
#################
# I didn't touch this section (yet?)
- toc: release-notes
children:
# repo is short for
# - toc: <repo>://<parent_toc>
# path_prefix: <parent_toc>/<repo>
- repo: asciidocalypse
- 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: 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
# Elasticsearch
# ✅ https://github.com/elastic/elasticsearch/blob/main/docs/release-notes/toc.yml
- toc: elasticsearch://release-notes
path_prefix: release-notes/elasticsearch
children:
# Elasticsearch Java Client
# ✅ https://github.com/elastic/elasticsearch-java/blob/main/docs/release-notes/toc.yml
- toc: elasticsearch-java://release-notes
path_prefix: release-notes/elasticsearch-java-client

# Elasticsearch JavaScript Client
# ✅ https://github.com/elastic/elasticsearch-js/blob/main/docs/release-notes/toc.yml
- toc: elasticsearch-js://release-notes
path_prefix: release-notes/elasticsearch-javascript-client

# Elasticserch PHP Client
# ✅ https://github.com/elastic/elasticsearch-php/blob/main/docs/release-notes/toc.yml
- toc: elasticsearch-php://release-notes
path_prefix: release-notes/elasticsearch-php-client

# Elasticserch Python Client
# ✅ https://github.com/elastic/elasticsearch-py/blob/main/docs/release-notes/toc.yml
- toc: elasticsearch-py://release-notes
path_prefix: release-notes/elasticsearch-python-client

# Kibana
# ✅ https://github.com/elastic/kibana/blob/main/docs/release-notes/toc.yml
- toc: kibana://release-notes
path_prefix: release-notes/kibana

# Logstash
# ✅ https://github.com/elastic/logstash/blob/main/docs/release-notes/toc.yml
- toc: logstash://release-notes
path_prefix: release-notes/logstash

# Beats
# ✅ https://github.com/elastic/beats/blob/main/docs/release-notes/toc.yml
- toc: beats://release-notes
path_prefix: release-notes/beats

# Fleet and Elastic Agent
# ✅ https://github.com/elastic/docs-content/blob/main/release-notes/fleet-elastic-agent/toc.yml
- toc: docs-content://release-notes/fleet-elastic-agent
path_prefix: release-notes/fleet-elastic-agent

# Elastic Cloud Hosted
# ✅ https://github.com/elastic/cloud/blob/master/docs/release-notes/cloud-hosted/toc.yml
- toc: cloud://release-notes/cloud-hosted
path_prefix: release-notes/elastic-cloud-hosted

# Elastic Cloud Serverless
# ✅ https://github.com/elastic/docs-content/blob/main/release-notes/elastic-cloud-serverless/toc.yml
- toc: docs-content://release-notes/elastic-cloud-serverless
path_prefix: release-notes/elastic-cloud-serverless

# Elastic Cloud Enterprise
# ✅ https://github.com/elastic/cloud/blob/master/docs/release-notes/cloud-hosted/toc.yml
- toc: cloud://release-notes/cloud-enterprise
path_prefix: release-notes/elastic-cloud-enterprise

# Elastic Cloud on Kubernetes
# ✅ https://github.com/elastic/cloud-on-k8s/blob/main/docs/release-notes/toc.yml
- toc: cloud-on-k8s://release-notes
path_prefix: release-notes/elastic-cloud-kubernetes

# Elastic Observability
# ✅ https://github.com/elastic/docs-content/blob/main/release-notes/elastic-observability/toc.yml
- toc: docs-content://release-notes/elastic-observability
path_prefix: release-notes/elastic-observability
children:
# Elastic APM
# ✅ https://github.com/elastic/docs-content/blob/main/release-notes/elastic-apm/toc.yml
- toc: apm-server://release-notes
path_prefix: release-notes/elastic-apm

# Elastic APM .NET Agent
# ✅ https://github.com/elastic/apm-agent-dotnet/blob/main/docs/release-notes/toc.yml
- toc: apm-agent-dotnet://release-notes
path_prefix: release-notes/elastic-apm-net-agent

# Elastic APM Go Agent
# ✅ https://github.com/elastic/apm-agent-go/blob/main/docs/release-notes/toc.yml
- toc: apm-agent-go://release-notes
path_prefix: release-notes/elastic-apm-go-agent

# Elastic APM iOS Agent
# ✅ https://github.com/elastic/apm-agent-ios/blob/main/docs/release-notes/toc.yml
- toc: apm-agent-ios://release-notes
path_prefix: release-notes/elastic-apm-ios-agent

# Elastic APM Ruby Agent
# https://github.com/elastic/apm-agent-ruby/blob/main/docs/release-notes/toc.yml
- toc: apm-agent-ruby://release-notes
path_prefix: release-notes/elastic-apm-ruby-agent

# Elastic APM RUM JavaScript Agent
# ✅ https://github.com/elastic/apm-agent-rum-js/blob/main/docs/release-notes/toc.yml
- toc: apm-agent-rum-js://release-notes
path_prefix: release-notes/elastic-apm-rum-javascript-agent

# Elastic Security
# ✅ https://github.com/elastic/docs-content/blob/main/release-notes/elastic-security/toc.yml
- toc: docs-content://release-notes/elastic-security
path_prefix: release-notes/elastic-security

#############
# REFERENCE #
Expand Down Expand Up @@ -174,7 +226,7 @@ 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
Expand All @@ -192,7 +244,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 +256,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

# 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

# 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

# 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
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
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

Expand Down Expand Up @@ -340,16 +424,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

# 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
# Children include the entire AsciiDoc book

# Search connectors
Expand Down Expand Up @@ -381,7 +479,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
Loading