[docs] Prepare for docs-assembler#125118
Conversation
docs/docset.yml
Outdated
| - file: reference/index.md | ||
| children: | ||
| - toc: reference/elasticsearch | ||
| - toc: reference/community-contributed | ||
| - toc: reference/enrich-processor | ||
| - toc: reference/search-connectors | ||
| - toc: reference/elasticsearch-plugins | ||
| - toc: reference/query-languages | ||
| - toc: reference/scripting-languages | ||
| - toc: reference/text-analysis | ||
| - toc: reference/aggregations |
There was a problem hiding this comment.
| - file: reference/index.md | |
| children: | |
| - toc: reference/elasticsearch | |
| - toc: reference/community-contributed | |
| - toc: reference/enrich-processor | |
| - toc: reference/search-connectors | |
| - toc: reference/elasticsearch-plugins | |
| - toc: reference/query-languages | |
| - toc: reference/scripting-languages | |
| - toc: reference/text-analysis | |
| - toc: reference/aggregations | |
| - toc: reference | |
with reference/toc.yml holding:
children:
- toc: elasticsearch
- toc: community-contributed
- toc: enrich-processor
- toc: search-connectors
- toc: elasticsearch-plugins
- toc: query-languages
- toc: scripting-languages
- toc: text-analysis
- toc: aggregationsOtherwise it will trip the new validations: elastic/docs-builder#767
There was a problem hiding this comment.
I thought toc.yml files couldn't contain toc:s (only docset.yml can use toc:) or does elastic/docs-builder#767 also change that, too?
There was a problem hiding this comment.
there is no restriction on files origin, just depth so toc.yml file can hold toc.yml files as long as max_toc_depth is adhered too.
|
Pinging @elastic/es-docs (Team:Docs) |
@craigtaverner is this going to impact anything on your side? FYI some paths have been updated for a few esql pages |
leemthompo
left a comment
There was a problem hiding this comment.
Folder rationalization and link path updates LGTM
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
* reorg files for docs-assembler and create toc.yml files * fix build error, add redirects * only toc * move images (cherry picked from commit 9bcd595) # Conflicts: # docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation.md # docs/reference/query-languages/esql/esql-commands.md # docs/reference/query-languages/esql/esql-lookup-join.md # docs/reference/query-languages/esql/esql-process-data-with-dissect-grok.md # docs/reference/query-languages/images/esql-lookup-join.png # docs/reference/query-languages/toc.yml # docs/reference/search-connectors/es-connectors-run-from-docker.md # docs/reference/text-analysis/analysis-apostrophe-tokenfilter.md # docs/reference/toc.yml
* [docs] Prepare for docs-assembler (#125118) * reorg files for docs-assembler and create toc.yml files * fix build error, add redirects * only toc * move images (cherry picked from commit 9bcd595) # Conflicts: # docs/reference/aggregations/search-aggregations-pipeline-bucket-script-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-cumulative-cardinality-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-cumulative-sum-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-derivative-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-extended-stats-bucket-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-max-bucket-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-min-bucket-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-percentiles-bucket-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-stats-bucket-aggregation.md # docs/reference/aggregations/search-aggregations-pipeline-sum-bucket-aggregation.md # docs/reference/query-languages/esql/esql-commands.md # docs/reference/query-languages/esql/esql-lookup-join.md # docs/reference/query-languages/esql/esql-process-data-with-dissect-grok.md # docs/reference/query-languages/images/esql-lookup-join.png # docs/reference/query-languages/toc.yml # docs/reference/search-connectors/es-connectors-run-from-docker.md # docs/reference/text-analysis/analysis-apostrophe-tokenfilter.md # docs/reference/toc.yml * remove markers --------- Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
* reorg files for docs-assembler and create toc.yml files * fix build error, add redirects * only toc * move images
* reorg files for docs-assembler and create toc.yml files * fix build error, add redirects * only toc * move images
Clean up some Elasticsearch redirects after elastic/elasticsearch#125118
* reorg files for docs-assembler and create toc.yml files * fix build error, add redirects * only toc * move images
Related to elastic/docs-content#792
Restructure content and create
toc.ymlfiles needed by docs-assembler.Restructured content so all
toc.ymlcan be 2 or fewer levels below thedocs/directory:docs/reference/data-analysisdirectory and put the subdirectories up a level (docs/reference/data-analysis/aggregations→docs/reference/aggregationsanddocs/reference/data-analysis/text-analysis→docs/reference/text-analysis).docs/reference/ingestion-toolsdirectory and put the subdirectories up a level (docs/reference/ingestion-tools/enrich-processor→docs/reference/enrich-processoranddocs/reference/ingestion-tools/search-connectors→docs/reference/search-connectors).Because of how we need to distribute files throughout the new IA, I think we need to create 9 unique
toc.ymlfiles:docs/reference/aggregations/toc.ymldocs/reference/data-analysis/aggregations/*todocs/reference/aggregations/*, I added atoc.ymlfile that contains just the pages related to aggregations to be inserted into the Data analysis section of the overall IA.docs/reference/community-contributed/toc.ymldocs/reference/community-contributed.mdtodocs/reference/community-contributed/index.mdso we could also add atoc.ymlfile with one page to be inserted into the Elasticsearch and index management / Clients section of the overall IA.docs/reference/elasticsearch/toc.ymltoc.ymlthat contains just the pages that belong at the top level of the Elasticsearch and index management section in the overall IA.docs/reference/elasticsearch-plugins/toc.ymltoc.ymlthat contains just the pages that belong in the Elasticsearch plugins section in the overall IA.docs/reference/enrich-processor/toc.ymldocs/reference/ingestion-docs/enrich-processor/*todocs/reference/enrich-processor/*, I added atoc.ymlfile that contains just the pages related to enrich processors to be inserted into the Ingestion tools section of the overall IA.docs/reference/query-languages/toc.ymltoc.ymlthat contains just the pages that belong in the Query languages section in the overall IA.docs/reference/scripting-languages/toc.ymltoc.ymlthat contains just the pages that belong in the Scripting languages section in the overall IA.docs/reference/search-connectors/toc.ymldocs/reference/ingestion-docs/search-connectors/*todocs/reference/search-connectors/*, I added atoc.ymlfile that contains just the pages related to search connectors to be inserted into the Ingestion tools section of the overall IA.docs/reference/text-analysis/toc.ymldocs/reference/data-analysis/text-analysis/*todocs/reference/text-analysis/*, I added atoc.ymlfile that contains just the pages related to text analysis to be inserted into the Data analysis section of the overall IA.cc @Mpdreamz