From 64c17a70d3b93d4d6c60aa9bafd06bb1be42e1e4 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Tue, 25 Mar 2025 14:15:44 -0500 Subject: [PATCH 1/4] add curator, ecctl, logstash-docs-md --- src/docs-assembler/assembler.yml | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/src/docs-assembler/assembler.yml b/src/docs-assembler/assembler.yml index 3898acbd7..e049e1822 100644 --- a/src/docs-assembler/assembler.yml +++ b/src/docs-assembler/assembler.yml @@ -34,12 +34,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: @@ -68,7 +66,6 @@ references: integrations: kibana: logstash-docs-md: - skip: true logstash: search-ui: integration-docs: From dd3ec543b4aa31d93708b238ad660ad1cdd25bf3 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Tue, 25 Mar 2025 14:17:20 -0500 Subject: [PATCH 2/4] draft edits to navigation.yml --- src/docs-assembler/navigation.yml | 179 ++++++++++++++++-------------- 1 file changed, 94 insertions(+), 85 deletions(-) diff --git a/src/docs-assembler/navigation.yml b/src/docs-assembler/navigation.yml index d286c064e..e4113037a 100644 --- a/src/docs-assembler/navigation.yml +++ b/src/docs-assembler/navigation.yml @@ -43,60 +43,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: :// - # path_prefix: / - - 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 # @@ -146,9 +174,8 @@ 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 @@ -330,27 +357,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 @@ -401,7 +419,6 @@ toc: 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 @@ -481,19 +498,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 @@ -503,8 +512,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) From 58be17d08e9683f715f1f3fc0c94d314e2506d15 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Tue, 25 Mar 2025 17:36:26 -0500 Subject: [PATCH 3/4] fix broken links --- src/docs-assembler/navigation.yml | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/src/docs-assembler/navigation.yml b/src/docs-assembler/navigation.yml index e4113037a..feabdb9e0 100644 --- a/src/docs-assembler/navigation.yml +++ b/src/docs-assembler/navigation.yml @@ -181,7 +181,7 @@ toc: # 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 @@ -276,7 +276,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 @@ -413,16 +413,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 - - 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 From 8e3b16a0a537d50b4854907b2ed58dd99c93eb3a Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Wed, 26 Mar 2025 09:23:40 -0500 Subject: [PATCH 4/4] =?UTF-8?q?update=20phantoms=20=F0=9F=91=BB?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/docs-assembler/navigation.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/docs-assembler/navigation.yml b/src/docs-assembler/navigation.yml index feabdb9e0..27a077458 100644 --- a/src/docs-assembler/navigation.yml +++ b/src/docs-assembler/navigation.yml @@ -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: #############