-
Notifications
You must be signed in to change notification settings - Fork 31
Update navigation.yml
#780
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
Changes from 3 commits
aadaeca
edd8c05
417f7af
289333f
75267df
40dfefc
2e33ddb
e9ed222
efbf6d3
405d8fb
cf3fe12
ef88fd3
ffa8980
be3bf15
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,60 +37,112 @@ toc: | |
################# | ||
# RELEASE NOTES # | ||
################# | ||
# I didn't touch this section (yet?) | ||
- toc: release-notes | ||
colleenmcginnis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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 | ||
colleenmcginnis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- 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 | ||
colleenmcginnis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
# 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: | ||
colleenmcginnis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
# 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 | ||
colleenmcginnis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
# 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 # | ||
|
@@ -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 | ||
|
@@ -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 | ||
|
@@ -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 | ||
colleenmcginnis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
# 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 | ||
colleenmcginnis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
# 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 | ||
colleenmcginnis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
# 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 | ||
|
||
|
||
# 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 | ||
colleenmcginnis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
|
@@ -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 | ||
colleenmcginnis marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
||
# 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 | ||
colleenmcginnis marked this conversation as resolved.
Show resolved
Hide resolved
|
||
# Children include the entire AsciiDoc book | ||
|
||
# Search connectors | ||
|
@@ -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 | ||
|
Uh oh!
There was an error while loading. Please reload this page.