Update `navigation.yml` #780

colleenmcginnis · 2025-03-19T17:08:09Z

Porting recent changes from https://github.com/elastic/docs-projects/pull/464.

github-actions · 2025-03-19T17:08:25Z

Label error. Requires exactly 1 of: automation, breaking, bug, changelog:skip, chore, ci, dependencies, documentation, enhancement, feature, fix, redesign. Found:

src/docs-assembler/navigation.yml

colleenmcginnis

Some specific questions below!

src/docs-assembler/navigation.yml

colleenmcginnis · 2025-03-19T17:10:14Z

src/docs-assembler/navigation.yml

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


Question for @Mpdreamz...

This was added because neither elasticsearch://reference was not linked anywhere and thus no prefix matched elasticsearch://reference/data-analysis.

Let's revisit once: elastic/elasticsearch#125118 lands

colleenmcginnis · 2025-03-19T17:10:47Z

src/docs-assembler/navigation.yml

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


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

https://github.com/elastic/detection-rules. yes!

Hoping to update:

elastic/detection-rules#4507
and elastic/detection-rules#4507

In the morning.

src/docs-assembler/navigation.yml

colleenmcginnis · 2025-03-19T17:11:28Z

src/docs-assembler/navigation.yml

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


Question for @karenzone on logstash path_prefixes. cc @bmorelli25

colleenmcginnis · 2025-03-19T17:12:00Z

src/docs-assembler/navigation.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


Question for @KOTungseth.

src/docs-assembler/navigation.yml

This reverts commit 417f7af.

colleenmcginnis · 2025-03-21T17:45:46Z

FYI @Mpdreamz we will need to merge elastic/docs-content#792 to get the final structure of the global nav.

colleenmcginnis

Ok. I think this is pretty stable now. I left a few comments below.

colleenmcginnis · 2025-03-21T18:28:33Z

src/docs-assembler/assembler.yml

I hope it's ok to update these for the repos where the migration PRs have merged. I kept skip: true for the repos that use master because I got an error on build-all when I tried to include them.

<repo>: current: master

Should work (like cloud).

(current/next) not yet supported so we just do current now with current defaulting to main

colleenmcginnis · 2025-03-21T18:28:45Z

src/docs-assembler/assembler.yml

+  logstash-docs-md:
    skip: true


This content is still in flux.

colleenmcginnis · 2025-03-21T18:31:35Z

src/docs-assembler/navigation.yml

+          # 📝 TO DO: Delete this item
+          # This should be replaced by `elasticsearch://reference/enrich-processor` below
+          - toc: elasticsearch://reference/ingestion-tools/enrich-processor
+            path_prefix: reference/elasticsearch/enrich-processor
+
          # Processor reference
-          # 📝 TO DO: Directory depth in elasticsearch repo: would require toc 2 levels down
-          # 🔜 https://github.com/colleenmcginnis/elasticsearch/blob/docs-assembler-prep/docs/reference/enrich-processor/toc.yml
+          # ✅ https://github.com/elastic/elasticsearch/blob/main/docs/reference/enrich-processor/toc.yml
          - toc: elasticsearch://reference/enrich-processor
            path_prefix: reference/enrich-processor


I would expect we'd be able to remove elasticsearch://reference/ingestion-tools/enrich-processor in favor of elasticsearch://reference/enrich-processor now that elastic/elasticsearch#125118 was merged, but at least when I run build-all locally I get errors if I delete this.

colleenmcginnis · 2025-03-21T18:32:14Z

src/docs-assembler/navigation.yml

+          # 📝 TO DO: Delete this item
+          # This should be replaced by `elasticsearch://reference/search-connectors` below
+          - toc: elasticsearch://reference/ingestion-tools/search-connectors
+            path_prefix: reference/elasticsearch/search-connectors
+
          # Search connectors
-          # 📝 TO DO: Directory depth in elasticsearch repo: would require toc 2 levels down
-          # 🔜 https://github.com/colleenmcginnis/elasticsearch/blob/docs-assembler-prep/docs/reference/search-connectors/toc.yml
+          # ✅ https://github.com/elastic/elasticsearch/blob/main/docs/reference/search-connectors/toc.yml
          - toc: elasticsearch://reference/search-connectors
            path_prefix: reference/search-connectors


I would expect we'd be able to remove elasticsearch://reference/ingestion-tools/search-connectors in favor of elasticsearch://reference/search-connectors below now that elastic/elasticsearch#125118 was merged, but at least when I run build-all locally I get errors if I delete this.

colleenmcginnis · 2025-03-21T18:33:23Z

src/docs-assembler/navigation.yml

+          # 📝 TO DO: Delete this item
+          # This should be replaced by `elasticsearch://reference/text-analysis` and
+          # `elasticsearch://reference/aggregations` below.
+          - toc: elasticsearch://reference/data-analysis
+            path_prefix: reference/elasticsearch/data-analysis
+
+          # ✅ https://github.com/elastic/elasticsearch/blob/main/docs/reference/text-analysis/toc.yml
          - toc: elasticsearch://reference/text-analysis
            path_prefix: reference/text-analysis
-          # 📝 TO DO: Directory depth in elasticsearch repo: would require toc 2 levels down
-          # 🔜 https://github.com/colleenmcginnis/elasticsearch/blob/docs-assembler-prep/docs/reference/aggregations/toc.yml
+          # ✅ https://github.com/elastic/elasticsearch/blob/main/docs/reference/aggregations/toc.yml
          - toc: elasticsearch://reference/aggregations
            path_prefix: reference/aggregations


I would expect we'd be able to remove elasticsearch://reference/data-analysis in favor of elasticsearch://reference/text-analysis and elasticsearch://reference/aggregations below now that elastic/elasticsearch#125118 was merged, but at least when I run build-all locally I get errors if I delete this.

Hey @colleenmcginnis you might need to delete your .artifacts/checkouts folder and call clone-all again.

Alternatively you should be able to call clone-all without deleting to update all but I have not tested if it works in all scenario's yet.

colleenmcginnis added 3 commits March 19, 2025 11:54

add code comments with context

aadaeca

address feedback from @lcawl @bmorelli25 in elastic/docs-projects#464

edd8c05

add release notes config from @KOTungseth

417f7af

github-actions bot deployed to docs-preview March 19, 2025 17:08 View deployment

colleenmcginnis commented Mar 19, 2025

View reviewed changes

src/docs-assembler/navigation.yml Outdated Show resolved Hide resolved

colleenmcginnis commented Mar 19, 2025

View reviewed changes

src/docs-assembler/navigation.yml Outdated Show resolved Hide resolved

colleenmcginnis commented Mar 19, 2025

View reviewed changes

src/docs-assembler/navigation.yml Outdated Show resolved Hide resolved

colleenmcginnis commented Mar 19, 2025

View reviewed changes

src/docs-assembler/navigation.yml Outdated Show resolved Hide resolved

Mpdreamz reviewed Mar 19, 2025

View reviewed changes

src/docs-assembler/navigation.yml Outdated Show resolved Hide resolved

Revert "add release notes config from @KOTungseth"

289333f

This reverts commit 417f7af.

github-actions bot deployed to docs-preview March 19, 2025 18:39 View deployment

net -> dotnet

75267df

github-actions bot deployed to docs-preview March 19, 2025 19:03 View deployment

colleenmcginnis mentioned this pull request Mar 20, 2025

[work in progress] Refine release notes section in navigation.yml #803

Draft

10 tasks

colleenmcginnis added 2 commits March 20, 2025 12:10

Merge branch 'main' into update-nav

40dfefc

Merge branch 'main' into update-nav

2e33ddb

Mpdreamz approved these changes Mar 21, 2025

View reviewed changes

update navigation.yml and assembler.yml

e9ed222

github-actions bot deployed to docs-preview March 21, 2025 18:25 View deployment

colleenmcginnis commented Mar 21, 2025

View reviewed changes

colleenmcginnis marked this pull request as ready for review March 21, 2025 18:35

colleenmcginnis requested a review from a team as a code owner March 21, 2025 18:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update `navigation.yml` #780

Update `navigation.yml` #780

colleenmcginnis commented Mar 19, 2025

github-actions bot commented Mar 19, 2025

colleenmcginnis left a comment

colleenmcginnis Mar 19, 2025

Mpdreamz Mar 19, 2025

colleenmcginnis Mar 19, 2025

Mpdreamz Mar 19, 2025

colleenmcginnis Mar 19, 2025 •

edited

Loading

colleenmcginnis Mar 19, 2025

colleenmcginnis commented Mar 21, 2025

colleenmcginnis left a comment

colleenmcginnis Mar 21, 2025

Mpdreamz Mar 21, 2025

Mpdreamz Mar 21, 2025

colleenmcginnis Mar 21, 2025

colleenmcginnis Mar 21, 2025

colleenmcginnis Mar 21, 2025

colleenmcginnis Mar 21, 2025

Mpdreamz Mar 21, 2025 •

edited

Loading

Update navigation.yml #780

Are you sure you want to change the base?

Update navigation.yml #780

Conversation

colleenmcginnis commented Mar 19, 2025

github-actions bot commented Mar 19, 2025

colleenmcginnis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colleenmcginnis Mar 19, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

colleenmcginnis commented Mar 21, 2025

colleenmcginnis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Mpdreamz Mar 21, 2025 • edited Loading

Choose a reason for hiding this comment

Update `navigation.yml` #780

Update `navigation.yml` #780

colleenmcginnis Mar 19, 2025 •

edited

Loading

Mpdreamz Mar 21, 2025 •

edited

Loading