diff --git a/docs/docset.yml b/docs/docset.yml index 9ebcf3b966f82..de4c3a9587afe 100644 --- a/docs/docset.yml +++ b/docs/docset.yml @@ -1,4 +1,5 @@ project: 'Elasticsearch' +max_toc_depth: 2 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/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 new file mode 100644 index 0000000000000..581fe8b12d6c0 --- /dev/null +++ b/docs/reference/toc.yml @@ -0,0 +1,11 @@ +toc: + - file: index.md + - 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