Skip to content

Commit 3e252f9

Browse files
authored
Merge branch 'main' into add-edot-landing-pages
2 parents 5371a4e + 4b5e99d commit 3e252f9

File tree

96 files changed

+798
-238
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

96 files changed

+798
-238
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
Thank you for contributing to the Elastic Docs! 🎉
3+
Use this template to help us efficiently review your contribution.
4+
-->
5+
6+
## Summary
7+
<!--
8+
Describe what your PR changes or improves.
9+
If your PR fixes an issue, link it here. If your PR does not fix an issue, describe the reason you are making the change.
10+
-->
11+
12+
## Generative AI disclosure
13+
<!--
14+
To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following:
15+
-->
16+
1. Did you use a generative AI (GenAI) tool to assist in creating this contribution?
17+
- [ ] Yes
18+
- [ ] No
19+
<!--
20+
2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.).
21+
22+
Tool(s) and model(s) used:
23+
-->
24+

.github/workflows/vale-linting.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Vale Documentation Linting
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- '**.md'
7+
- '**.adoc'
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
vale:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v5
18+
with:
19+
fetch-depth: 0
20+
21+
- name: Run Vale Linter
22+
uses: elastic/vale-rules/lint@main
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Vale Report
2+
3+
on:
4+
workflow_run:
5+
workflows: ["Vale Documentation Linting"]
6+
types:
7+
- completed
8+
9+
permissions:
10+
pull-requests: read
11+
12+
jobs:
13+
report:
14+
runs-on: ubuntu-latest
15+
if: github.event.workflow_run.event == 'pull_request'
16+
permissions:
17+
pull-requests: write
18+
19+
steps:
20+
- name: Post Vale Results
21+
uses: elastic/vale-rules/report@main
22+
with:
23+
github_token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,7 @@ AGENTS.md
1212
.github/instructions/**.instructions.md
1313
CLAUDE.md
1414
GEMINI.md
15-
.cursor
15+
.cursor
16+
17+
# VS code settings
18+
.vscode

contribute-docs/api-docs/kibana-api-docs-quickstart.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ responses:
202202
:sync: code-generated
203203
204204
:::{note}
205-
**This step is optional.** CI will automatically capture the snapshot when you push your `.ts` changes. Running this locally is useful for validating changes before pushing or debugging issues. See [`capture_oas_snapshot.sh`](https://github.com/elastic/kibana/blob/main/.buildkite/scripts/steps/checks/capture_oas_snapshot.sh) for the full list of paths captured in CI.
205+
**This step is optional.** CI will automatically capture the snapshot when you push your `.ts` changes. Running this locally is useful for validating changes before pushing or debugging issues.
206206
:::
207207
208208
This step captures the OpenAPI specification that {{kib}} generates at runtime from your route definitions. It spins up a local {{es}} and {{kib}} cluster with your code changes. This generates the following output files in the `oas_docs` directory:
@@ -214,13 +214,27 @@ This step captures the OpenAPI specification that {{kib}} generates at runtime f
214214
- [Docker](https://docs.docker.com/get-docker/) must be running
215215
- If you're an Elastician, ensure you're logged into Docker with your Elastic account
216216
217-
**Capture all API paths** (recommended):
217+
To capture all the documented API paths, copy the command from [`capture_oas_snapshot.sh`](https://github.com/elastic/kibana/blob/main/.buildkite/scripts/steps/checks/capture_oas_snapshot.sh). For example:
218218
219219
```bash
220-
node scripts/capture_oas_snapshot --update
220+
node scripts/capture_oas_snapshot \
221+
--include-path /api/status \
222+
--include-path /api/alerting/rule/ \
223+
--include-path /api/alerting/rules \
224+
--include-path /api/actions \
225+
--include-path /api/security/role \
226+
--include-path /api/spaces \
227+
--include-path /api/streams \
228+
--include-path /api/fleet \
229+
--include-path /api/saved_objects/_import \
230+
--include-path /api/saved_objects/_export \
231+
--include-path /api/maintenance_window \
232+
--include-path /api/agent_builder
233+
--update
221234
```
222235
223-
**For faster iteration**, capture the specific paths you're working on:
236+
For faster iteration, you can capture the specific paths you're working on, though this minimized output should not be included in your pull request.
237+
For example:
224238

225239
```bash
226240
node scripts/capture_oas_snapshot --update --include-path /api/your/specific/path

deploy-manage/deploy/cloud-on-k8s.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ ECK is compatible with the following Kubernetes distributions and related techno
7777

7878
:::{tab-item} ECK 3.2
7979
* Kubernetes 1.30-1.34
80-
* OpenShift 4.15-4.19
80+
* OpenShift 4.15-4.20
8181
* Google Kubernetes Engine (GKE), Azure Kubernetes Service (AKS), and Amazon Elastic Kubernetes Service (EKS)
8282
* Helm: {{eck_helm_minimum_version}}+
8383
:::

deploy-manage/deploy/deployment-comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ For more details about feature availability in Serverless, check [](elastic-clou
1818

1919
| Feature/capability | Self-managed | {{ech}} | Serverless |
2020
|-------------------|-------------|--------------------------------|-------------------------|
21-
| Hosting | Any infrastructure | {{ecloud}} through AWS, Azure, or GCP | {{ecloud}} through AWS or Azure |
21+
| Hosting | Any infrastructure | {{ecloud}} through AWS, Azure, or GCP | {{ecloud}} through AWS, Azure, or GCP |
2222
| Hardware configuration | Full control | Limited control | Managed by Elastic |
2323
| Autoscaling | No | Available | Automatic |
2424
| Data tiers management | Through ILM policies | Available | No data tiers |

deploy-manage/deploy/elastic-cloud/differences-from-other-elasticsearch-offerings.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ This table compares Elasticsearch capabilities between {{ech}} deployments and S
8686
| [**AI Assistant**](/solutions/observability/observability-ai-assistant.md) ||| |
8787
| **Behavioral analytics** | ❌ (deprecated in 9.0) || Not available in Serverless |
8888
| [**Clone index API**](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-clone) || **Planned** | Anticipated in a future release |
89-
| [**Bulk indexing**](/deploy-manage/production-guidance/optimize-performance/indexing-speed.md#_use_bulk_requests) ||| The maximum bulk request response time in {{serverless-short}} is 200ms |
89+
| [**Bulk indexing**](/deploy-manage/production-guidance/optimize-performance/indexing-speed.md#_use_bulk_requests) ||| The baseline write latency in {{serverless-short}} is 200ms [^1^](#footnote-1) |
9090
| [**Cross-cluster replication**](/deploy-manage/tools/cross-cluster-replication.md) || **Planned** | Anticipated in a future release |
9191
| [**Cross-cluster search**](/solutions/search/cross-cluster-search.md) || **Planned** | Anticipated in a future release |
9292
| **Data lifecycle management** | - [ILM](/manage-data/lifecycle/index-lifecycle-management.md) <br>- [Data stream lifecycle](/manage-data/lifecycle/data-stream.md) | [Data stream lifecycle](/manage-data/lifecycle/data-stream.md) only | - No data tiers in Serverless <br>- Optimized for common lifecycle management needs |
@@ -103,6 +103,8 @@ This table compares Elasticsearch capabilities between {{ech}} deployments and S
103103
| [**Watcher**](/explore-analyze/alerts-cases/watcher.md) ||| Use **Kibana Alerts** instead, which provides rich integrations across use cases |
104104
| **Web crawler** | ❌ (Managed Elastic Crawler discontinued with Enterprise Search in 9.0) | Self-managed only | Use [**self-managed crawler**](https://github.com/elastic/crawler) |
105105

106+
^1^ $$$footnote-1$$$ In {{serverless-short}}, Elastic ensures data durability by storing indexed data in an [object store](https://www.elastic.co/blog/elastic-serverless-architecture) rather than local replicas. Writes are batched over a 200ms window to ensure durability while optimizing performance and cost, which means that single-document indexing can appear slower than in {{ech}}. However, this design makes {{serverless-short}} more scalable and resilient to high indexing loads without relying on in-cluster replication for fault tolerance. Because of a higher baseline write latency, {{serverless-short}} indexing can be scaled by increasing concurrent indexing clients.
107+
106108
### Observability
107109

108110
This table compares Observability capabilities between {{ech}} deployments and Observability Complete Serverless projects. For more information on Observability Logs Essentials Serverless projects, refer to [Observability feature tiers](../../../solutions/observability/observability-serverless-feature-tiers.md).

deploy-manage/deploy/self-managed/install-elasticsearch-docker-compose.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Use Docker Compose to start a three-node {{es}} cluster with {{kib}}. Docker Com
2323
2. Create or navigate to an empty directory for the project.
2424
3. Download and save the following files in the project directory:
2525

26-
* [`.env`](https://github.com/elastic/elasticsearch/blob/master/docs/reference/setup/install/docker/.env)
27-
* [`docker-compose.yml`](https://github.com/elastic/elasticsearch/blob/master/docs/reference/setup/install/docker/docker-compose.yml)
26+
* [`.env`](https://github.com/elastic/elasticsearch/blob/main/docs/reference/setup/install/docker/.env)
27+
* [`docker-compose.yml`](https://github.com/elastic/elasticsearch/blob/main/docs/reference/setup/install/docker/docker-compose.yml)
2828

2929
4. In the `.env` file, specify a password for the `ELASTIC_PASSWORD` and `KIBANA_PASSWORD` variables.
3030

@@ -104,4 +104,4 @@ docker-compose down -v
104104

105105
## Next steps [_next_steps_6]
106106

107-
You now have a test {{es}} environment set up. Before you start serious development or go into production with {{es}}, review the [requirements and recommendations](/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md) to apply when running {{es}} in Docker in production.
107+
You now have a test {{es}} environment set up. Before you start serious development or go into production with {{es}}, review the [requirements and recommendations](/deploy-manage/deploy/self-managed/install-elasticsearch-docker-prod.md) to apply when running {{es}} in Docker in production.

deploy-manage/monitor/autoops.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@ products:
1919
AutoOps diagnoses issues in {{es}} by analyzing hundreds of metrics, providing root-cause analysis and accurate resolution paths. With AutoOps, customers can prevent and resolve issues, cut down administration time, and optimize resource utilization.
2020

2121
:::{image} /deploy-manage/images/cloud-autoops-overview-page.png
22-
:alt: The Overview page
22+
:screenshot:
23+
:alt: Screenshot showing the Overview page in AutoOps
2324
:::
2425

2526

0 commit comments

Comments
 (0)