Skip to content

Commit 63d5896

Browse files
add signposts to docs-content (#124866)
1 parent 595186a commit 63d5896

File tree

9 files changed

+53
-0
lines changed

9 files changed

+53
-0
lines changed

docs/reference/elasticsearch-plugins/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ mapped_pages:
66

77
# Elasticsearch plugins [intro]
88

9+
:::{note}
10+
This section provides detailed **reference information** for Elasticsearch plugins.
11+
12+
Refer to [Add plugins and extensions](docs-content://deploy-manage/deploy/elastic-cloud/add-plugins-extensions.md) in the **Deploy and manage** section for overview, getting started and conceptual information.
13+
:::
14+
915
Plugins are a way to enhance the core Elasticsearch functionality in a custom manner. They range from adding custom mapping types, custom analyzers, native scripts, custom discovery and more.
1016

1117
Plugins contain JAR files, but may also contain scripts and config files, and must be installed on every node in the cluster. After installation, each node must be restarted before the plugin becomes visible.

docs/reference/elasticsearch/configuration-reference/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ navigation_title: "Configuration"
44

55
# Elasticsearch configuration reference
66

7+
:::{note}
8+
This section provides detailed **reference information** for Elasticsearch configuration.
9+
10+
Refer to [Elasticsearch configuration](docs-content://deploy-manage/deploy/cloud-on-k8s/elasticsearch-configuration.md) in the **Deploy and manage** section for overview, getting started and conceptual information.
11+
:::
12+
713
Configuration settings enable you to customize the behavior of Elasticsearch features.
814
This reference provides details about each setting, such as its purpose, default behavior, and availability in Elastic Cloud environments.
915

docs/reference/elasticsearch/elasticsearch-audit-events.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ applies_to:
1010

1111
# Elasticsearch audit events [elasticsearch-audit-events]
1212

13+
:::{note}
14+
This section provides detailed **reference information** for Elasticsearch audit events.
15+
16+
Refer to [Security event audit logging](docs-content://deploy-manage/security/logging-configuration/security-event-audit-logging.md) in the **Deploy and manage** section for overview, getting started and conceptual information about audit logging.
17+
:::
18+
1319
When you are [auditing security events](docs-content://deploy-manage/monitor/logging-configuration/enabling-audit-logs.md), a single client request might generate multiple audit events, across multiple cluster nodes. The common `request.id` attribute can be used to correlate the associated events.
1420

1521
This document provides a reference for all types of audit events and their associated [attributes](#audit-event-attributes) in {{es}}. Use [audit event settings](./configuration-reference/auding-settings.md) options to control what gets logged.

docs/reference/elasticsearch/index-lifecycle-actions/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ mapped_pages:
55

66
# Index lifecycle actions [ilm-actions]
77

8+
:::{note}
9+
This section provides detailed **reference information** for Index lifecycle actions.
10+
11+
Refer to [Index lifecycle management](docs-content://manage-data/lifecycle/index-lifecycle-management.md) in the **Manage data** section for overview, getting started and conceptual information.
12+
:::
13+
814
[Allocate](/reference/elasticsearch/index-lifecycle-actions/ilm-allocate.md)
915
: Move shards to nodes with different performance characteristics and reduce the number of replicas.
1016

docs/reference/elasticsearch/mapping-reference/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@ navigation_title: "Mapping"
33
---
44
# Mapping reference
55

6+
:::{note}
7+
This section provides detailed **reference information** for mapping.
8+
9+
Refer to [Mapping](docs-content://manage-data/data-store/mapping.md) in the **Manage data** section for overview, getting started and conceptual information.
10+
:::
11+
612
Mappings are defined dynamically or explicitly for each document in Elasticsearch.
713
This section contains explanations for the following mapping components:
814

docs/reference/elasticsearch/roles.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ mapped_pages:
55

66
# Roles [built-in-roles]
77

8+
:::{note}
9+
This section provides detailed **reference information** for Elasticsearch privileges.
10+
11+
Refer to [User roles](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md) in the **Deploy and manage** section for overview, getting started and conceptual information.
12+
:::
13+
814
The {{stack-security-features}} apply a default role to all users, including [anonymous users](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/anonymous-access.md). The default role enables users to access the authenticate endpoint, change their own passwords, and get information about themselves.
915

1016
There is also a set of built-in roles you can explicitly assign to users. These roles have a fixed set of privileges and cannot be updated.

docs/reference/elasticsearch/security-privileges.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ mapped_pages:
55

66
# Elasticsearch privileges [security-privileges]
77

8+
:::{note}
9+
This section provides detailed **reference information** for Elasticsearch privileges.
10+
11+
Refer to [User roles](docs-content://deploy-manage/users-roles/cluster-or-deployment-auth/user-roles.md) in the **Deploy and manage** section for more information on how role-based access control works.
12+
:::
13+
814
This section lists the privileges that you can assign to a role.
915

1016
## Cluster privileges [privileges-list-cluster]

docs/reference/ingestion-tools/enrich-processor/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ mapped_pages:
66

77
# Ingest processor reference [processors]
88

9+
:::{note}
10+
This section provides detailed **reference information** for ingest processors.
11+
12+
Refer to [Transform and enrich data](docs-content://manage-data/ingest/transform-enrich.md) in the **Manage data** section for overview and conceptual information.
13+
:::
914

1015
An [ingest pipeline](docs-content://manage-data/ingest/transform-enrich/ingest-pipelines.md) is made up of a sequence of processors that are applied to documents as they are ingested into an index. Each processor performs a specific task, such as filtering, transforming, or enriching data.
1116

docs/reference/query-languages/index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ applies_to:
55
---
66
# Query languages
77

8+
:::{note}
9+
This section provides detailed **reference information** for query languages.
10+
11+
Refer to [Query Languages](docs-content://explore-analyze/query-filter/languages.md) in the **Explore and analyze** section for overview, getting started and conceptual information.
12+
:::
13+
814
This section contains reference information for Elastic query languages.
915

1016
* [Query DSL](querydsl.md)

0 commit comments

Comments
 (0)