From 79c0a098b843d008b29d0ff3eeff7cb8821b7e38 Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Wed, 2 Apr 2025 14:02:59 -0500 Subject: [PATCH 1/3] Update release notes nav --- src/docs-assembler/navigation.yml | 177 ++++++++++++++++++++---------- 1 file changed, 120 insertions(+), 57 deletions(-) diff --git a/src/docs-assembler/navigation.yml b/src/docs-assembler/navigation.yml index 90c040dd2..6e205c424 100644 --- a/src/docs-assembler/navigation.yml +++ b/src/docs-assembler/navigation.yml @@ -42,7 +42,7 @@ toc: - toc: beats://extend path_prefix: extend/beats - ################# + ################# # RELEASE NOTES # ################# # Context: @@ -58,76 +58,139 @@ toc: # 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 + - toc: docs-content://release-notes path_prefix: release-notes children: - - 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 + # Elasticsearch + # https://github.com/elastic/elasticsearch/blob/main/docs/release-notes/toc.yml + - toc: elasticsearch://release-notes + path_prefix: release-notes/elasticsearch + children: + # Elasticsearch Clients + # https://github.com/elastic/elasticsearch-java/blob/main/docs/release-notes/toc.yml + - toc: elasticsearch-java://release-notes + path_prefix: release-notes/elasticsearch/clients/java + # https://github.com/elastic/elasticsearch-js/blob/main/docs/release-notes/toc.yml + - toc: elasticsearch-js://release-notes + path_prefix: release-notes/elasticsearch/clients/javascript + # https://github.com/elastic/elasticsearch-net/blob/main/docs/release-notes/toc.yml + - toc: elasticsearch-net://release-notes + path_prefix: release-notes/elasticsearch/clients/dotnet + # https://github.com/elastic/elasticsearch-php/blob/main/docs/release-notes/toc.yml + - toc: elasticsearch-php://release-notes + path_prefix: release-notes/elasticsearch/clients/php + # https://github.com/elastic/elasticsearch-py/blob/main/docs/release-notes/toc.yml + - toc: elasticsearch-py://release-notes + path_prefix: release-notes/elasticsearch/clients/python + # https://github.com/elastic/elasticsearch-ruby/blob/main/docs/release-notes/toc.yml + - toc: elasticsearch-ruby://release-notes + path_prefix: release-notes/elasticsearch/clients/ruby + # Elasticsearch Hadoop + # https://github.com/elastic/elasticsearch-hadoop/blob/main/docs/release-notes/toc.yml + - toc: elasticsearch-hadoop://release-notes + path_prefix: release-notes/elasticsearch-hadoop + + # Kibana + # https://github.com/elastic/kibana/blob/main/docs/release-notes/toc.yml + - toc: kibana://release-notes + path_prefix: release-notes/kibana + + # 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 + + # 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 - - toc: cloud-on-k8s://release-notes - path_prefix: release-notes/cloud-on-k8s + + # Serverless + # Comes from docs-content + # 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/cloud-serverless + # Cloud Hosted + # https://github.com/elastic/cloud/blob/master/docs/release-notes/cloud-hosted/toc.yml # 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 + # Cloud Enterprise + # https://github.com/elastic/cloud/blob/master/docs/release-notes/cloud-enterprise/toc.yml - 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 + + # K8s + # https://github.com/elastic/cloud-on-k8s/blob/main/docs/release-notes/toc.yml + - toc: cloud-on-k8s://release-notes + path_prefix: release-notes/cloud-on-k8s + + # Observability + # https://github.com/elastic/docs-content/blob/main/release-notes/elastic-observability/toc.yml # Comes from docs-content - toc: docs-content://release-notes/elastic-observability path_prefix: release-notes/observability - # Comes from docs-content + children: + # APM + # https://github.com/elastic/docs-content/blob/main/release-notes/elastic-apm/toc.yml + - toc: apm-server://release-notes + path_prefix: release-notes/apm + # APM Android agent + # https://github.com/elastic/apm-agent-android/blob/main/docs/release-notes/toc.yml + - toc: apm-agent-android://release-notes + path_prefix: release-notes/apm/agents/android + # 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/apm/agents/dotnet + # 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/apm/agents/go + # 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/apm/agents/ios + # APM Java agent + # https://github.com/elastic/apm-agent-java/blob/main/docs/release-notes/toc.yml + - toc: apm-agent-java://release-notes + path_prefix: release-notes/apm/agents/java + # APM Node.js agent + # https://github.com/elastic/apm-agent-nodejs/blob/main/docs/release-notes/toc.yml + - toc: apm-agent-nodejs://release-notes + path_prefix: release-notes/apm/agents/nodejs + # APM PHP agent + # https://github.com/elastic/apm-agent-php/blob/main/docs/release-notes/toc.yml + - toc: apm-agent-php://release-notes + path_prefix: release-notes/apm/agents/php + # APM Python agent + # https://github.com/elastic/apm-agent-python/blob/main/docs/release-notes/toc.yml + - toc: apm-agent-python://release-notes + path_prefix: release-notes/apm/agents/python + # 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/apm/agents/ruby + # 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/apm/agents/rum-js + # APM AWS Lambda Extension + # https://github.com/elastic/apm-aws-lambda/blob/main/docs/release-notes/toc.yml + - toc: apm-aws-lambda://release-notes + path_prefix: release-notes/apm/aws-lambda + + # 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/security - + ############# # REFERENCE # ############# @@ -514,4 +577,4 @@ toc: # Glossary # ✅ https://github.com/elastic/docs-content/blob/main/reference/glossary/toc.yml - toc: docs-content://reference/glossary - path_prefix: reference/glossary \ No newline at end of file + path_prefix: reference/glossary From 67ff36990cd8cec6f856cd5f1cddc4e53e2bfdad Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Thu, 3 Apr 2025 16:59:50 -0500 Subject: [PATCH 2/3] Update src/docs-assembler/navigation.yml --- src/docs-assembler/navigation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs-assembler/navigation.yml b/src/docs-assembler/navigation.yml index 6e205c424..e35eac021 100644 --- a/src/docs-assembler/navigation.yml +++ b/src/docs-assembler/navigation.yml @@ -58,7 +58,7 @@ toc: # 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 + - toc: release-notes path_prefix: release-notes children: # Elasticsearch From 9f646be5378241aa893ee4cfaf9424b39895ff1a Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Fri, 4 Apr 2025 16:09:05 -0500 Subject: [PATCH 3/3] Update src/docs-assembler/navigation.yml Co-authored-by: Colleen McGinnis --- src/docs-assembler/navigation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/docs-assembler/navigation.yml b/src/docs-assembler/navigation.yml index e35eac021..5d288d19d 100644 --- a/src/docs-assembler/navigation.yml +++ b/src/docs-assembler/navigation.yml @@ -58,7 +58,7 @@ toc: # 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: release-notes + - toc: docs-content://release-notes/intro path_prefix: release-notes children: # Elasticsearch