Skip to content

Commit a98e791

Browse files
colleenmcginniscolleenmcginnis
authored
Merge branch 'main' into remove-unused-files
2 parents 6da2eab + 8200b62 commit a98e791

File tree

447 files changed

+7957
-2156
lines changed

Some content is hidden

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

447 files changed

+7957
-2156
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

‎.github/workflows/vale-reporting.yml‎

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/_snippets-contribute/guide-intro.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
To contribute to `elastic.co/guide` (Asciidoc), you must work with our [Asciidoc documentation build system](https://github.com/elastic/docs). This system uses ASCIIDoc as its markup language.
2+
3+
Docs for {{stack}} 8.x, {{ece}} 3.x, and {{eck}} 2.x can all be found on this site.

‎contribute-docs/_snippets-contribute/tag-processing.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
`applies_to` tags are rendered as badges in the documentation output. They reproduce the "key + lifecycle status + version" indicated in the content sources.
2+
3+
Specifically for versioned products, badges will display differently when the `applies_to` key specifies a product version that has not been released to our customers yet.
4+
5+
The following table shows how badges for versioned products are displayed based on the release status for each lifecycle value. Hover over the example badges for the tooltip text.
6+
7+
| Lifecycle | Release status | Badge text examples |
8+
|-------------|----------------|---------------------------------------|
9+
| preview | prerelease | {applies_to}`stack: preview 99.99` |
10+
| | post-release | {applies_to}`stack: preview 9.1` |
11+
| beta | prerelease | {applies_to}`stack: beta 99.99` |
12+
| | post-release | {applies_to}`stack: beta 9.1` |
13+
| ga | prerelease | {applies_to}`stack: ga 99.99` |
14+
| | post-release | {applies_to}`stack: ga 9.1` |
15+
| deprecated | prerelease | {applies_to}`stack: deprecated 99.99` |
16+
| | post-release | {applies_to}`stack: deprecated 9.1` |
17+
| removed | prerelease | {applies_to}`stack: removed 99.99` |
18+
| | post-release | {applies_to}`stack: removed 9.1` |
19+
20+
This is computed at build time (there is a docs build every 30 minutes). The documentation team tracks and maintains released versions for these products centrally in [`versions.yml`](https://github.com/elastic/docs-builder/blob/main/config/versions.yml).
21+
22+
When multiple lifecycle statuses and versions are specified in the sources, several badges are shown.
23+
24+
:::{note}
25+
Visuals and wording in the output documentation are subject to changes and optimizations.
26+
:::

‎contribute-docs/_snippets-contribute/tagged-warning.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:::{warning}
2+
Some repositories use a [tagged branching strategy](https://elastic.github.io/docs-builder/contribute/branching-strategy/), which means that their docs are published from a branch that is not `main` or `master`. In these cases, documentation changes need to be made to `main` or `master`, and then backported to the relevant branches.
3+
4+
For detailed backporting guidance, refer to the example in [Choose the docs branching strategy for a repository](https://elastic.github.io/docs-builder/contribute/branching-strategy/#workflow-2-tagged).
5+
6+
To determine the published branches for a repository, find the repository in [`assembler.yml`](https://github.com/elastic/docs-builder/blob/main/config/assembler.yml).
7+
:::

‎contribute-docs/_snippets-contribute/two-systems.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Because the new documentation site only hosts documentation for newer releases, the way that you contribute depends on the version that you want to document.
2+
3+
For a list of versions covered on [elastic.co/docs](https://www.elastic.co/docs) (Markdown), refer to [Find docs for your product version](https://www.elastic.co/docs/get-started/versioning-availability#find-docs-for-your-product-version). Versions prior to the versions listed on that page are documented on [elastic.co/guide](https://www.elastic.co/guide).
4+
5+
:::{tip}
6+
Unversioned products, such as {{ech}} and {{serverless-full}}, are documented on [elastic.co/docs](https://www.elastic.co/docs).
7+
:::

‎contribute-docs/_snippets/applies_to-key.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
`applies_to` accepts the following keys in this structure.
2+
3+
* `serverless`: Applies to [Elastic Cloud Serverless](https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/serverless).
4+
* `security`: Applies to Serverless [security projects](https://www.elastic.co/docs/solutions/security/get-started#create-sec-serverless-project).
5+
* `elasticsearch`: Applies to Serverless [search projects](https://www.elastic.co/docs/solutions/search/serverless-elasticsearch-get-started).
6+
* `observability`: Applies to Serverless [observability projects](https://www.elastic.co/docs/solutions/observability/get-started).
7+
* `stack`: Applies to the [Elastic Stack](https://www.elastic.co/docs/get-started/the-stack) including any Elastic Stack components.
8+
* `deployment`: Applies to some deployment type(s).
9+
* `ece`: Applies to [Elastic Cloud Enterprise](https://www.elastic.co/docs/deploy-manage/deploy/cloud-enterprise) deployments.
10+
* `eck`: Applies to [Elastic Cloud on Kubernetes](https://www.elastic.co/docs/deploy-manage/deploy/cloud-on-k8s) deployments.
11+
* `self`: Applies to [self-managed](https://www.elastic.co/docs/deploy-manage/deploy/self-managed) deployments.
12+
* `ess`: Applies to [Elastic Cloud Hosted](https://www.elastic.co/docs/deploy-manage/deploy/elastic-cloud/cloud-hosted) deployments.
13+
* `product`: Applies to a specific product that uses a unique versioning scheme (for example, not `stack`, `ece`, `eck`).
14+
* `apm_agent_dotnet`: Applies to the [Elastic APM .NET agent](https://www.elastic.co/docs/reference/apm/agents/dotnet).
15+
* `apm_agent_go`: Applies to the [Elastic APM Go agent](https://www.elastic.co/docs/reference/apm/agents/go).
16+
* `apm_agent_java`: Applies to the [Elastic APM Java agent](https://www.elastic.co/docs/reference/apm/agents/java).
17+
* `apm_agent_node`: Applies to the [Elastic APM Node.js agent](https://www.elastic.co/docs/reference/apm/agents/nodejs).
18+
* `apm_agent_php`: Applies to the [Elastic APM PHP agent](https://www.elastic.co/docs/reference/apm/agents/php).
19+
* `apm_agent_python`: Applies to the [Elastic APM Python agent](https://www.elastic.co/docs/reference/apm/agents/python).
20+
* `apm_agent_ruby`: Applies to the [Elastic APM Ruby agent](https://www.elastic.co/docs/reference/apm/agents/ruby).
21+
* `apm_agent_rum`: Applies to the [APM RUM JavaScript agent](https://www.elastic.co/docs/reference/apm/agents/rum-js).
22+
* `curator`: Applies to [Elasticsearch Curator](https://www.elastic.co/docs/reference/elasticsearch/curator) (Curator).
23+
* `ecctl`: Applies to [Elastic cloud control](https://www.elastic.co/docs/reference/ecctl) (ECCTL).
24+
* `edot_android`: Applies to the [Elastic Distribution of OpenTelemetry Android](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/android/) (EDOT Android).
25+
* `edot_cf_aws`: Applies to the [Elastic Distribution of OpenTelemetry Cloud Forwarder](https://www.elastic.co/docs/reference/opentelemetry/edot-cloud-forwarder/) (EDOT Cloud Forwarder).
26+
* `edot_cf_azure`: Applies to the [Elastic Distribution of OpenTelemetry Cloud Forwarder](https://www.elastic.co/docs/reference/opentelemetry/edot-cloud-forwarder/) (EDOT Cloud Forwarder).
27+
* `edot_collector`: Applies to the [Elastic Distribution of OpenTelemetry Collector](https://www.elastic.co/docs/reference/opentelemetry/edot-collector/) (EDOT Collector).
28+
* `edot_dotnet`: Applies to the [Elastic Distribution of OpenTelemetry .NET](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/dotnet/) (EDOT .NET).
29+
* `edot_ios`: Applies to the [Elastic Distribution of OpenTelemetry iOS](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/ios/) (EDOT iOS).
30+
* `edot_java`: Applies to the [Elastic Distribution of OpenTelemetry Java](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/java/) (EDOT Java).
31+
* `edot_node`: Applies to the [Elastic Distribution of OpenTelemetry Node.js](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/nodejs/) (EDOT Node.js).
32+
* `edot_php`: Applies to the [Elastic Distribution of OpenTelemetry PHP](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/php/) (EDOT PHP).
33+
* `edot_python`: Applies to the [Elastic Distribution of OpenTelemetry Python](https://www.elastic.co/docs/reference/opentelemetry/edot-sdks/python/) (EDOT Python).
34+
35+
:::{note}
36+
The `product` key and its subkeys are used to indicate feature availability and applicability. The similarly named [`products` frontmatter field](https://elastic.github.io/docs-builder/syntax/frontmatter#products) is used to drive elastic.co search filters.
37+
:::

‎contribute-docs/_snippets/applies_to-lifecycle.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
`applies_to` accepts the following lifecycle states:
2+
3+
* `preview`
4+
* `beta`
5+
* `ga`
6+
* `deprecated`
7+
* `removed`
8+
* `unavailable`

0 commit comments

Comments
 (0)