From 28c8985fb11c37c507a32289cd5b4111566dff24 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Mon, 24 Mar 2025 10:50:06 -0500 Subject: [PATCH 1/3] update docset.yml, add reference/toc.yml, update reference/elasticsearch/index.md --- docs/docset.yml | 11 ++--------- docs/reference/elasticsearch/index.md | 19 ++++++++++++++++++- docs/reference/toc.yml | 10 ++++++++++ 3 files changed, 30 insertions(+), 10 deletions(-) create mode 100644 docs/reference/toc.yml diff --git a/docs/docset.yml b/docs/docset.yml index 9ebcf3b966f82..0e573c240932b 100644 --- a/docs/docset.yml +++ b/docs/docset.yml @@ -1,4 +1,5 @@ project: 'Elasticsearch' +max_toc_depth: 3 exclude: - README.md - internal/* @@ -22,15 +23,7 @@ cross_links: - kibana - logstash toc: - - 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 - toc: release-notes - toc: extend subs: diff --git a/docs/reference/elasticsearch/index.md b/docs/reference/elasticsearch/index.md index fd75632ea62a0..5e23cb0854291 100644 --- a/docs/reference/elasticsearch/index.md +++ b/docs/reference/elasticsearch/index.md @@ -1 +1,18 @@ -# Elasticsearch and index management \ No newline at end of file +# Elasticsearch and index management + +% TO-DO: Add links to "Elasticsearch basics"% + +This section contains reference information for Elasticsearch and index management features, including: + +* Settings +* Security roles and privileges +* Index lifecycle actions +* Mappings +* Command line tools +* Curator +* Clients + +% TO-DO: Add links to "query language and scripting language sections"% + +Elasticsearch also provides REST APIs that are used by the UI components and can be called directly to configure and access Elasticsearch features. +Refer to [Elasticsearch API](https://www.elastic.co/docs/api/doc/elasticsearch) and [Elasticsearch Serverless API](https://www.elastic.co/docs/api/doc/elasticsearch-serverless). \ No newline at end of file diff --git a/docs/reference/toc.yml b/docs/reference/toc.yml new file mode 100644 index 0000000000000..a2a315bbda578 --- /dev/null +++ b/docs/reference/toc.yml @@ -0,0 +1,10 @@ +toc: + - toc: elasticsearch + - toc: community-contributed + - toc: enrich-processor + - toc: search-connectors + - toc: elasticsearch-plugins + - toc: query-languages + - toc: scripting-languages + - toc: text-analysis + - toc: aggregations \ No newline at end of file From 197b225a1f0e11a6f7b9ce81e2822e33952b4069 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Mon, 24 Mar 2025 11:05:16 -0500 Subject: [PATCH 2/3] Update docs/docset.yml --- docs/docset.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docset.yml b/docs/docset.yml index 0e573c240932b..de4c3a9587afe 100644 --- a/docs/docset.yml +++ b/docs/docset.yml @@ -1,5 +1,5 @@ project: 'Elasticsearch' -max_toc_depth: 3 +max_toc_depth: 2 exclude: - README.md - internal/* From 8789e5f7568b42bb1a27266e3e05f8f76340c5c4 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Mon, 24 Mar 2025 11:21:16 -0500 Subject: [PATCH 3/3] add index.md --- docs/reference/index.md | 1 + docs/reference/toc.yml | 1 + 2 files changed, 2 insertions(+) create mode 100644 docs/reference/index.md diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 0000000000000..4a938e09d06b2 --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1 @@ +# Reference \ No newline at end of file diff --git a/docs/reference/toc.yml b/docs/reference/toc.yml index a2a315bbda578..581fe8b12d6c0 100644 --- a/docs/reference/toc.yml +++ b/docs/reference/toc.yml @@ -1,4 +1,5 @@ toc: + - file: index.md - toc: elasticsearch - toc: community-contributed - toc: enrich-processor