Skip to content
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

Update navigation.yml #780

Merged
merged 14 commits into from
Mar 24, 2025
Merged
Changes from 1 commit
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
Prev Previous commit
Next Next commit
clean up
colleenmcginnis committed Mar 24, 2025
commit 405d8fb34c8a1bcb9ca3ea51e8488472ea0c7666
23 changes: 11 additions & 12 deletions src/docs-assembler/assembler.yml
Original file line number Diff line number Diff line change
@@ -30,17 +30,16 @@ references:
apm-agent-rum-js:
apm-aws-lambda:
apm-k8s-attacher:
apm-server:
beats:
cloud-on-k8s:
cloud:
current: master
curator:
skip: true
current: master
ecctl:
current: master
skip: true
# curator:
# skip: true
# current: master
# ecctl:
# current: master
# skip: true
ecs-dotnet:
ecs-logging-go-logrus:
ecs-logging-go-zap:
@@ -61,8 +60,8 @@ references:
elasticsearch-php:
elasticsearch-py:
# https://github.com/elastic/elasticsearch-rs ci checks not running?
elasticsearch-rs:
skip: true
# elasticsearch-rs:
# skip: true
elasticsearch-ruby:
elasticsearch:
go-elasticsearch:
@@ -73,6 +72,6 @@ references:
logstash:
search-ui:
integration-docs:
security-docs:
# wait for move to https://github.com/elastic/detection-rules/pull/4507/files
skip: true
# security-docs:
# # wait for move to https://github.com/elastic/detection-rules/pull/4507/files
# skip: true
30 changes: 7 additions & 23 deletions src/docs-assembler/navigation.yml
Original file line number Diff line number Diff line change
@@ -133,12 +133,12 @@ toc:
# Elasticsearch and index management
# ✅ https://github.com/elastic/docs-content/blob/main/reference/elasticsearch/toc.yml
- toc: docs-content://reference/elasticsearch
path_prefix: reference/elasticsearch
path_prefix: reference/elasticsearch/overview
children:

# ✅ https://github.com/elastic/elasticsearch/blob/main/docs/reference/elasticsearch/toc.yml
#- toc: elasticsearch://reference/elasticsearch
# path_prefix: reference/elasticsearch
- toc: elasticsearch://reference/elasticsearch
path_prefix: reference/elasticsearch
# Children include: Configuration, JVM settings, Roles,
# Elasticsearch privileges, Index settings, Index lifecycle actions,
# REST APIs, Mapping, Elasticsearch audit events, Command line tools
@@ -318,11 +318,6 @@ toc:
# Filebeat, Heartbeat, Metricbeat, Packetbeat, Winlogbeat,
# Elastic logging plugin for Docker

# 📝 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
# ✅ https://github.com/elastic/elasticsearch/blob/main/docs/reference/enrich-processor/toc.yml
- toc: elasticsearch://reference/enrich-processor
@@ -359,11 +354,6 @@ toc:
path_prefix: reference/aws-forwarder
# Children include the entire AsciiDoc book

# 📝 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
# ✅ https://github.com/elastic/elasticsearch/blob/main/docs/reference/search-connectors/toc.yml
- toc: elasticsearch://reference/search-connectors
@@ -406,13 +396,13 @@ toc:
# ECS
# ✅ https://github.com/elastic/docs-content/blob/main/reference/ecs/toc.yml
- toc: docs-content://reference/ecs
path_prefix: reference/ecs
path_prefix: reference/ecs/overview
Copy link
Contributor Author

@colleenmcginnis colleenmcginnis Mar 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did this for now for ecs, cloud, and elasticsearch. We might want to move the landing page (index.md file) from docs-content to the source repos, but I think the fix would take a while to implement because we would need to update any links that point to those files because I don't think there's a way to redirect to a page in a different repo, right?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is correct!

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/ref
path_prefix: reference/ecs
# Children include the entire AsciiDoc book

# ECS logging libraries
@@ -482,12 +472,6 @@ toc:
# Metrics reference, Canvas function reference
children:

# 📝 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
@@ -498,14 +482,14 @@ toc:
# Cloud
# ✅ https://github.com/elastic/docs-content/blob/main/reference/cloud/toc.yml
- toc: docs-content://reference/cloud
path_prefix: reference/cloud
path_prefix: reference/cloud/overview
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/ref
path_prefix: reference/cloud
# Children include the entire AsciiDoc book
# (minus pages moved to docs-content)


Unchanged files with check annotations Beta

TODO write development documentation here
![Image outside of scope](../images/great-drawing-of-new-structure.png)

Check notice on line 10 in docs/development/index.md

GitHub Actions / build

Image '../images/great-drawing-of-new-structure.png' is referenced out of table of contents scope '/home/runner/work/docs-builder/docs-builder/docs/development'.