diff --git a/docs/source/docset.yml b/docs/source/docset.yml index 7ff9426..5c88449 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -46,3 +46,9 @@ toc: - folder: content - file: index.md - folder: versioning + - folder: reference-overview + children: + - file: index.md + - file: elasticsearch-reference.md + children: + - file: elasticsearch-configuration.md \ No newline at end of file diff --git a/docs/source/elastic/reference-overview/elasticsearch-configuration.md b/docs/source/elastic/reference-overview/elasticsearch-configuration.md new file mode 100644 index 0000000..09e1166 --- /dev/null +++ b/docs/source/elastic/reference-overview/elasticsearch-configuration.md @@ -0,0 +1,34 @@ +--- +title: Elasticsearch configuration reference +navigation_title: "Configuration reference" +--- + +Configuration settings enable you to customize the behavior of Elasticsearch features. +This reference provides details about each setting, such as its purpose, default behavior, and availability in Elastic Cloud environments. + +% TO-DO: For information about how to update these settings, refer to "Configure Elasticsearch" (link to appropriate deployment pages) % + +The settings are grouped by feature or purpose, for example: + +- Auditing +- Circuit breaker +- Cluster formation, discovery, and networking +- Cross-cluster replication +- Data stream lifecycle +- Field data cache +- Local gateway +- Health diagnostic +- Index lifecycle management, index management, recovery, and buffer +- Inference +- License +- Machine learning +- Monitoring +- Nodes and node query cache +- Path +- Search +- Security +- Shard allocation, shard request cache, and routing +- Snapshot and restore +- Transforms +- Thread pools +- Watcher \ No newline at end of file diff --git a/docs/source/elastic/reference-overview/elasticsearch-reference.md b/docs/source/elastic/reference-overview/elasticsearch-reference.md new file mode 100644 index 0000000..5587e3e --- /dev/null +++ b/docs/source/elastic/reference-overview/elasticsearch-reference.md @@ -0,0 +1,22 @@ +--- +title: Elasticsearch reference +nav_title: 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/source/elastic/reference-overview/index.md b/docs/source/elastic/reference-overview/index.md new file mode 100644 index 0000000..3d06890 --- /dev/null +++ b/docs/source/elastic/reference-overview/index.md @@ -0,0 +1,5 @@ +--- +title: Reference +--- + +This is a placeholder for the top-level reference overview. \ No newline at end of file