Skip to content
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/source/docset.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
project: 'doc-builder'

Check failure on line 1 in docs/source/docset.yml

View workflow job for this annotation

GitHub Actions / docs

Not linked in toc: elastic/reference-overview/index.md

Check failure on line 1 in docs/source/docset.yml

View workflow job for this annotation

GitHub Actions / docs

Not linked in toc: elastic/reference-overview/elasticsearch-configuration.md

Check failure on line 1 in docs/source/docset.yml

View workflow job for this annotation

GitHub Actions / docs

Not linked in toc: elastic/reference-overview/elasticsearch-reference.md

Check failure on line 1 in docs/source/docset.yml

View workflow job for this annotation

GitHub Actions / docs

The following file could not be located: reference-overview/index.md it may be excluded from the build in docset.yml

Check failure on line 1 in docs/source/docset.yml

View workflow job for this annotation

GitHub Actions / docs

The following file could not be located: reference-overview/elasticsearch-reference.md it may be excluded from the build in docset.yml
# docs-builder will warn for links to external hosts not declared here
external_hosts:
- slack.com
Expand Down Expand Up @@ -46,3 +46,9 @@
- folder: content
- file: index.md
- folder: versioning
- folder: reference-overview

Check failure on line 49 in docs/source/docset.yml

View workflow job for this annotation

GitHub Actions / docs

Directory '/github/workspace/docs/source/reference-overview' does not exist
children:
- file: index.md

Check failure on line 51 in docs/source/docset.yml

View workflow job for this annotation

GitHub Actions / docs

File '/github/workspace/docs/source/reference-overview/index.md' does not exist
- file: elasticsearch-reference.md

Check failure on line 52 in docs/source/docset.yml

View workflow job for this annotation

GitHub Actions / docs

File '/github/workspace/docs/source/reference-overview/elasticsearch-reference.md' does not exist
children:
- file: elasticsearch-configuration.md

Check failure on line 54 in docs/source/docset.yml

View workflow job for this annotation

GitHub Actions / docs

File '/github/workspace/docs/source/reference-overview/elasticsearch-configuration.md' does not exist
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: lasticsearch configuration reference
navigation_title: "Configuration reference"

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
navigation_title: "Configuration reference"
navigation_title: "Configuration reference"

Do we want to keep the term "reference" in the navigation title?

---

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
22 changes: 22 additions & 0 deletions docs/source/elastic/reference-overview/elasticsearch-reference.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Elasticsearch reference
nav_title: Elasticsearch and index management
---


% TO-DO: Add links to "Elasticsearch basics"%

This section of the documentation 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).
5 changes: 5 additions & 0 deletions docs/source/elastic/reference-overview/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Reference
---

This is a placeholder for the top-level reference overview.
Loading