Skip to content

Commit 3e0a07b

Browse files
committed
Edit more stack references in get-started
1 parent a0cc0e9 commit 3e0a07b

File tree

3 files changed

+32
-23
lines changed

3 files changed

+32
-23
lines changed

get-started/howto-use-the-docs.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# How to use the documentation
22

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.
44

55
Here is a detailed breakdown of the documentation structure:
66

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.
88
* [**Solutions and use cases**](/solutions/index.md): Learn use cases, evaluate, and implement Elastic's solutions: Observability, Search, and Security.
99
* [**Manage data**](/manage-data/index.md): Learn about data store primitives, ingestion and enrichment, managing the data lifecycle, and migrating data.
1010
* [**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:
1313
* [**Troubleshoot**](/troubleshoot/index.md): Identify and resolve problems.
1414
* [**Extend and contribute**](/extend/index.md): How to contribute to or integrate with Elastic, from open source to plugins to integrations.
1515
* [**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.
1717

1818
## Applicability badges
1919

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**.
2121

2222
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.
2323

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+
2428
## Page options
2529

2630
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
4751

4852
This means the feature is:
4953

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}}
5255
* Introduced in version 9.1.0
5356

57+
:::{tip}
58+
If a page applies to all deployment options including {{serverless-full}}, it will have both {{serverless-short}} and Stack badges.
59+
:::
60+
5461
### Serverless example
5562

5663
{applies_to}`serverless: ga` {applies_to}`security: beta`
5764

5865
This means the feature is:
5966

60-
* 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
6269

6370
### Elastic Cloud Enterprise example
6471

@@ -155,7 +162,7 @@ Find the documentation for your Elastic product versions or releases.
155162
| [Elastic APM AWS Lambda extension](https://www.elastic.co/docs/release-notes/apm/aws-lambda/release-notes) | 1.0.0 and later |
156163
| [Elastic APM Attacher for Kubernetes](https://www.elastic.co/docs/reference/apm/k8s-attacher) | 1.1.3 |
157164

158-
## Glossary
165+
## Glossary
159166

160167
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.
161168

get-started/search-ai-platform.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,20 @@ products:
1111
# {{search-platform}}
1212

1313
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.
1515

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.
2017

2118
:::{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?
2225
To learn how to deploy {{es}}, {{kib}}, and supporting orchestration technologies, refer to [](/deploy-manage/index.md).
2326
To learn how to deploy additional ingest and consume components, refer to the documentation for the component.
24-
:::
27+
-->
2528

2629
Continue reading to learn how these components work together.
2730

get-started/versioning-availability.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,20 @@ Learn how Elastic products are versioned, the lifecycle of features, and how to
1313

1414
## Understanding versioning
1515

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}}.
1718

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`.
1922

2023
| Version | Description |
2124
| ----- | ----- |
2225
| 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. |
2326
| 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. |
2427
| 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. |
2528

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).
2730

2831
## Availability of features
2932

@@ -52,11 +55,7 @@ Features available to you can differ based on deployment type, product lifecycle
5255

5356
| Category | Example |
5457
| ----- | ----- |
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 |
5659
| 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) |
5760
| 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 |
5861
| Serverless project types | {{es}}, Elastic {{observability}}, and {{elastic-sec}} |
59-
60-
61-
62-

0 commit comments

Comments
 (0)