Skip to content

Commit aadaeca

Browse files
add code comments with context
1 parent d20bc86 commit aadaeca

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

src/docs-assembler/navigation.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,14 +219,46 @@ toc:
219219
path_prefix: reference/ingestion-tools
220220
children:
221221
# I don't know (TODO discuss with Colleen)
222+
223+
# In https://github.com/elastic/elasticsearch/pull/125118 I'm proposing we move
224+
# reference/ingestion-tools/enrich-processor/toc.yml to
225+
# reference/enrich-processor/toc.yml AND move all the related Markdown files from
226+
# reference/ingestion-tools/enrich-processor/*.md to
227+
# reference/enrich-processor/*.md
228+
#
229+
# If we merge that PR, would that remove the need for this item?
222230
- toc: elasticsearch://reference/ingestion-tools/enrich-processor
223231
path_prefix: reference/elasticsearch/enrich-processor
232+
233+
# In https://github.com/elastic/elasticsearch/pull/125118 I'm proposing we move
234+
# reference/ingestion-tools/search-connectors/toc.yml to
235+
# reference/search-connectors/toc.yml AND move all the related Markdown files from
236+
# reference/ingestion-tools/search-connectors/*.md to
237+
# reference/search-connectors/*.md
238+
#
239+
# If we merge that PR, would that remove the need for this item?
224240
- toc: elasticsearch://reference/ingestion-tools/search-connectors
225241
path_prefix: reference/elasticsearch/search-connectors
242+
243+
# I'm not sure what's going on with this one because there is no
244+
# toc.yml in reference/elasticsearch/data-analysis/* on `main`.
245+
# Currently these pages are captured in the higher level reference/toc.yml.
246+
# In https://github.com/elastic/elasticsearch/pull/125118 I'm proposing we remove
247+
# reference/toc.yml and distribute the contents across 9 individual toc.yml files.
226248
- toc: elasticsearch://reference/data-analysis
227249
path_prefix: reference/elasticsearch/data-analysis
250+
251+
# This makes sense for now. I'm not sure when these files will be
252+
# moved to https://github.com/elastic/detection-rules.
228253
- toc: security-docs://reference/prebuilt-rules
229254
path_prefix: reference/prebuilt-rules
255+
256+
# In https://github.com/elastic/elasticsearch/pull/125118 I'm proposing we remove
257+
# reference/toc.yml altogether because the contents of that file will be
258+
# distributed across 9 individual toc.yml files in subdirectories alongside the
259+
# related Markdown files.
260+
#
261+
# If we merge that PR, would that remove the need for this item?
230262
- toc: elasticsearch://reference
231263
path_prefix: reference/elasticsearch
232264

0 commit comments

Comments
 (0)