You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: get-started/howto-use-the-docs.md
+16-9Lines changed: 16 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,10 @@
1
1
# How to use the documentation
2
2
3
-
Our documentation is organized to guide you through your journey with Elastic, from learning the basics to deploying and managing complex solutions.
3
+
Our documentation is organized to guide you through your journey with Elastic, from learning the basics to deploying and managing complex solutions.
4
4
5
5
Here is a detailed breakdown of the documentation structure:
6
6
7
-
*[**Elastic fundamentals**](/get-started/index.md): Understand the basics of Elasticsearch and the Elastic Stack, deployment options, and key use cases.
7
+
*[**Elastic fundamentals**](/get-started/index.md): Understand the basics about the deployment options, platform, and solutions, and features of the documentation.
8
8
*[**Solutions and use cases**](/solutions/index.md): Learn use cases, evaluate, and implement Elastic's solutions: Observability, Search, and Security.
9
9
*[**Manage data**](/manage-data/index.md): Learn about data store primitives, ingestion and enrichment, managing the data lifecycle, and migrating data.
10
10
*[**Explore and analyze**](/explore-analyze/index.md): Get value from data through querying, visualization, machine learning, and alerting.
@@ -13,14 +13,18 @@ Here is a detailed breakdown of the documentation structure:
13
13
*[**Troubleshoot**](/troubleshoot/index.md): Identify and resolve problems.
14
14
*[**Extend and contribute**](/extend/index.md): How to contribute to or integrate with Elastic, from open source to plugins to integrations.
15
15
*[**Release notes**](/release-notes/index.md): Contains release notes and changelogs for each new release.
16
-
*[**Reference**](/reference/index.md): Reference material for core tasks and manuals for optional products.
16
+
*[**Reference**](/reference/index.md): Reference material for core tasks and manuals for optional products.
17
17
18
18
## Applicability badges
19
19
20
-
Because Elastic products can be deployed in different ways (like on Elastic Cloud or in your own data center) and have different versions, not all documentation applies to every user. To help you quickly see if a topic is relevant to your situation, we use **applicability badges**.
20
+
Because Elastic products can be deployed in different ways (like on {{ecloud}} or in your own data center) and have different versions, not all documentation applies to every user. To help you quickly see if a topic is relevant to your situation, we use **applicability badges**.
21
21
22
22
These badges appear at the top of a page or section and tell you which products, deployment models, and versions the content applies to. They also indicate the maturity level of a feature, such as **beta**, **technical preview**, or **generally available (GA)**. This system ensures that you can identify content specific to your environment and version.
23
23
24
+
:::{tip}
25
+
An {{stack}} badge indicates that a page applies to [{{search-platform}}](/get-started/search-ai-platform.md) components across all deployment options except {{serverless-full}}. If a page applies to all deployment options, it will have both {{serverless-short}} and Stack badges.
26
+
:::
27
+
24
28
## Page options
25
29
26
30
On each documentation page, you'll find several links that allow you to interact with the content:
@@ -47,18 +51,21 @@ We clearly mark content added or changed in a specific version using availabilit
47
51
48
52
This means the feature is:
49
53
50
-
* Available on Elastic Stack
51
-
* Generally Available (GA)
54
+
* Generally Available (GA) in the [{{search-platform}}](/get-started/search-ai-platform.md) across all deployment options except {{serverless-full}}
52
55
* Introduced in version 9.1.0
53
56
57
+
:::{tip}
58
+
If a page applies to all deployment options including {{serverless-full}}, it will have both {{serverless-short}} and Stack badges.
* Generally Available for Elasticsearch Serverless projects
61
-
* Beta for Elastic Security Serverless projects
67
+
* Generally Available for {{es-serverless}} projects
68
+
* Beta for {{sec-serverless}} projects
62
69
63
70
### Elastic Cloud Enterprise example
64
71
@@ -155,7 +162,7 @@ Find the documentation for your Elastic product versions or releases.
155
162
|[Elastic APM AWS Lambda extension](https://www.elastic.co/docs/release-notes/apm/aws-lambda/release-notes)| 1.0.0 and later |
156
163
|[Elastic APM Attacher for Kubernetes](https://www.elastic.co/docs/reference/apm/k8s-attacher)| 1.1.3 |
157
164
158
-
## Glossary
165
+
## Glossary
159
166
160
167
To help you understand the terminology used throughout our documentation, we provide a [glossary of common Elastic terms](/reference/glossary/index.md). This is a great resource for new users or anyone looking to clarify the meaning of a specific term.
Copy file name to clipboardExpand all lines: get-started/search-ai-platform.md
+9-6Lines changed: 9 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,17 +11,20 @@ products:
11
11
# {{search-platform}}
12
12
13
13
Elastic provides a fusion of search technology and artifical intelligence in the [{{search-platform}}](https://www.elastic.co/platform).
14
-
It is the foundation for Elastic's two out-of-the-box [solutions](/get-started/introduction.md) and is the platform of choice for developers seeking to build next generation, generative AI powered applications and services.
14
+
It is the foundation for Elastic's [solutions](/get-started/introduction.md) and for developers seeking to build next generation, generative AI powered applications and services.
15
15
16
-
The {{search-platform}} evolved from the {{stack}} and continues to be open by design.
17
-
It's a fast and highly scalable set of components — {{es}}, {{kib}}, {{beats}}, {{ls}}, and others — that together enable you to securely take data from any source, in any format, and then store, search, analyze, and visualize it.
18
-
19
-
You have many options for deploying the {{search-platform}} to suit your needs, which are summarized in [](/get-started/deployment-options.md).
16
+
The {{search-platform}} is a fast and highly scalable set of components — {{es}}, {{kib}}, {{beats}}, {{ls}}, and others — that together enable you to securely take data from any source, in any format, and then store, search, analyze, and visualize it.
20
17
21
18
:::{tip}
19
+
The components that share the same versioning scheme are often referred to as the _{{stack}}_. Learn more in [](/get-started/versioning-availability.md).
20
+
:::
21
+
22
+
You have many options for deploying the {{search-platform}} to suit your needs, which are summarized in [](/get-started/deployment-options.md).
23
+
<!--
24
+
TBD: Is this necessary to cover here? How can we make this easier to understand and navigation?
22
25
To learn how to deploy {{es}}, {{kib}}, and supporting orchestration technologies, refer to [](/deploy-manage/index.md).
23
26
To learn how to deploy additional ingest and consume components, refer to the documentation for the component.
24
-
:::
27
+
-->
25
28
26
29
Continue reading to learn how these components work together.
Copy file name to clipboardExpand all lines: get-started/versioning-availability.md
+7-8Lines changed: 7 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,17 +13,20 @@ Learn how Elastic products are versioned, the lifecycle of features, and how to
13
13
14
14
## Understanding versioning
15
15
16
-
Most Elastic products, like {{es}} or {{kib}}, share the same versioning pattern, based on the {{stack}}. Orchestrators such as {{ece}} and {{eck}}, and other tools such as code clients and SDKs, are versioned independently of the Elastic Stack. The {{ecloud}} console and {{serverless-short}} projects are always automatically updated with the latest changes.
16
+
Many components of the [{{search-platform}}](/get-started/search-ai-platform.md) (such as {{es}} and {{kib}}) share the same versioning pattern.
17
+
In the documentation, this group of components is typically referred to as the {{stack}}.
17
18
18
-
The Elastic Stack products use semantic versioning in the `X.Y.Z` format, such as `9.0.0`.
19
+
Orchestrators such as {{ece}} and {{eck}}, and other tools such as code clients and SDKs, are versioned independently of the {{search-platform}}. The {{ecloud}} console and {{serverless-short}} projects are always automatically updated with the latest changes.
20
+
21
+
The components of the {{search-platform}} generally use semantic versioning in the `X.Y.Z` format, such as `9.0.0`.
19
22
20
23
| Version | Description |
21
24
| ----- | ----- |
22
25
| Major (X) | Indicates significant changes, such as new features, breaking changes, and major enhancements. Upgrading to a new major version may require changes to your existing setup and configurations. |
23
26
| Minor (Y) | Introduces new features and improvements, while maintaining backward compatibility with the previous minor versions within the same major version. Upgrading to a new minor version should not require any changes to your existing setup. |
24
27
| Patch (Z) | Contains bug fixes and security updates, without introducing new features or breaking changes. Upgrading to a new patch version should be seamless and not require any changes to your existing setup. |
25
28
26
-
Understanding Elastic Stack versioning is essential for [upgrade planning](/deploy-manage/upgrade.md) and ensuring compatibility.
29
+
Understanding versioning is essential for [upgrade planning](/deploy-manage/upgrade.md) and ensuring compatibility, particularly in the self-managed [deployment option](/get-started/deployment-options.md).
27
30
28
31
## Availability of features
29
32
@@ -52,11 +55,7 @@ Features available to you can differ based on deployment type, product lifecycle
52
55
53
56
| Category | Example |
54
57
| ----- | ----- |
55
-
|Elastic Stack versions |[{{search-platform}}](/get-started/search-ai-platform.md) version 9.0.0 and later, including 9.1.0 |
58
+
|Platform product or component versions |{{stack}} version 9.0.0 and later, including 9.1.0 |
56
59
| Deployment types |[{{serverless-full}}](/deploy-manage/deploy/elastic-cloud/serverless.md), [{{ech}}](/deploy-manage/deploy/elastic-cloud/cloud-hosted.md), [{{ece}}](/deploy-manage/deploy/cloud-enterprise.md), [{{eck}}](/deploy-manage/deploy/cloud-on-k8s.md), and [Self-managed deployments](/deploy-manage/deploy/self-managed.md)|
57
60
| Orchestrator versions |[{{ece}}](/deploy-manage/deploy/cloud-enterprise.md) 4.0.0 and later, [{{eck}}](/deploy-manage/deploy/cloud-on-k8s.md) 3.0.0 and later |
0 commit comments