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.

Sign up for GitHub

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
+117 −154
Merged

Update navigation.yml #780

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
aadaeca
add code comments with context
colleenmcginnis Mar 19, 2025
edd8c05
address feedback from @lcawl @bmorelli25 in https://github.com/elasti…
colleenmcginnis Mar 19, 2025
417f7af
add release notes config from @KOTungseth
colleenmcginnis Mar 19, 2025
289333f
Revert "add release notes config from @KOTungseth"
colleenmcginnis Mar 19, 2025
75267df
net -> dotnet
colleenmcginnis Mar 19, 2025
40dfefc
Merge branch 'main' into update-nav
colleenmcginnis Mar 20, 2025
2e33ddb
Merge branch 'main' into update-nav
colleenmcginnis Mar 21, 2025
e9ed222
update navigation.yml and assembler.yml
colleenmcginnis Mar 21, 2025
efbf6d3
Merge branch 'main' into update-nav
colleenmcginnis Mar 24, 2025
405d8fb
clean up
colleenmcginnis Mar 24, 2025
cf3fe12
more clean up
colleenmcginnis Mar 24, 2025
ef88fd3
Merge branch 'main' into update-nav
colleenmcginnis Mar 24, 2025
ffa8980
Refactor navigation handling and introduce phantom support
Mpdreamz Mar 24, 2025
be3bf15
Merge remote-tracking branch 'origin/main' into update-nav
Mpdreamz Mar 24, 2025
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
add release notes config from @KOTungseth
@colleenmcginnis
colleenmcginnis committed Mar 19, 2025
commit 417f7af53a14c57d3e7363d1e67cc9ca7f3b9dd2
1 change: 1 addition & 0 deletions src/docs-assembler/assembler.yml
View file
Original file line number Diff line number Diff line change
@@ -35,6 +35,7 @@ references:
skip: true
apm-aws-lambda:
apm-k8s-attacher:
apm-server:
beats:
skip: true
cloud-on-k8s:
156 changes: 104 additions & 52 deletions src/docs-assembler/navigation.yml
View file
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
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
- 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

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

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

Unchanged files with check annotations Beta

View file
docs/development/index.md
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'.
View file
docs/_docset.yml
project: 'doc-builder'

Check notice on line 1 in docs/_docset.yml

GitHub Actions / build 

Substitution key 'ece' is not used in any file

Check notice on line 1 in docs/_docset.yml

GitHub Actions / build 

Substitution key 'eck' is not used in any file
max_toc_depth: 2
# indicates this documentation set is not linkable by assembler.
# relaxes a few restrictions around toc building and file placement