From fd41349570b02c355e4c9397c88b803b6757f5a6 Mon Sep 17 00:00:00 2001 From: bmorelli25 Date: Fri, 10 Jan 2025 15:28:26 -0800 Subject: [PATCH 01/10] more docs updates --- docs/source/build/index.md | 7 + docs/source/build/infra.md | 5 + docs/source/build/link-validation.md | 50 + docs/source/configure/index.md | 6 +- docs/source/contribute/change-browser.md | 12 +- docs/source/contribute/change-local.md | 114 +- docs/source/docset.yml | 4 + docs/source/migration/codeowner.md | 19 + docs/source/migration/file-structure.md | 2 +- docs/source/migration/guide.md | 12 + docs/source/migration/index.md | 81 +- docs/source/migration/mapping.md | 129 + .../scripts/attribute-converter/attr.py | 59 + .../attribute-converter/attributes.asciidoc | 579 ++++ .../attribute-converter/attributes.yml | 494 +++ .../scripts/codeowner-gen/codeowner.py | 114 + .../migration/scripts/codeowner-gen/conf.yaml | 3022 +++++++++++++++++ .../migration/scripts/codeowner-gen/output.md | 577 ++++ .../migration/scripts/tab-converter/tab.py | 64 + docs/source/migration/tabs.md | 42 + docs/source/syntax/automated_settings.md | 17 + 21 files changed, 5387 insertions(+), 22 deletions(-) create mode 100644 docs/source/build/index.md create mode 100644 docs/source/build/infra.md create mode 100644 docs/source/build/link-validation.md create mode 100644 docs/source/migration/codeowner.md create mode 100644 docs/source/migration/guide.md create mode 100644 docs/source/migration/mapping.md create mode 100644 docs/source/migration/scripts/attribute-converter/attr.py create mode 100644 docs/source/migration/scripts/attribute-converter/attributes.asciidoc create mode 100644 docs/source/migration/scripts/attribute-converter/attributes.yml create mode 100644 docs/source/migration/scripts/codeowner-gen/codeowner.py create mode 100644 docs/source/migration/scripts/codeowner-gen/conf.yaml create mode 100644 docs/source/migration/scripts/codeowner-gen/output.md create mode 100644 docs/source/migration/scripts/tab-converter/tab.py create mode 100644 docs/source/migration/tabs.md diff --git a/docs/source/build/index.md b/docs/source/build/index.md new file mode 100644 index 000000000..5e9d846f4 --- /dev/null +++ b/docs/source/build/index.md @@ -0,0 +1,7 @@ +--- +title: Docs build internals +--- + +Placeholder for now. + +* [Link validation](link-validation.md) \ No newline at end of file diff --git a/docs/source/build/infra.md b/docs/source/build/infra.md new file mode 100644 index 000000000..7244c2774 --- /dev/null +++ b/docs/source/build/infra.md @@ -0,0 +1,5 @@ +--- +title: AWS +--- + +Placeholder \ No newline at end of file diff --git a/docs/source/build/link-validation.md b/docs/source/build/link-validation.md new file mode 100644 index 000000000..8a3d32681 --- /dev/null +++ b/docs/source/build/link-validation.md @@ -0,0 +1,50 @@ +--- +title: Link validation +--- + +* See the [RFC](https://docs.google.com/document/d/1fZNeJCVLKu19s4WIKkkqrHyE9YlWQHNed94Y_V7ofRI/edit?tab=t.0#heading=h.z8tixe192fr4). +* Infrastructure lives in [docs-infra](https://github.com/elastic/docs-infra). + +```{mermaid} +flowchart TD + subgraph **Repository Build Process** + direction LR + subgraph Repositories + A[Repository A] --> Z1 + B[Repository B] --> Z2 + C[Repository C] --> Z3 + Z1[Link validation process] + Z2[Link validation process] + Z3[Link validation process] + end + Z1 & Z2 & Z3 -->|If validation succeeds| E[Generate links.json] + E -->|Extract external links and add to _external_links_ array| H + H[Upload updated links.json to S3] + end + + subgraph AWS **Link Index** + H --> I[Amazon S3 Bucket] + I --> J[CloudFront Distribution] + end + + subgraph Assembler + J --> X["Validate links and build docs (TBD)"] + end + + subgraph **Link validation process** + subgraph Changes to md files + Q[Add External Links] --> K + R[Remove Markdown Files] --> K + end + K[Docs build kicks off] + K --> L[Download links.json files from CloudFront] + L --> M{Link Validation} + M -->|All Links Valid| N[Build Succeeds] + M -->|Broken Links Found| O[Build Fails] + end + + J --> L + + style N fill:#a3d9a5,color:#333 + style O fill:#f8a5a5,color:#333 +``` \ No newline at end of file diff --git a/docs/source/configure/index.md b/docs/source/configure/index.md index f8993b0f9..f9a1d7bfc 100644 --- a/docs/source/configure/index.md +++ b/docs/source/configure/index.md @@ -1,4 +1,8 @@ --- title: Configure Elastic Docs navigation_title: Configuration reference ---- \ No newline at end of file +--- + +* [Page configuration](./page.md) +* [Content-set configuration](./content-set/index.md) +* [Site configuration](./site/index.md) \ No newline at end of file diff --git a/docs/source/contribute/change-browser.md b/docs/source/contribute/change-browser.md index 106b0cb3d..271ba1759 100644 --- a/docs/source/contribute/change-browser.md +++ b/docs/source/contribute/change-browser.md @@ -1,11 +1,3 @@ --- -title: Update the docs locally ---- - -1. Install dependencies -2. Clone repositories -3. Make changes -4. Open a Pull Request -5. Work with CI -6. Get approvals and merge -7. View your changes live on elastic.co \ No newline at end of file +title: Update the docs in your browser +--- \ No newline at end of file diff --git a/docs/source/contribute/change-local.md b/docs/source/contribute/change-local.md index d1ab75c13..8be7b601d 100644 --- a/docs/source/contribute/change-local.md +++ b/docs/source/contribute/change-local.md @@ -1,3 +1,115 @@ --- -title: Update the docs in your web browser +title: Build the docs locally --- + +1. Install dependencies +2. Clone repositories +3. Make changes +4. Open a Pull Request +5. Work with CI +6. Get approvals and merge +7. View your changes live on elastic.co + +Follow these instructions to get started with docs-builder on your machine. + +::::{tab-set} + +:::{tab-item} macOS + +### macOS Installation + +1. **Download the Binary:** + Download the latest macOS binary from [releases](https://github.com/elastic/docs-builder/releases/latest/): + ```sh + curl -LO https://github.com/elastic/docs-builder/releases/latest/download/docs-builder-mac-arm64.zip + ``` + +2. **Extract the Binary:** + Unzip the downloaded file: + ```sh + unzip docs-builder-mac-arm64.zip + ``` + +3. **Run the Binary:** + Use the `serve` command to start serving the documentation at http://localhost:5000. The path to the docset.yml file that you want to build can be specified with `-p`: + ```sh + ./docs-builder serve -p ./path/to/docs + ``` + +::: + +:::{tab-item} Windows + +### Windows Installation + +1. **Download the Binary:** + Download the latest Windows binary from [releases](https://github.com/elastic/docs-builder/releases/latest/): + ```sh + Invoke-WebRequest -Uri https://github.com/elastic/docs-builder/releases/latest/download/docs-builder-win-x64.zip -OutFile docs-builder-win-x64.zip + ``` + +2. **Extract the Binary:** + Unzip the downloaded file. You can use tools like WinZip, 7-Zip, or the built-in Windows extraction tool. + ```sh + Expand-Archive -Path docs-builder-win-x64.zip -DestinationPath . + ``` + +3. **Run the Binary:** + Use the `serve` command to start serving the documentation at http://localhost:5000. The path to the docset.yml file that you want to build can be specified with `-p`: + ```sh + .\docs-builder serve -p ./path/to/docs + ``` + +::: + +:::{tab-item} Linux + +### Linux Installation + +1. **Download the Binary:** + Download the latest Linux binary from [releases](https://github.com/elastic/docs-builder/releases/latest/): + ```sh + wget https://github.com/elastic/docs-builder/releases/latest/download/docs-builder-linux-x64.zip + ``` + +2. **Extract the Binary:** + Unzip the downloaded file: + ```sh + unzip docs-builder-linux-x64.zip + ``` + +3. **Run the Binary:** + Use the `serve` command to start serving the documentation at http://localhost:5000. The path to the docset.yml file that you want to build can be specified with `-p`: + ```sh + ./docs-builder serve -p ./path/to/docs + ``` + +::: + +:::: + +### Clone the `docs-content` Repository + +Clone the `docs-content` repository to a directory of your choice: +```sh +git clone https://github.com/elastic/docs-content.git +``` + +### Serve the Documentation + +1. **Navigate to the cloned repository:** + ```sh + cd docs-content + ``` + +2. **Run the Binary:** + Use the `serve` command to start serving the documentation at http://localhost:5000. The path to the `docset.yml` file that you want to build can be specified with `-p`: + ```sh + # macOS/Linux + ./docs-builder serve -p ./migration-test + + # Windows + .\docs-builder serve -p .\migration-test + ``` + +Now you should be able to view the documentation locally by navigating to http://localhost:5000. diff --git a/docs/source/docset.yml b/docs/source/docset.yml index c5deef422..f603232da 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -24,7 +24,11 @@ toc: - folder: migration children: - file: index.md + - file: guide.md - file: file-structure.md + - file: mapping.md + - file: tabs.md + - file: codeowner.md - folder: contribute children: - file: index.md diff --git a/docs/source/migration/codeowner.md b/docs/source/migration/codeowner.md new file mode 100644 index 000000000..d5c6260e4 --- /dev/null +++ b/docs/source/migration/codeowner.md @@ -0,0 +1,19 @@ +--- +title: Documentation freeze CODEOWNERS +--- + +This document lists the CODEOWNERS configuration used to enforce documentation freezes across Elastic repositories. During a documentation freeze, the `@docs-freeze-team` must approve any pull requests that modify documentation files (`.asciidoc`) before they can be merged. This prevents unintended documentation changes during crucial periods such as releases. + +To regenerate this list, run the following commands from the repository root: + +```sh +cd docs/source/migration/scripts/codeowner-gen +python3 codeowner.py +``` + +This will process `conf.yaml` and generate an updated `output.md` file containing the CODEOWNERS configuration for all repositories with documentation. The output is automatically included in this README. Note that the `conf.yaml` include in this repo should be replaced by a current version before running this script again. + +## Documentation source repositories + +:::{include} scripts/codeowner-gen/output.md +::: \ No newline at end of file diff --git a/docs/source/migration/file-structure.md b/docs/source/migration/file-structure.md index 675ffeabb..00e5da092 100644 --- a/docs/source/migration/file-structure.md +++ b/docs/source/migration/file-structure.md @@ -26,7 +26,7 @@ in the APM docs: * **New filename**: The page ID determines the filename of the migrated MD file: % `data-model-spans.mdx`. This file will be in the root directory of the directory containing the content for the `en/apm/guide` book. * **New URL**: The new URL for this page in the new docs system will be `xxxx`. -* + Because a single AsciiDoc file can contain the content for multiple pages (or content displayed on a single page could be spread across multiple AsciiDoc files), the `.asciidoc` filename can be different than the `.md` filename. However, you should be able to locate diff --git a/docs/source/migration/guide.md b/docs/source/migration/guide.md new file mode 100644 index 000000000..2d42a6c16 --- /dev/null +++ b/docs/source/migration/guide.md @@ -0,0 +1,12 @@ +--- +title: Migration Guide +--- + +How to migrate content from Asciidoc to V3. + +1. Clone https://github.com/elastic/adoc-to-md +2. Run the migration tool +3. Copy the output to the appropriate directory in https://github.com/elastic/docs-content +4. Update the `docset.yml` file to reflect the new IA of the content set +5. Build your changes with https://github.com/elastic/docs-builder +6. Open a PR and merge your changes \ No newline at end of file diff --git a/docs/source/migration/index.md b/docs/source/migration/index.md index 6ad0f1c89..4f9472bc0 100644 --- a/docs/source/migration/index.md +++ b/docs/source/migration/index.md @@ -1,13 +1,76 @@ --- -title: Migrate from Asciidoc to V3 -navigation_title: Migration guide +title: "Migration to docs-builder: Key updates & timeline" +navigation_title: Migration --- -How to migrate content from Asciidoc to V3. +:::{tip} +Want to learn _how_ to migrate? See the [migration guide](./guide.md). +::: -1. Clone https://github.com/elastic/adoc-to-md -2. Run the migration tool -3. Copy the output to the appropriate directory in https://github.com/elastic/docs-content -4. Update the `docset.yml` file to reflect the new IA of the content set -5. Build your changes with https://github.com/elastic/docs-builder -6. Open a PR and merge your changes \ No newline at end of file +## Documentation Freeze + +During the documentation freeze, the Docs team will focus almost entirely on migration tasks to ensure all content is successfully migrated and will handle only emergency documentation requests and release-related activities. When the migration is complete, writers will address documentation requests needed during the documentation freeze, ensuring that updates align with the new information architecture and format. + +To make the transition to Elastic Docs v3 as smooth as possible, we’ve established a process to track and manage documentation requests during the migration: + +* Open an issue in [elastic/docs-content](https://github.com/elastic/docs-content/issues), including details about the documentation requirements, links to resources, and drafts of documentation in GDocs. +* Post in [#docs](https://elastic.slack.com/archives/C0JF80CJZ) for emergency documentation requests. + +During the documentation freeze, maintaining consistency and avoiding conflicts is key. To prevent documentation changes from merging during the documentation freeze, [codeowners](./codeowner.md) are being added to /docs directories for public-facing documentation in all relevant repositories. + +## Improved information architecture + +The improved information architecture fundamentally transforms how we organize and present Elastic Docs. By addressing longstanding challenges—such as fragmented content across many books and duplicated information—this new structure introduces a cohesive framework that emphasizes clarity, usability, and alignment with user goals. These updates are designed to create a seamless experience for both readers and contributors, fostering greater understanding of our products and their benefits. + +The new IA design does the following: + +* Provides a clear narrative pathway for users to follow, including new topics that compare similar technologies and features. +* Organizes content by user goal and role. +* Consolidates content previously duplicated across our books, including serverless and stateful content, and many tasks that are common across deployment types and solutions. +* Explains the context a topic applies to (deployment type, version) - see Consolidated versioning below for more information. +* Separates reference content into its own section for easy access. + +To learn more: + +* Explore the new IA in detail in our [working doc](https://docs.google.com/spreadsheets/d/1LfPI3TZqdpONGxOmL8B8V-Feo1flLwObz9_ibCEMkIQ/edit?gid=502629814#gid=502629814). +* Learn about the general shape of the IA in our [expandable-collapsible view](https://checkvist.com/p/Nur1EAtMopm5gxry5AncM5) (does not represent all pages or guarantee final page locations). +* For more context on our IA design, including our guiding principles, refer to our [IA plan deck](https://docs.google.com/presentation/d/1e1QtEtLVCoFX0kCj02mkwxBrLSaCFyd8Nu6UlJkLP2c/edit#slide=id.g217776b7fee_0_916). + +## Consolidated versioning + +As part of the new information architecture, pages with varying versioning schemes are now interwoven, creating the opportunity and necessity to rethink the scope and versioning of each page. The previous approach of creating entirely separate docs sets for every minor version resulted in fragmentation and unnecessary duplication. Consolidating versioning resolves these issues while maintaining clarity and usability. + +To ensure a seamless experience for users and contributors, the new versioning approach adheres to the following: + +Context awareness — Each page explicitly states the context it applies to, including relevant deployment types (e.g., Elastic Cloud Hosted and Elastic Cloud Serverless) and versions. Context clarity ensures users know if the content is applicable to their environment. When users land on a Docs page that doesn’t apply to their version or deployment type, clear cues and instructions will guide them to the appropriate content. +Simplified contributor workflow — For pages that apply to multiple versions or deployment types, we’ve optimized the contributor experience by reducing complexity. Contributors can now manage multi-context content with ease, without duplicating information or navigating confusing workflows. + +For versioning plan details, check [Docs Versioning plan](https://docs.google.com/presentation/d/1fX8YBGcFlHJPi1kVfB9tC-988iUvxZJAZiH21kE4A5M/edit#slide=id.g319e4ce75b5_0_0). + +To learn how to callout versioning differences in docs-builder, see [product availability](../syntax/applies.md). + +## Transition from AsciiDoc to Markdown + +With the migration to Elastic Docs v3, the primary format for all Elastic Docs is transitioning from AsciiDoc to Markdown. Why Markdown? Markdown is already an industry standard across the industry, and 90% of Elastic developers are comfortable working with Markdown syntax [[source](https://docs.google.com/presentation/d/1morhFX4tyVB0A2f1_fnySzeJvPYf0kXGjVVYU_lVRys/edit#slide=id.g13b75c8f1f3_0_463)]. + +## How does this impact teams with automatically generated Docs? + +For teams that generate documentation programmatically, the transition means automatically generated files must now be output in Markdown format instead of AsciiDoc. This adjustment will require updating documentation generation pipelines, but it aligns with the broader benefits of a simpler and more extensible documentation framework. + +See our [syntax guide](../syntax/index.md) to learn more about the flavor of Markdown that we support. In addition, we're refining support for including YAML files directly in the docs. See [automated settings](../syntax/automated_settings.md) to learn more. + +## Engineering ownership of reference documentation + +As part of the transition to Elastic Docs v3, responsibility for maintaining reference documentation will reside with Engineering teams so that code and corresponding documentation remain tightly integrated, allowing for easier updates and greater accuracy. + +After migration, all narrative and instructional documentation actively maintained by writers will move to the elastic/docs-content repository. Reference documentation, such as API specifications, will remain in the respective product repositories so that Engineering teams can manage both the code and its related documentation in one place. + +## Guidelines for API documentation +To improve consistency and maintain high-quality reference documentation, all API documentation must adhere to the following standards: + +* **Switch to OAS (OpenAPI specification)**: Engineering teams should stop creating AsciiDoc-based API documentation. All API documentation should now use OAS files, alongside our API documentation that lives at elastic.co/docs/api. +* **Comprehensive API descriptions**: Ensure that OAS files include: + * API descriptions + * Request descriptions + * Response descriptions +* **Fix linting warnings**: Address all new and existing linting warnings in OAS files to maintain clean and consistent documentation. \ No newline at end of file diff --git a/docs/source/migration/mapping.md b/docs/source/migration/mapping.md new file mode 100644 index 000000000..f1999d9ea --- /dev/null +++ b/docs/source/migration/mapping.md @@ -0,0 +1,129 @@ +--- +title: Book to content set mapping +--- + +What full books are staying in Asciidoc? What books are migrating `main`/`master`? See the table below. + +| Title | Current Version | Sources | Migrate to | +|----------------------------------------------------------------------------------------------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------- | +| **Search UI** | main | [search-ui](https://github.com/elastic/search-ui.git) | | +| **Integrations** | main | [integration-docs](https://github.com/elastic/integration-docs.git) | | +| **Serverless** | main | [docs-content](https://github.com/elastic/docs-content.git), [observability-docs](https://github.com/elastic/observability-docs.git), [security-docs](https://github.com/elastic/security-docs.git) | | +| **Elasticsearch Guide** | 8.17 | [elasticsearch](https://github.com/elastic/elasticsearch.git), [x-pack-elasticsearch](https://github.com/elastic/x-pack-elasticsearch.git), [elasticsearch-php](https://github.com/elastic/elasticsearch-php.git), [elasticsearch-py](https://github.com/elastic/elasticsearch-py.git), [go-elasticsearch](https://github.com/elastic/go-elasticsearch.git), [elasticsearch-ruby](https://github.com/elastic/elasticsearch-ruby.git), [elasticsearch-js](https://github.com/elastic/elasticsearch-js.git) | | +| **Enterprise Search Guide** | 8.17 | [enterprise-search-pubs](https://github.com/elastic/enterprise-search-pubs.git), [docs](https://github.com/elastic/docs.git) | | +| **Workplace Search Guide** | 8.17 | [enterprise-search-pubs](https://github.com/elastic/enterprise-search-pubs.git), [docs](https://github.com/elastic/docs.git) | | +| **App Search Guide** | 8.17 | [enterprise-search-pubs](https://github.com/elastic/enterprise-search-pubs.git), [docs](https://github.com/elastic/docs.git) | | +| **App Search JavaScript client** | 8.17 | [enterprise-search-pubs](https://github.com/elastic/enterprise-search-pubs.git), [docs](https://github.com/elastic/docs.git) | | +| **App Search Node.js client** | 8.17 | [enterprise-search-pubs](https://github.com/elastic/enterprise-search-pubs.git), [docs](https://github.com/elastic/docs.git) | | +| **Enterprise Search Node.js client** | 8.17 | [enterprise-search-js](https://github.com/elastic/enterprise-search-js.git), [docs](https://github.com/elastic/docs.git) | | +| **Enterprise Search PHP client** | 8.17 | [enterprise-search-php](https://github.com/elastic/enterprise-search-php.git), [docs](https://github.com/elastic/docs.git) | | +| **Enterprise Search Python client** | 8.17 | [enterprise-search-python](https://github.com/elastic/enterprise-search-python.git), [docs](https://github.com/elastic/docs.git) | | +| **Enterprise Search Ruby client** | 8.17 | [enterprise-search-ruby](https://github.com/elastic/enterprise-search-ruby.git), [docs](https://github.com/elastic/docs.git) | | +| **Workplace Search Node.js client** | 8.17 | [enterprise-search-pubs](https://github.com/elastic/enterprise-search-pubs.git), [docs](https://github.com/elastic/docs.git) | | +| **Observability** | 8.17 | [observability-docs](https://github.com/elastic/observability-docs.git), [ingest-docs](https://github.com/elastic/ingest-docs.git), [apm-server](https://github.com/elastic/apm-server.git), [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | | +| **APM Guide** | 8.17 | [observability-docs](https://github.com/elastic/observability-docs.git), [apm-server](https://github.com/elastic/apm-server.git), [ingest-docs](https://github.com/elastic/ingest-docs.git) | | +| **APM Android Agent** | 0.x | [apm-agent-android](https://github.com/elastic/apm-agent-android.git) | | +| **APM Go Agent** | 2.x | [apm-agent-go](https://github.com/elastic/apm-agent-go.git) | | +| **APM iOS Agent** | 1.x | [apm-agent-ios](https://github.com/elastic/apm-agent-ios.git) | | +| **APM Java Agent** | 1.x | [apm-agent-java](https://github.com/elastic/apm-agent-java.git), [apm-aws-lambda](https://github.com/elastic/apm-aws-lambda.git) | | +| **APM .NET Agent** | 1.x | [apm-agent-dotnet](https://github.com/elastic/apm-agent-dotnet.git) | | +| **APM Node.js Agent** | 4.x | [apm-agent-nodejs](https://github.com/elastic/apm-agent-nodejs.git), [apm-aws-lambda](https://github.com/elastic/apm-aws-lambda.git) | | +| **APM PHP Agent** | 1.x | [apm-agent-php](https://github.com/elastic/apm-agent-php.git) | | +| **APM Python Agent** | 6.x | [apm-agent-python](https://github.com/elastic/apm-agent-python.git), [apm-aws-lambda](https://github.com/elastic/apm-aws-lambda.git) | | +| **APM Ruby Agent** | 4.x | [apm-agent-ruby](https://github.com/elastic/apm-agent-ruby.git) | | +| **APM Real User Monitoring JavaScript Agent** | 5.x | [apm-agent-rum-js](https://github.com/elastic/apm-agent-rum-js.git) | | +| **APM AWS Lambda Extension** | main | [apm-aws-lambda](https://github.com/elastic/apm-aws-lambda.git) | | +| **APM Attacher** | main | [apm-k8s-attacher](https://github.com/elastic/apm-k8s-attacher.git) | | +| **ECS Logging Overview** | main | [ecs-logging](https://github.com/elastic/ecs-logging.git), [docs](https://github.com/elastic/docs.git) | | +| **ECS Logging Go (Logrus) Reference** | main | [ecs-logging-go-logrus](https://github.com/elastic/ecs-logging-go-logrus.git), [ecs-logging](https://github.com/elastic/ecs-logging.git), [docs](https://github.com/elastic/docs.git) | | +| **ECS Logging Go (Zap) Reference** | main | [ecs-logging-go-zap](https://github.com/elastic/ecs-logging-go-zap.git), [ecs-logging](https://github.com/elastic/ecs-logging.git), [docs](https://github.com/elastic/docs.git) | | +| **ECS Logging Go (zerolog) Reference** | main | [ecs-logging-go-zerolog](https://github.com/elastic/ecs-logging-go-zerolog.git), [ecs-logging](https://github.com/elastic/ecs-logging.git), [docs](https://github.com/elastic/docs.git) | | +| **ECS Logging Java Reference** | 1.x | [ecs-logging-java](https://github.com/elastic/ecs-logging-java.git), [ecs-logging](https://github.com/elastic/ecs-logging.git), [docs](https://github.com/elastic/docs.git) | | +| **ECS Logging .NET Reference** | main | [ecs-dotnet](https://github.com/elastic/ecs-dotnet.git), [ecs-logging](https://github.com/elastic/ecs-logging.git), [docs](https://github.com/elastic/docs.git) | | +| **ECS Logging Node.js Reference** | main | [ecs-logging-nodejs](https://github.com/elastic/ecs-logging-nodejs.git), [ecs-logging](https://github.com/elastic/ecs-logging.git), [docs](https://github.com/elastic/docs.git) | | +| **ECS Logging Ruby Reference** | main | [ecs-logging-ruby](https://github.com/elastic/ecs-logging-ruby.git), [ecs-logging](https://github.com/elastic/ecs-logging.git), [docs](https://github.com/elastic/docs.git) | | +| **ECS Logging PHP Reference** | main | [ecs-logging-php](https://github.com/elastic/ecs-logging-php.git), [ecs-logging](https://github.com/elastic/ecs-logging.git), [docs](https://github.com/elastic/docs.git) | | +| **ECS Logging Python Reference** | main | [ecs-logging-python](https://github.com/elastic/ecs-logging-python.git), [ecs-logging](https://github.com/elastic/ecs-logging.git), [docs](https://github.com/elastic/docs.git) | | +| **Elastic Security** | 8.17 | [security-docs](https://github.com/elastic/security-docs.git), [docs](https://github.com/elastic/docs.git), [stack-docs](https://github.com/elastic/stack-docs.git) | | +| **Starting with the Elasticsearch Platform and its Solutions** | 8.17 | [tech-content](https://github.com/elastic/tech-content.git), [docs](https://github.com/elastic/docs.git) | | +| **Curator Index Management** | 8.0 | [curator](https://github.com/elastic/curator.git) | | +| **Elastic Common Schema (ECS) Reference** | 8.16 | [ecs](https://github.com/elastic/ecs.git) | | +| **Java Client** | 8.17 | [elasticsearch-java](https://github.com/elastic/elasticsearch-java.git), [elasticsearch](https://github.com/elastic/elasticsearch.git) | | +| **JavaScript Client** | 8.17 | [elasticsearch-js](https://github.com/elastic/elasticsearch-js.git) | | +| **Ruby Client** | 8.17 | [elasticsearch-ruby](https://github.com/elastic/elasticsearch-ruby.git) | | +| **Go Client** | 8.17 | [go-elasticsearch](https://github.com/elastic/go-elasticsearch.git) | | +| **.NET Clients** | 8.17 | [elasticsearch-net](https://github.com/elastic/elasticsearch-net.git) | | +| **PHP Client** | 8.17 | [elasticsearch-php](https://github.com/elastic/elasticsearch-php.git), [docs](https://github.com/elastic/docs.git) | | +| **Perl Client** | master | [elasticsearch-perl](https://github.com/elastic/elasticsearch-perl.git) | | +| **Python Client** | 8.17 | [elasticsearch-py](https://github.com/elastic/elasticsearch-py.git) | | +| **eland** | main | [eland](https://github.com/elastic/eland.git) | | +| **Rust Client** | main | [elasticsearch-rs](https://github.com/elastic/elasticsearch-rs.git) | | +| **Java REST Client (deprecated)** | 7.17 | [elasticsearch](https://github.com/elastic/elasticsearch.git), [docs](https://github.com/elastic/docs.git) | | +| **Java Transport Client (deprecated)** | 7.17 | [elasticsearch](https://github.com/elastic/elasticsearch.git), [docs](https://github.com/elastic/docs.git) | | +| **Community Contributed Clients** | main | [elasticsearch](https://github.com/elastic/elasticsearch.git) | | +| **Elasticsearch for Apache Hadoop and Spark** | 8.17 | [elasticsearch-hadoop](https://github.com/elastic/elasticsearch-hadoop.git) | | +| **Elasticsearch Relevance Engine (ESRE)** | 8.17 | [enterprise-search-pubs](https://github.com/elastic/enterprise-search-pubs.git), [docs](https://github.com/elastic/docs.git) | | +| **Glossary** | main | [stack-docs](https://github.com/elastic/stack-docs.git), [docs](https://github.com/elastic/docs.git) | | +| **Installation and Upgrade Guide** | 8.17 | [stack-docs](https://github.com/elastic/stack-docs.git), [apm-server](https://github.com/elastic/apm-server.git), [beats](https://github.com/elastic/beats.git), [elasticsearch](https://github.com/elastic/elasticsearch.git), [elasticsearch-hadoop](https://github.com/elastic/elasticsearch-hadoop.git), [security-docs](https://github.com/elastic/security-docs.git), [kibana](https://github.com/elastic/kibana.git), [logstash](https://github.com/elastic/logstash.git), [observability-docs](https://github.com/elastic/observability-docs.git), [docs](https://github.com/elastic/docs.git) | | +| **Kibana Guide** | 8.17 | [kibana](https://github.com/elastic/kibana.git), [docs](https://github.com/elastic/docs.git) | | +| **Machine Learning** | 8.17 | [stack-docs](https://github.com/elastic/stack-docs.git), [elasticsearch](https://github.com/elastic/elasticsearch.git), [docs](https://github.com/elastic/docs.git) | | +| **Painless Scripting Language** | 8.17 | [elasticsearch](https://github.com/elastic/elasticsearch.git), [docs](https://github.com/elastic/docs.git) | | +| **Plugins and Integrations** | 8.17 | [elasticsearch](https://github.com/elastic/elasticsearch.git), [docs](https://github.com/elastic/docs.git) | | +| **Reference Architectures** | main | [stack-docs](https://github.com/elastic/stack-docs.git), [docs](https://github.com/elastic/docs.git) | | +| **Elastic Ingest Reference Architectures** | 8.17 | [ingest-docs](https://github.com/elastic/ingest-docs.git), [docs](https://github.com/elastic/docs.git) | | +| **Fleet and Elastic Agent Guide** | 8.17 | [ingest-docs](https://github.com/elastic/ingest-docs.git), [observability-docs](https://github.com/elastic/observability-docs.git), [apm-server](https://github.com/elastic/apm-server.git), [docs](https://github.com/elastic/docs.git) | | +| **Logstash Reference** | 8.17 | [logstash](https://github.com/elastic/logstash.git), [logstash-docs](https://github.com/elastic/logstash-docs.git), [docs](https://github.com/elastic/docs.git) | | +| **Logstash Versioned Plugin Reference** | versioned_plugin_docs | [logstash-docs](https://github.com/elastic/logstash-docs.git), [docs](https://github.com/elastic/docs.git) | | +| **Elastic Logging Plugin for Docker** | 8.17 | [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | | +| **Elastic Serverless Forwarder Guide** | main | [elastic-serverless-forwarder](https://github.com/elastic/elastic-serverless-forwarder.git), [docs](https://github.com/elastic/docs.git) | | +| **Integrations Developer Guide** | main | [observability-docs](https://github.com/elastic/observability-docs.git), [docs](https://github.com/elastic/docs.git), [package-spec](https://github.com/elastic/package-spec.git) | | +| **Auditbeat Reference** | 8.17 | [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | | +| **Beats Developer Guide** | main | [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | | +| **Beats Platform Reference** | 8.17 | [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | | +| **Filebeat Reference** | 8.17 | [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | | +| **Heartbeat Reference** | 8.17 | [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | | +| **Metricbeat Reference** | 8.17 | [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | | +| **Packetbeat Reference** | 8.17 | [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | | +| **Winlogbeat Reference** | 8.17 | [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | | +| **Elastic Cloud, Hosted Elastic Stack** | ms-117 | [cloud](https://github.com/elastic/cloud.git) | | +| **Elasticsearch Add-On for Heroku - Hosted Elasticsearch and Kibana for Heroku Users** | ms-117 | [cloud](https://github.com/elastic/cloud.git) | | +| **Elastic Cloud Enterprise - Elastic Cloud on your Infrastructure** | ms-105 | [cloud](https://github.com/elastic/cloud.git), [cloud-assets](https://github.com/elastic/cloud-assets.git), [clients-team](https://github.com/elastic/clients-team.git), [docs](https://github.com/elastic/docs.git) | | +| **Elastic Cloud on Kubernetes** | 2.16 | [cloud-on-k8s](https://github.com/elastic/cloud-on-k8s.git), [docs](https://github.com/elastic/docs.git) | | +| **Elastic Cloud Control - The Command-Line Interface for Elasticsearch Service and ECE** | 1.14 | [ecctl](https://github.com/elastic/ecctl.git) | | +| **Elastic Cloud Terraform Provider** | master | [terraform-provider-ec](https://github.com/elastic/terraform-provider-ec.git) | | +| **Elastic Stack and Google Cloud's Anthos** | main | [stack-docs](https://github.com/elastic/stack-docs.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Elasticsearch - The Definitive Guide** | 2.x | [elasticsearch-definitive-guide](https://github.com/elastic/elasticsearch-definitive-guide.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Elasticsearch Resiliency Status** | main | [elasticsearch](https://github.com/elastic/elasticsearch.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Elasticsearch.js for 5.6-7.6** | 16.x | [elasticsearch-js-legacy](https://github.com/elastic/elasticsearch-js-legacy.git) | **not migrating** | +| **Functionbeat Reference** | 8.15 | [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Getting Started** | 8.2 | [stack-docs](https://github.com/elastic/stack-docs.git), [docs](https://github.com/elastic/docs.git), [elasticsearch](https://github.com/elastic/elasticsearch.git) | **not migrating** | +| **Graph Reference for 2.x** | 2.4 | [x-pack](https://github.com/elastic/x-pack.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Groovy API** | 2.4 | [elasticsearch](https://github.com/elastic/elasticsearch.git) | **not migrating** | +| **Infrastructure Monitoring Guide for 6.5-7.4** | 7.4 | [stack-docs](https://github.com/elastic/stack-docs.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Journalbeat Reference for 6.5-7.15** | 7.15 | [beats](https://github.com/elastic/beats.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Legacy APM Overview** | 7.15 | [apm-server](https://github.com/elastic/apm-server.git) | **not migrating** | +| **Legacy APM Server Reference** | 7.15 | [apm-server](https://github.com/elastic/apm-server.git) | **not migrating** | +| **Logs Monitoring Guide for 7.5-7.9** | 7.9 | [observability-docs](https://github.com/elastic/observability-docs.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Marvel Reference for 2.x and 1.x** | 2.4 | [x-pack](https://github.com/elastic/x-pack.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Metrics Monitoring Guide for 7.5-7.9** | 7.9 | [observability-docs](https://github.com/elastic/observability-docs.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Reporting Reference for 2.x** | 2.4 | [x-pack](https://github.com/elastic/x-pack.git) | **not migrating** | +| **Sense Editor for 4.x** | master | [sense](https://github.com/elastic/sense.git) | **not migrating** | +| **Shield Reference for 2.x and 1.x** | 2.4 | [x-pack](https://github.com/elastic/x-pack.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **SIEM Guide** | 7.8 | [stack-docs](https://github.com/elastic/stack-docs.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Site Search Reference** | master | [swiftype-doc-placeholder](https://github.com/elastic/swiftype-doc-placeholder.git) | **not migrating** | +| **Topbeat Reference** | 1.3 | [beats](https://github.com/elastic/beats.git) | **not migrating** | +| **Uptime Monitoring Guide for 7.2-7.9** | 7.9 | [observability-docs](https://github.com/elastic/observability-docs.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Stack Overview** | 7.4 | [stack-docs](https://github.com/elastic/stack-docs.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **Watcher Reference for 2.x and 1.x** | 2.4 | [x-pack](https://github.com/elastic/x-pack.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **X-Pack Reference for 6.0-6.2 and 5.x** | 6.2 | [x-pack](https://github.com/elastic/x-pack.git), [x-pack-kibana](https://github.com/elastic/x-pack-kibana.git), [x-pack-elasticsearch](https://github.com/elastic/x-pack-elasticsearch.git), [docs](https://github.com/elastic/docs.git) | **not migrating** | +| **《Elasticsearch 权威指南》中文版** | cn | [elasticsearch-definitive-guide](https://github.com/elasticsearch-cn/elasticsearch-definitive-guide.git) | **not migrating** | +| **PHP API** | cn | [elasticsearch-php](https://github.com/elasticsearch-cn/elasticsearch-php.git) | **not migrating** | +| **Kibana 用户手册** | cn | [kibana](https://github.com/elasticsearch-cn/kibana.git) | **not migrating** | +| **Elasticsearchリファレンス** | 5.4 | [elasticsearch](https://github.com/elastic/elasticsearch.git) | **not migrating** | +| **Logstashリファレンス** | 5.4 | [logstash](https://github.com/elastic/logstash.git) | **not migrating** | +| **Kibanaユーザーガイド** | 5.4 | [kibana](https://github.com/elastic/kibana.git) | **not migrating** | +| **X-Packリファレンス** | 5.4 | [x-pack](https://github.com/elastic/x-pack.git), [x-pack-kibana](https://github.com/elastic/x-pack-kibana.git), [x-pack-elasticsearch](https://github.com/elastic/x-pack-elasticsearch.git) | **not migrating** | +| **Elasticsearch 참조** | 5.4 | [elasticsearch](https://github.com/elastic/elasticsearch.git) | **not migrating** | +| **Logstash 참조** | 5.4 | [logstash](https://github.com/elastic/logstash.git) | **not migrating** | +| **Kibana 사용자 가이드** | 5.4 | [kibana](https://github.com/elastic/kibana.git) | **not migrating** | +| **X-Pack 참조** | 5.4 | [x-pack](https://github.com/elastic/x-pack.git), [x-pack-kibana](https://github.com/elastic/x-pack-kibana.git), [x-pack-elasticsearch](https://github.com/elastic/x-pack-elasticsearch.git) | **not migrating** | diff --git a/docs/source/migration/scripts/attribute-converter/attr.py b/docs/source/migration/scripts/attribute-converter/attr.py new file mode 100644 index 000000000..205cbcc27 --- /dev/null +++ b/docs/source/migration/scripts/attribute-converter/attr.py @@ -0,0 +1,59 @@ +import re +import yaml + +def resolve_substitutions(subs, value): + """ + Resolves nested attributes within a value. + Replaces {VAR-NAME} with the corresponding value from subs. + If VAR-NAME is not found, replaces it with {{VAR-NAME}}. + """ + # Pattern to find all instances of {var-name} including those in URLs + pattern = re.compile(r'\{([\w-]+)\}') + + # Replace each variable in the text with its corresponding value + def replacement(match): + var_name = match.group(1) + if var_name in subs: + return subs[var_name] + else: + # Enclose unresolved variables in double curly braces + return f'{{{{{var_name}}}}}' + + # Apply substitution to the value + return pattern.sub(replacement, value) + +def parse_asciidoc(file_path): + """ + Parses the AsciiDoc file and extracts key-value pairs. + Handles lines in the format :key: value. + """ + subs = {} + pattern = re.compile(r'^:([\w-]+):\s+(.+)$') + + with open(file_path, 'r') as file: + lines = file.readlines() + + for line in lines: + match = pattern.match(line) + if match: + key = match.group(1).strip() + value = match.group(2).strip() + subs[key] = value + + # Resolve substitutions for all keys + resolved_subs = {key: resolve_substitutions(subs, value) for key, value in subs.items()} + return resolved_subs + +def write_yaml(subs, output_file): + """ + Writes the substitutions dictionary to a YAML file under the 'subs' key. + """ + with open(output_file, 'w') as file: + yaml.dump({'subs': subs}, file, default_flow_style=False, sort_keys=False, allow_unicode=True) + +if __name__ == "__main__": + input_file = 'attributes.asciidoc' + output_file = 'attributes.yml' + subs = parse_asciidoc(input_file) + write_yaml(subs, output_file) + print(f'Output written to {output_file}') diff --git a/docs/source/migration/scripts/attribute-converter/attributes.asciidoc b/docs/source/migration/scripts/attribute-converter/attributes.asciidoc new file mode 100644 index 000000000..bf536118e --- /dev/null +++ b/docs/source/migration/scripts/attribute-converter/attributes.asciidoc @@ -0,0 +1,579 @@ +:ref: https://www.elastic.co/guide/en/elasticsearch/reference/{branch} +:ref-bare: https://www.elastic.co/guide/en/elasticsearch/reference +:ref-8x: https://www.elastic.co/guide/en/elasticsearch/reference/8.1 +:ref-80: https://www.elastic.co/guide/en/elasticsearch/reference/8.0 +:ref-7x: https://www.elastic.co/guide/en/elasticsearch/reference/7.17 +:ref-70: https://www.elastic.co/guide/en/elasticsearch/reference/7.0 +:ref-60: https://www.elastic.co/guide/en/elasticsearch/reference/6.0 +:ref-64: https://www.elastic.co/guide/en/elasticsearch/reference/6.4 +:xpack-ref: https://www.elastic.co/guide/en/x-pack/6.2 +:logstash-ref: https://www.elastic.co/guide/en/logstash/{branch} +:kibana-ref: https://www.elastic.co/guide/en/kibana/{branch} +:kibana-ref-all: https://www.elastic.co/guide/en/kibana +:beats-ref-root: https://www.elastic.co/guide/en/beats +:beats-ref: https://www.elastic.co/guide/en/beats/libbeat/{branch} +:beats-ref-60: https://www.elastic.co/guide/en/beats/libbeat/6.0 +:beats-ref-63: https://www.elastic.co/guide/en/beats/libbeat/6.3 +:beats-devguide: https://www.elastic.co/guide/en/beats/devguide/{branch} +:auditbeat-ref: https://www.elastic.co/guide/en/beats/auditbeat/{branch} +:packetbeat-ref: https://www.elastic.co/guide/en/beats/packetbeat/{branch} +:metricbeat-ref: https://www.elastic.co/guide/en/beats/metricbeat/{branch} +:filebeat-ref: https://www.elastic.co/guide/en/beats/filebeat/{branch} +:functionbeat-ref: https://www.elastic.co/guide/en/beats/functionbeat/{branch} +:winlogbeat-ref: https://www.elastic.co/guide/en/beats/winlogbeat/{branch} +:heartbeat-ref: https://www.elastic.co/guide/en/beats/heartbeat/{branch} +:journalbeat-ref: https://www.elastic.co/guide/en/beats/journalbeat/{branch} +:ingest-guide: https://www.elastic.co/guide/en/ingest/{branch} +:fleet-guide: https://www.elastic.co/guide/en/fleet/{branch} +:apm-guide-ref: https://www.elastic.co/guide/en/apm/guide/{branch} +:apm-guide-7x: https://www.elastic.co/guide/en/apm/guide/7.17 +:apm-app-ref: https://www.elastic.co/guide/en/kibana/{branch} +:apm-agents-ref: https://www.elastic.co/guide/en/apm/agent +:apm-android-ref: https://www.elastic.co/guide/en/apm/agent/android/current +:apm-py-ref: https://www.elastic.co/guide/en/apm/agent/python/current +:apm-py-ref-3x: https://www.elastic.co/guide/en/apm/agent/python/3.x +:apm-node-ref-index: https://www.elastic.co/guide/en/apm/agent/nodejs +:apm-node-ref: https://www.elastic.co/guide/en/apm/agent/nodejs/current +:apm-node-ref-1x: https://www.elastic.co/guide/en/apm/agent/nodejs/1.x +:apm-rum-ref: https://www.elastic.co/guide/en/apm/agent/rum-js/current +:apm-ruby-ref: https://www.elastic.co/guide/en/apm/agent/ruby/current +:apm-java-ref: https://www.elastic.co/guide/en/apm/agent/java/current +:apm-go-ref: https://www.elastic.co/guide/en/apm/agent/go/current +:apm-dotnet-ref: https://www.elastic.co/guide/en/apm/agent/dotnet/current +:apm-php-ref: https://www.elastic.co/guide/en/apm/agent/php/current +:apm-ios-ref: https://www.elastic.co/guide/en/apm/agent/swift/current +:apm-lambda-ref: https://www.elastic.co/guide/en/apm/lambda/current +:apm-attacher-ref: https://www.elastic.co/guide/en/apm/attacher/current +:docker-logging-ref: https://www.elastic.co/guide/en/beats/loggingplugin/{branch} +:esf-ref: https://www.elastic.co/guide/en/esf/{esf_version} +:kinesis-firehose-ref: https://www.elastic.co/guide/en/kinesis/{kinesis_version} +/////// +Elastic-level pages +/////// +:estc-welcome-current: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current +:estc-welcome: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/{branch} +:estc-welcome-all: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions +:hadoop-ref: https://www.elastic.co/guide/en/elasticsearch/hadoop/{branch} +:stack-ref: https://www.elastic.co/guide/en/elastic-stack/{branch} +:stack-ref-67: https://www.elastic.co/guide/en/elastic-stack/6.7 +:stack-ref-68: https://www.elastic.co/guide/en/elastic-stack/6.8 +:stack-ref-70: https://www.elastic.co/guide/en/elastic-stack/7.0 +:stack-ref-80: https://www.elastic.co/guide/en/elastic-stack/8.0 +:stack-ov: https://www.elastic.co/guide/en/elastic-stack-overview/{branch} +:stack-gs: https://www.elastic.co/guide/en/elastic-stack-get-started/{branch} +:stack-gs-current: https://www.elastic.co/guide/en/elastic-stack-get-started/current +:javaclient: https://www.elastic.co/guide/en/elasticsearch/client/java-api/{branch} +:java-api-client: https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/{branch} +:java-rest: https://www.elastic.co/guide/en/elasticsearch/client/java-rest/{branch} +:jsclient: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/{branch} +:jsclient-current: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current +:es-ruby-client: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/{branch} +:es-dotnet-client: https://www.elastic.co/guide/en/elasticsearch/client/net-api/{branch} +:es-php-client: https://www.elastic.co/guide/en/elasticsearch/client/php-api/{branch} +:es-python-client: https://www.elastic.co/guide/en/elasticsearch/client/python-api/{branch} +:defguide: https://www.elastic.co/guide/en/elasticsearch/guide/2.x +:painless: https://www.elastic.co/guide/en/elasticsearch/painless/{branch} +:plugins: https://www.elastic.co/guide/en/elasticsearch/plugins/{branch} +:plugins-8x: https://www.elastic.co/guide/en/elasticsearch/plugins/8.1 +:plugins-7x: https://www.elastic.co/guide/en/elasticsearch/plugins/7.17 +:plugins-6x: https://www.elastic.co/guide/en/elasticsearch/plugins/6.8 +:glossary: https://www.elastic.co/guide/en/elastic-stack-glossary/current +:upgrade_guide: https://www.elastic.co/products/upgrade_guide +:blog-ref: https://www.elastic.co/blog/ +:curator-ref: https://www.elastic.co/guide/en/elasticsearch/client/curator/{branch} +:curator-ref-current: https://www.elastic.co/guide/en/elasticsearch/client/curator/current +:metrics-ref: https://www.elastic.co/guide/en/metrics/{branch} +:metrics-guide: https://www.elastic.co/guide/en/metrics/guide/{branch} +:logs-ref: https://www.elastic.co/guide/en/logs/{branch} +:logs-guide: https://www.elastic.co/guide/en/logs/guide/{branch} +:uptime-guide: https://www.elastic.co/guide/en/uptime/{branch} +:observability-guide: https://www.elastic.co/guide/en/observability/{branch} +:observability-guide-all: https://www.elastic.co/guide/en/observability +:siem-guide: https://www.elastic.co/guide/en/siem/guide/{branch} +:security-guide: https://www.elastic.co/guide/en/security/{branch} +:security-guide-all: https://www.elastic.co/guide/en/security +:endpoint-guide: https://www.elastic.co/guide/en/endpoint/{branch} +:sql-odbc: https://www.elastic.co/guide/en/elasticsearch/sql-odbc/{branch} +:ecs-ref: https://www.elastic.co/guide/en/ecs/{ecs_version} +:ecs-logging-ref: https://www.elastic.co/guide/en/ecs-logging/overview/{ecs-logging} +:ecs-logging-go-logrus-ref: https://www.elastic.co/guide/en/ecs-logging/go-logrus/{ecs-logging-go-logrus} +:ecs-logging-go-zap-ref: https://www.elastic.co/guide/en/ecs-logging/go-zap/{ecs-logging-go-zap} +:ecs-logging-go-zerolog-ref: https://www.elastic.co/guide/en/ecs-logging/go-zap/{ecs-logging-go-zerolog} +:ecs-logging-java-ref: https://www.elastic.co/guide/en/ecs-logging/java/{ecs-logging-java} +:ecs-logging-dotnet-ref: https://www.elastic.co/guide/en/ecs-logging/dotnet/{ecs-logging-dotnet} +:ecs-logging-nodejs-ref: https://www.elastic.co/guide/en/ecs-logging/nodejs/{ecs-logging-nodejs} +:ecs-logging-php-ref: https://www.elastic.co/guide/en/ecs-logging/php/{ecs-logging-php} +:ecs-logging-python-ref: https://www.elastic.co/guide/en/ecs-logging/python/{ecs-logging-python} +:ecs-logging-ruby-ref: https://www.elastic.co/guide/en/ecs-logging/ruby/{ecs-logging-ruby} +:ml-docs: https://www.elastic.co/guide/en/machine-learning/{branch} +:eland-docs: https://www.elastic.co/guide/en/elasticsearch/client/eland/current +:eql-ref: https://eql.readthedocs.io/en/latest/query-guide +:subscriptions: https://www.elastic.co/subscriptions +:extendtrial: https://www.elastic.co/trialextension +:wikipedia: https://en.wikipedia.org/wiki +:forum: https://discuss.elastic.co/ +:xpack-forum: https://discuss.elastic.co/c/50-x-pack +:security-forum: https://discuss.elastic.co/c/x-pack/shield +:watcher-forum: https://discuss.elastic.co/c/x-pack/watcher +:monitoring-forum: https://discuss.elastic.co/c/x-pack/marvel +:graph-forum: https://discuss.elastic.co/c/x-pack/graph +:apm-forum: https://discuss.elastic.co/c/apm +:enterprise-search-ref: https://www.elastic.co/guide/en/enterprise-search/{branch} +:app-search-ref: https://www.elastic.co/guide/en/app-search/{branch} +:workplace-search-ref: https://www.elastic.co/guide/en/workplace-search/{branch} +:enterprise-search-node-ref: https://www.elastic.co/guide/en/enterprise-search-clients/enterprise-search-node/{branch} +:enterprise-search-php-ref: https://www.elastic.co/guide/en/enterprise-search-clients/php/{branch} +:enterprise-search-python-ref: https://www.elastic.co/guide/en/enterprise-search-clients/python/{branch} +:enterprise-search-ruby-ref: https://www.elastic.co/guide/en/enterprise-search-clients/ruby/{branch} +:elastic-maps-service: https://maps.elastic.co +:integrations-docs: https://docs.elastic.co/en/integrations +:integrations-devguide: https://www.elastic.co/guide/en/integrations-developer/current +:time-units: {ref}/api-conventions.html#time-units +:byte-units: {ref}/api-conventions.html#byte-units + +////////// +APM agents +The if directives below are required for versions 6.3-7.4 of the legacy APM Get started book. +Without these if directives, the links below fail and break the build. +////////// + +ifdef::apm-py-branch[] +:apm-py-ref-v: https://www.elastic.co/guide/en/apm/agent/python/{apm-py-branch} +endif::[] + +ifdef::apm-node-branch[] +:apm-node-ref-v: https://www.elastic.co/guide/en/apm/agent/nodejs/{apm-node-branch} +endif::[] + +ifdef::apm-rum-branch[] +:apm-rum-ref-v: https://www.elastic.co/guide/en/apm/agent/rum-js/{apm-rum-branch} +endif::[] + +ifdef::apm-ruby-branch[] +:apm-ruby-ref-v: https://www.elastic.co/guide/en/apm/agent/ruby/{apm-ruby-branch} +endif::[] + +ifdef::apm-java-branch[] +:apm-java-ref-v: https://www.elastic.co/guide/en/apm/agent/java/{apm-java-branch} +endif::[] + +ifdef::apm-go-branch[] +:apm-go-ref-v: https://www.elastic.co/guide/en/apm/agent/go/{apm-go-branch} +endif::[] + +ifdef::apm-ios-branch[] +:apm-ios-ref-v: https://www.elastic.co/guide/en/apm/agent/swift/{apm-ios-branch} +endif::[] + +ifdef::apm-dotnet-branch[] +:apm-dotnet-ref-v: https://www.elastic.co/guide/en/apm/agent/dotnet/{apm-dotnet-branch} +endif::[] + +ifdef::apm-php-branch[] +:apm-php-ref-v: https://www.elastic.co/guide/en/apm/agent/php/{apm-php-branch} +endif::[] + +////////// +Elastic Cloud +////////// +:ecloud: Elastic Cloud +:esf: Elastic Serverless Forwarder +:ess: Elasticsearch Service +:ece: Elastic Cloud Enterprise +:eck: Elastic Cloud on Kubernetes +:serverless-full: Elastic Cloud Serverless +:serverless-short: Serverless +:es-serverless: Elasticsearch Serverless +:es3: {es-serverless} +:obs-serverless: Elastic Observability Serverless +:sec-serverless: Elastic Security Serverless +:serverless-docs: https://docs.elastic.co/serverless +:cloud: https://www.elastic.co/guide/en/cloud/current +:ess-utm-params: ?page=docs&placement=docs-body +:ess-baymax: {ess-utm-params} +:ess-trial: https://cloud.elastic.co/registration{ess-utm-params} +:ess-product: https://www.elastic.co/cloud/elasticsearch-service{ess-utm-params} +:ess-console: https://cloud.elastic.co{ess-utm-params} +:ess-console-name: {ess} Console +:ess-deployments: https://cloud.elastic.co/deployments{ess-utm-params} +:ece-ref: https://www.elastic.co/guide/en/cloud-enterprise/{ece-version-link} +:eck-ref: https://www.elastic.co/guide/en/cloud-on-k8s/current +:ess-leadin: You can run Elasticsearch on your own hardware or use our hosted Elasticsearch Service that is available on AWS, GCP, and Azure. {ess-trial}[Try the Elasticsearch Service for free]. +:ess-leadin-short: Our hosted Elasticsearch Service is available on AWS, GCP, and Azure, and you can {ess-trial}[try it for free]. +:ess-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link="{ess-trial}", title="Supported on {ess}"] +:ece-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud_ece.svg[link="{ess-trial}", title="Supported on {ece}"] +:cloud-only: This feature is designed for indirect use by {ess-trial}[{ess}], {ece-ref}[{ece}], and {eck-ref}[{eck}]. Direct use is not supported. +:ess-setting-change: {ess-icon} indicates a change to a supported {cloud}/ec-add-user-settings.html[user setting] for {ess}. +:ess-skip-section: If you use {ess}, skip this section. {ess} handles these changes for you. +:api-cloud: https://www.elastic.co/docs/api/doc/cloud +:api-ece: https://www.elastic.co/docs/api/doc/cloud-enterprise +:api-kibana-serverless: https://www.elastic.co/docs/api/doc/serverless +////////// +Elasticsearch +////////// + +:es-feature-flag: This feature is in development and not yet available for use. This documentation is provided for informational purposes only. + +////////// +Commonly referenced paths in commonly referenced repositories. +////////// +ifdef::elasticsearch-root[] +:es-ref-dir: {elasticsearch-root}/docs/reference +endif::elasticsearch-root[] +////////// +Kibana app and UI names +////////// + +:apm-app: APM app +:uptime-app: Uptime app +:synthetics-app: Synthetics app +:logs-app: Logs app +:metrics-app: Metrics app +:infrastructure-app: Infrastructure app +:siem-app: SIEM app +:security-app: Elastic Security app +:ml-app: Machine Learning +:dev-tools-app: Dev Tools +:ingest-manager-app: Ingest Manager +:stack-manage-app: Stack Management +:stack-monitor-app: Stack Monitoring +:alerts-ui: Alerts and Actions +:rules-ui: Rules +:rac-ui: Rules and Connectors +:connectors-ui: Connectors +:connectors-feature: Actions and Connectors +:stack-rules-feature: Stack Rules +:user-experience: User Experience +:ems: Elastic Maps Service +:ems-init: EMS +:hosted-ems: Elastic Maps Server +:ipm-app: Index Pattern Management +:ingest-pipelines: ingest pipelines +:ingest-pipelines-app: Ingest Pipelines +:ingest-pipelines-cap: Ingest pipelines +:ls-pipelines: Logstash pipelines +:ls-pipelines-app: Logstash Pipelines +:maint-windows: maintenance windows +:maint-windows-app: Maintenance Windows +:maint-windows-cap: Maintenance windows +:custom-roles-app: Custom Roles +:data-source: data view +:data-sources: data views +:data-source-caps: Data View +:data-sources-caps: Data Views +:data-source-cap: Data view +:data-sources-cap: Data views +:project-settings: Project settings +:manage-app: Management +:index-manage-app: Index Management +:data-views-app: Data Views +:rules-app: Rules +:saved-objects-app: Saved Objects +:tags-app: Tags +:api-keys-app: API keys +:transforms-app: Transforms +:connectors-app: Connectors +:files-app: Files +:reports-app: Reports +:maps-app: Maps +:alerts-app: Alerts +// Use data-source-cap instead of Data-source +// Use data-sources-cap instead of Data-sources +// Use data-sources-caps instead of Data-Sources + +////////// +Enterprise Search +////////// + +:crawler: Enterprise Search web crawler +:ents: Enterprise Search +:app-search-crawler: App Search web crawler + +////////// +Ingest terms +////////// + +:agent: Elastic Agent +:agents: Elastic Agents +:fleet: Fleet +:fleet-server: Fleet Server +:integrations-server: Integrations Server +:ingest-manager: Ingest Manager +:ingest-management: ingest management +:package-manager: Elastic Package Manager +:integrations: Integrations +:package-registry: Elastic Package Registry +:artifact-registry: Elastic Artifact Registry + +////////// +Common words and phrases +////////// +:aws: AWS +:stack: Elastic Stack +:xpack: X-Pack +:es: Elasticsearch +:kib: Kibana +:esms: {stack} Monitoring Service +:esms-init: ESMS +:ls: Logstash +:beats: Beats +:auditbeat: Auditbeat +:filebeat: Filebeat +:heartbeat: Heartbeat +:metricbeat: Metricbeat +:packetbeat: Packetbeat +:winlogbeat: Winlogbeat +:functionbeat: Functionbeat +:journalbeat: Journalbeat +:es-sql: {es} SQL +:esql: ES|QL +:elastic-agent: {agent} +:k8s: Kubernetes +:log-driver-long: Elastic Logging Plugin for Docker + +:security: X-Pack security +:security-features: security features +:operator-feature: operator privileges feature +:es-security-features: {es} {security-features} +:stack-security-features: {stack} {security-features} +:endpoint-sec: Endpoint Security +////////// +Do not use `endpoint-sec` in versions 8.3.0 and newer +Do not use `endpoint-cloud-sec` in versions 8.5.0 and newer +////////// +:endpoint-cloud-sec: Endpoint and Cloud Security +:elastic-defend: Elastic Defend +:elastic-sec: Elastic Security +:elastic-endpoint: Elastic Endpoint +:swimlane: Swimlane +:sn: ServiceNow +:sn-itsm: ServiceNow ITSM +:sn-itom: ServiceNow ITOM +:sn-sir: ServiceNow SecOps +:jira: Jira +:ibm-r: IBM Resilient +:webhook: Webhook +:webhook-cm: {webhook} - Case Management +:opsgenie: Opsgenie +:bedrock: Amazon Bedrock +:gemini: Google Gemini +:hive: TheHive +:monitoring: X-Pack monitoring +:monitor-features: monitoring features +:stack-monitor-features: {stack} {monitor-features} +:watcher: Watcher +:alert-features: alerting features +:reporting: X-Pack reporting +:report-features: reporting features +:graph: X-Pack graph +:graph-features: graph analytics features +:searchprofiler: Search Profiler +:xpackml: X-Pack machine learning +:ml: machine learning +:ml-cap: Machine learning +:ml-init: ML +:ml-features: machine learning features +:stack-ml-features: {stack} {ml-features} +:ccr: cross-cluster replication +:ccr-cap: Cross-cluster replication +:ccr-init: CCR +:ccs: cross-cluster search +:ccs-cap: Cross-cluster search +:ccs-init: CCS +:ilm: index lifecycle management +:ilm-cap: Index lifecycle management +:ilm-init: ILM +:dlm: data lifecycle management +:dlm-cap: Data lifecycle management +:dlm-init: DLM +:search-snap: searchable snapshot +:search-snaps: searchable snapshots +:search-snaps-cap: Searchable snapshots +:slm: snapshot lifecycle management +:slm-cap: Snapshot lifecycle management +:slm-init: SLM +:rollup-features: data rollup features +:ipm: index pattern management +:ipm-cap: Index pattern + +:rollup: rollup +:rollup-cap: Rollup +:rollups: rollups +:rollups-cap: Rollups +:rollup-job: {rollup} job +:rollup-jobs: {rollup} jobs +:rollup-jobs-cap: {rollup-cap} jobs +:dfeed: datafeed +:dfeeds: datafeeds +:dfeed-cap: Datafeed +:dfeeds-cap: Datafeeds +:ml-jobs: {ml} jobs +:ml-jobs-cap: {ml-cap} jobs +:anomaly-detect: anomaly detection +:anomaly-detect-cap: Anomaly detection +:anomaly-job: {anomaly-detect} job +:anomaly-jobs: {anomaly-detect} jobs +:anomaly-jobs-cap: {anomaly-detect-cap} jobs +:dataframe: data frame +:dataframes: data frames +:dataframe-cap: Data frame +:dataframes-cap: Data frames +:watcher-transform: payload transform +:watcher-transforms: payload transforms +:watcher-transform-cap: Payload transform +:watcher-transforms-cap: Payload transforms +:transform: transform +:transforms: transforms +:transform-cap: Transform +:transforms-cap: Transforms +:dataframe-transform: {transform} +:dataframe-transform-cap: {transform-cap} +:dataframe-transforms: {transforms} +:dataframe-transforms-cap: {transforms-cap} +:dfanalytics-cap: {dataframe-cap} analytics +:dfanalytics: {dataframe} analytics +:dataframe-analytics-config: {dfanalytics} config +:dfanalytics-job: {dfanalytics} job +:dfanalytics-jobs: {dfanalytics} jobs +:dfanalytics-jobs-cap: {dfanalytics-cap} jobs +:cdataframe: continuous {dataframe} +:cdataframes: continuous {dataframes} +:cdataframe-cap: Continuous {dataframe} +:cdataframes-cap: Continuous {dataframes} +:cdataframe-transform: continuous {transform} +:cdataframe-transforms: continuous {transforms} +:cdataframe-transforms-cap: Continuous {transforms} +:ctransform: continuous {transform} +:ctransform-cap: Continuous {transform} +:ctransforms: continuous {transforms} +:ctransforms-cap: Continuous {transforms} +:oldetection: outlier detection +:oldetection-cap: Outlier detection +:olscore: outlier score +:olscores: outlier scores +:fiscore: feature influence score +:evaluatedf-api: evaluate {dfanalytics} API +:evaluatedf-api-cap: Evaluate {dfanalytics} API +:binarysc: binary soft classification +:binarysc-cap: Binary soft classification +:regression: regression +:regression-cap: Regression +:reganalysis: regression analysis +:reganalysis-cap: Regression analysis +:depvar: dependent variable +:feature-var: feature variable +:feature-vars: feature variables +:feature-vars-cap: Feature variables +:classification: classification +:classification-cap: Classification +:classanalysis: classification analysis +:classanalysis-cap: Classification analysis +:infer-cap: Inference +:infer: inference +:lang-ident-cap: Language identification +:lang-ident: language identification +:data-viz: Data Visualizer +:file-data-viz: File Data Visualizer +:feat-imp: feature importance +:feat-imp-cap: Feature importance +:nlp: natural language processing +:nlp-cap: Natural language processing + +:apm-agent: APM agent +:apm-go-agent: Elastic APM Go agent +:apm-go-agents: Elastic APM Go agents +:apm-ios-agent: Elastic APM iOS agent +:apm-ios-agents: Elastic APM iOS agents +:apm-java-agent: Elastic APM Java agent +:apm-java-agents: Elastic APM Java agents +:apm-dotnet-agent: Elastic APM .NET agent +:apm-dotnet-agents: Elastic APM .NET agents +:apm-node-agent: Elastic APM Node.js agent +:apm-node-agents: Elastic APM Node.js agents +:apm-php-agent: Elastic APM PHP agent +:apm-php-agents: Elastic APM PHP agents +:apm-py-agent: Elastic APM Python agent +:apm-py-agents: Elastic APM Python agents +:apm-ruby-agent: Elastic APM Ruby agent +:apm-ruby-agents: Elastic APM Ruby agents +:apm-rum-agent: Elastic APM Real User Monitoring (RUM) JavaScript agent +:apm-rum-agents: Elastic APM RUM JavaScript agents +:apm-lambda-ext: Elastic APM AWS Lambda extension + +:project-monitors: project monitors +:project-monitors-cap: Project monitors +:private-location: Private Location +:private-locations: Private Locations + +:pwd: YOUR_PASSWORD + +:esh: ES-Hadoop + +:default-dist: default distribution +:oss-dist: OSS-only distribution +:observability: Observability + +:api-request-title: Request +:api-prereq-title: Prerequisites +:api-description-title: Description +:api-path-parms-title: Path parameters +:api-query-parms-title: Query parameters +:api-request-body-title: Request body +:api-response-codes-title: Response codes +:api-response-body-title: Response body +:api-example-title: Example +:api-examples-title: Examples +:api-definitions-title: Properties + +:multi-arg: †footnoteref:[multi-arg,This parameter accepts multiple arguments.] +:multi-arg-ref: †footnoteref:[multi-arg] + +////////// +Reusable images +////////// +:yes-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png[Yes,20,15] +:no-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png[No,20,15] + +////////// +Issue and pull request URLs +////////// +:es-repo: https://github.com/elastic/elasticsearch/ +:es-issue: {es-repo}issues/ +:es-pull: {es-repo}pull/ +:es-commit: {es-repo}commit/ +:kib-repo: https://github.com/elastic/kibana/ +:kib-issue: {kib-repo}issues/ +:kibana-issue: {kib-issue} +:kib-pull: {kib-repo}pull/ +:kibana-pull: {kib-pull} +:kib-commit: {kib-repo}commit/ +:ml-repo: https://github.com/elastic/ml-cpp/ +:ml-issue: {ml-repo}issues/ +:ml-pull: {ml-repo}pull/ +:ml-commit: {ml-repo}commit/ +:apm-repo: https://github.com/elastic/apm-server/ +:apm-issue: {apm-repo}issues/ +:apm-pull: {apm-repo}pull/ +:kibana-blob: {kib-repo}blob/{branch}/ +////////// +Legacy definitions +////////// +:apm-get-started-ref: https://www.elastic.co/guide/en/apm/get-started/{branch} +:apm-server-ref: https://www.elastic.co/guide/en/apm/server/{branch} +:apm-server-ref-v: https://www.elastic.co/guide/en/apm/server/{branch} +:apm-server-ref-m: https://www.elastic.co/guide/en/apm/server/master +:apm-server-ref-62: https://www.elastic.co/guide/en/apm/server/6.2 +:apm-server-ref-64: https://www.elastic.co/guide/en/apm/server/6.4 +:apm-server-ref-70: https://www.elastic.co/guide/en/apm/server/7.0 +:apm-overview-ref-v: https://www.elastic.co/guide/en/apm/get-started/{branch} +:apm-overview-ref-70: https://www.elastic.co/guide/en/apm/get-started/7.0 +:apm-overview-ref-m: https://www.elastic.co/guide/en/apm/get-started/master +:infra-guide: https://www.elastic.co/guide/en/infrastructure/guide/{branch} +:a-data-source: a data view + +//// +UI icons and logos from EUI +//// +:icon-bug: pass:[] +:icon-checkInCircleFilled: pass:[] +:icon-warningFilled: pass:[] diff --git a/docs/source/migration/scripts/attribute-converter/attributes.yml b/docs/source/migration/scripts/attribute-converter/attributes.yml new file mode 100644 index 000000000..0fcf37e61 --- /dev/null +++ b/docs/source/migration/scripts/attribute-converter/attributes.yml @@ -0,0 +1,494 @@ +subs: + ref: https://www.elastic.co/guide/en/elasticsearch/reference/current + ref-bare: https://www.elastic.co/guide/en/elasticsearch/reference + ref-8x: https://www.elastic.co/guide/en/elasticsearch/reference/8.1 + ref-80: https://www.elastic.co/guide/en/elasticsearch/reference/8.0 + ref-7x: https://www.elastic.co/guide/en/elasticsearch/reference/7.17 + ref-70: https://www.elastic.co/guide/en/elasticsearch/reference/7.0 + ref-60: https://www.elastic.co/guide/en/elasticsearch/reference/6.0 + ref-64: https://www.elastic.co/guide/en/elasticsearch/reference/6.4 + xpack-ref: https://www.elastic.co/guide/en/x-pack/6.2 + logstash-ref: https://www.elastic.co/guide/en/logstash/current + kibana-ref: https://www.elastic.co/guide/en/kibana/current + kibana-ref-all: https://www.elastic.co/guide/en/kibana + beats-ref-root: https://www.elastic.co/guide/en/beats + beats-ref: https://www.elastic.co/guide/en/beats/libbeat/current + beats-ref-60: https://www.elastic.co/guide/en/beats/libbeat/6.0 + beats-ref-63: https://www.elastic.co/guide/en/beats/libbeat/6.3 + beats-devguide: https://www.elastic.co/guide/en/beats/devguide/current + auditbeat-ref: https://www.elastic.co/guide/en/beats/auditbeat/current + packetbeat-ref: https://www.elastic.co/guide/en/beats/packetbeat/current + metricbeat-ref: https://www.elastic.co/guide/en/beats/metricbeat/current + filebeat-ref: https://www.elastic.co/guide/en/beats/filebeat/current + functionbeat-ref: https://www.elastic.co/guide/en/beats/functionbeat/current + winlogbeat-ref: https://www.elastic.co/guide/en/beats/winlogbeat/current + heartbeat-ref: https://www.elastic.co/guide/en/beats/heartbeat/current + journalbeat-ref: https://www.elastic.co/guide/en/beats/journalbeat/current + ingest-guide: https://www.elastic.co/guide/en/ingest/current + fleet-guide: https://www.elastic.co/guide/en/fleet/current + apm-guide-ref: https://www.elastic.co/guide/en/apm/guide/current + apm-guide-7x: https://www.elastic.co/guide/en/apm/guide/7.17 + apm-app-ref: https://www.elastic.co/guide/en/kibana/current + apm-agents-ref: https://www.elastic.co/guide/en/apm/agent + apm-android-ref: https://www.elastic.co/guide/en/apm/agent/android/current + apm-py-ref: https://www.elastic.co/guide/en/apm/agent/python/current + apm-py-ref-3x: https://www.elastic.co/guide/en/apm/agent/python/3.x + apm-node-ref-index: https://www.elastic.co/guide/en/apm/agent/nodejs + apm-node-ref: https://www.elastic.co/guide/en/apm/agent/nodejs/current + apm-node-ref-1x: https://www.elastic.co/guide/en/apm/agent/nodejs/1.x + apm-rum-ref: https://www.elastic.co/guide/en/apm/agent/rum-js/current + apm-ruby-ref: https://www.elastic.co/guide/en/apm/agent/ruby/current + apm-java-ref: https://www.elastic.co/guide/en/apm/agent/java/current + apm-go-ref: https://www.elastic.co/guide/en/apm/agent/go/current + apm-dotnet-ref: https://www.elastic.co/guide/en/apm/agent/dotnet/current + apm-php-ref: https://www.elastic.co/guide/en/apm/agent/php/current + apm-ios-ref: https://www.elastic.co/guide/en/apm/agent/swift/current + apm-lambda-ref: https://www.elastic.co/guide/en/apm/lambda/current + apm-attacher-ref: https://www.elastic.co/guide/en/apm/attacher/current + docker-logging-ref: https://www.elastic.co/guide/en/beats/loggingplugin/current + esf-ref: https://www.elastic.co/guide/en/esf/{{esf_version}} + kinesis-firehose-ref: https://www.elastic.co/guide/en/kinesis/{{kinesis_version}} + estc-welcome-current: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current + estc-welcome: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current + estc-welcome-all: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions + hadoop-ref: https://www.elastic.co/guide/en/elasticsearch/hadoop/current + stack-ref: https://www.elastic.co/guide/en/elastic-stack/current + stack-ref-67: https://www.elastic.co/guide/en/elastic-stack/6.7 + stack-ref-68: https://www.elastic.co/guide/en/elastic-stack/6.8 + stack-ref-70: https://www.elastic.co/guide/en/elastic-stack/7.0 + stack-ref-80: https://www.elastic.co/guide/en/elastic-stack/8.0 + stack-ov: https://www.elastic.co/guide/en/elastic-stack-overview/current + stack-gs: https://www.elastic.co/guide/en/elastic-stack-get-started/current + stack-gs-current: https://www.elastic.co/guide/en/elastic-stack-get-started/current + javaclient: https://www.elastic.co/guide/en/elasticsearch/client/java-api/current + java-api-client: https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current + java-rest: https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current + jsclient: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current + jsclient-current: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current + es-ruby-client: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current + es-dotnet-client: https://www.elastic.co/guide/en/elasticsearch/client/net-api/current + es-php-client: https://www.elastic.co/guide/en/elasticsearch/client/php-api/current + es-python-client: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current + defguide: https://www.elastic.co/guide/en/elasticsearch/guide/2.x + painless: https://www.elastic.co/guide/en/elasticsearch/painless/current + plugins: https://www.elastic.co/guide/en/elasticsearch/plugins/current + plugins-8x: https://www.elastic.co/guide/en/elasticsearch/plugins/8.1 + plugins-7x: https://www.elastic.co/guide/en/elasticsearch/plugins/7.17 + plugins-6x: https://www.elastic.co/guide/en/elasticsearch/plugins/6.8 + glossary: https://www.elastic.co/guide/en/elastic-stack-glossary/current + upgrade_guide: https://www.elastic.co/products/upgrade_guide + blog-ref: https://www.elastic.co/blog/ + curator-ref: https://www.elastic.co/guide/en/elasticsearch/client/curator/current + curator-ref-current: https://www.elastic.co/guide/en/elasticsearch/client/curator/current + metrics-ref: https://www.elastic.co/guide/en/metrics/current + metrics-guide: https://www.elastic.co/guide/en/metrics/guide/current + logs-ref: https://www.elastic.co/guide/en/logs/current + logs-guide: https://www.elastic.co/guide/en/logs/guide/current + uptime-guide: https://www.elastic.co/guide/en/uptime/current + observability-guide: https://www.elastic.co/guide/en/observability/current + observability-guide-all: https://www.elastic.co/guide/en/observability + siem-guide: https://www.elastic.co/guide/en/siem/guide/current + security-guide: https://www.elastic.co/guide/en/security/current + security-guide-all: https://www.elastic.co/guide/en/security + endpoint-guide: https://www.elastic.co/guide/en/endpoint/current + sql-odbc: https://www.elastic.co/guide/en/elasticsearch/sql-odbc/current + ecs-ref: https://www.elastic.co/guide/en/ecs/{{ecs_version}} + ecs-logging-ref: https://www.elastic.co/guide/en/ecs-logging/overview/{{ecs-logging}} + ecs-logging-go-logrus-ref: https://www.elastic.co/guide/en/ecs-logging/go-logrus/{{ecs-logging-go-logrus}} + ecs-logging-go-zap-ref: https://www.elastic.co/guide/en/ecs-logging/go-zap/{{ecs-logging-go-zap}} + ecs-logging-go-zerolog-ref: https://www.elastic.co/guide/en/ecs-logging/go-zap/{{ecs-logging-go-zerolog}} + ecs-logging-java-ref: https://www.elastic.co/guide/en/ecs-logging/java/{{ecs-logging-java}} + ecs-logging-dotnet-ref: https://www.elastic.co/guide/en/ecs-logging/dotnet/{{ecs-logging-dotnet}} + ecs-logging-nodejs-ref: https://www.elastic.co/guide/en/ecs-logging/nodejs/{{ecs-logging-nodejs}} + ecs-logging-php-ref: https://www.elastic.co/guide/en/ecs-logging/php/{{ecs-logging-php}} + ecs-logging-python-ref: https://www.elastic.co/guide/en/ecs-logging/python/{{ecs-logging-python}} + ecs-logging-ruby-ref: https://www.elastic.co/guide/en/ecs-logging/ruby/{{ecs-logging-ruby}} + ml-docs: https://www.elastic.co/guide/en/machine-learning/current + eland-docs: https://www.elastic.co/guide/en/elasticsearch/client/eland/current + eql-ref: https://eql.readthedocs.io/en/latest/query-guide + subscriptions: https://www.elastic.co/subscriptions + extendtrial: https://www.elastic.co/trialextension + wikipedia: https://en.wikipedia.org/wiki + forum: https://discuss.elastic.co/ + xpack-forum: https://discuss.elastic.co/c/50-x-pack + security-forum: https://discuss.elastic.co/c/x-pack/shield + watcher-forum: https://discuss.elastic.co/c/x-pack/watcher + monitoring-forum: https://discuss.elastic.co/c/x-pack/marvel + graph-forum: https://discuss.elastic.co/c/x-pack/graph + apm-forum: https://discuss.elastic.co/c/apm + enterprise-search-ref: https://www.elastic.co/guide/en/enterprise-search/current + app-search-ref: https://www.elastic.co/guide/en/app-search/current + workplace-search-ref: https://www.elastic.co/guide/en/workplace-search/current + enterprise-search-node-ref: https://www.elastic.co/guide/en/enterprise-search-clients/enterprise-search-node/current + enterprise-search-php-ref: https://www.elastic.co/guide/en/enterprise-search-clients/php/current + enterprise-search-python-ref: https://www.elastic.co/guide/en/enterprise-search-clients/python/current + enterprise-search-ruby-ref: https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current + elastic-maps-service: https://maps.elastic.co + integrations-docs: https://docs.elastic.co/en/integrations + integrations-devguide: https://www.elastic.co/guide/en/integrations-developer/current + time-units: https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#time-units + byte-units: https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units + apm-py-ref-v: https://www.elastic.co/guide/en/apm/agent/python/{{apm-py-branch}} + apm-node-ref-v: https://www.elastic.co/guide/en/apm/agent/nodejs/{{apm-node-branch}} + apm-rum-ref-v: https://www.elastic.co/guide/en/apm/agent/rum-js/{{apm-rum-branch}} + apm-ruby-ref-v: https://www.elastic.co/guide/en/apm/agent/ruby/{{apm-ruby-branch}} + apm-java-ref-v: https://www.elastic.co/guide/en/apm/agent/java/{{apm-java-branch}} + apm-go-ref-v: https://www.elastic.co/guide/en/apm/agent/go/{{apm-go-branch}} + apm-ios-ref-v: https://www.elastic.co/guide/en/apm/agent/swift/{{apm-ios-branch}} + apm-dotnet-ref-v: https://www.elastic.co/guide/en/apm/agent/dotnet/{{apm-dotnet-branch}} + apm-php-ref-v: https://www.elastic.co/guide/en/apm/agent/php/{{apm-php-branch}} + ecloud: Elastic Cloud + esf: Elastic Serverless Forwarder + ess: Elasticsearch Service + ece: Elastic Cloud Enterprise + eck: Elastic Cloud on Kubernetes + serverless-full: Elastic Cloud Serverless + serverless-short: Serverless + es-serverless: Elasticsearch Serverless + es3: Elasticsearch Serverless + obs-serverless: Elastic Observability Serverless + sec-serverless: Elastic Security Serverless + serverless-docs: https://docs.elastic.co/serverless + cloud: https://www.elastic.co/guide/en/cloud/current + ess-utm-params: ?page=docs&placement=docs-body + ess-baymax: ?page=docs&placement=docs-body + ess-trial: https://cloud.elastic.co/registration?page=docs&placement=docs-body + ess-product: https://www.elastic.co/cloud/elasticsearch-service?page=docs&placement=docs-body + ess-console: https://cloud.elastic.co?page=docs&placement=docs-body + ess-console-name: Elasticsearch Service Console + ess-deployments: https://cloud.elastic.co/deployments?page=docs&placement=docs-body + ece-ref: https://www.elastic.co/guide/en/cloud-enterprise/{{ece-version-link}} + eck-ref: https://www.elastic.co/guide/en/cloud-on-k8s/current + ess-leadin: You can run Elasticsearch on your own hardware or use our hosted Elasticsearch + Service that is available on AWS, GCP, and Azure. https://cloud.elastic.co/registration{ess-utm-params}[Try + the Elasticsearch Service for free]. + ess-leadin-short: Our hosted Elasticsearch Service is available on AWS, GCP, and + Azure, and you can https://cloud.elastic.co/registration{ess-utm-params}[try it + for free]. + ess-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link="https://cloud.elastic.co/registration{ess-utm-params}", + title="Supported on Elasticsearch Service"] + ece-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud_ece.svg[link="https://cloud.elastic.co/registration{ess-utm-params}", + title="Supported on Elastic Cloud Enterprise"] + cloud-only: This feature is designed for indirect use by https://cloud.elastic.co/registration{ess-utm-params}[Elasticsearch + Service], https://www.elastic.co/guide/en/cloud-enterprise/{ece-version-link}[Elastic + Cloud Enterprise], and https://www.elastic.co/guide/en/cloud-on-k8s/current[Elastic + Cloud on Kubernetes]. Direct use is not supported. + ess-setting-change: image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link="{ess-trial}", + title="Supported on {ess}"] indicates a change to a supported https://www.elastic.co/guide/en/cloud/current/ec-add-user-settings.html[user + setting] for Elasticsearch Service. + ess-skip-section: If you use Elasticsearch Service, skip this section. Elasticsearch + Service handles these changes for you. + api-cloud: https://www.elastic.co/docs/api/doc/cloud + api-ece: https://www.elastic.co/docs/api/doc/cloud-enterprise + api-kibana-serverless: https://www.elastic.co/docs/api/doc/serverless + es-feature-flag: This feature is in development and not yet available for use. This + documentation is provided for informational purposes only. + es-ref-dir: '{{elasticsearch-root}}/docs/reference' + apm-app: APM app + uptime-app: Uptime app + synthetics-app: Synthetics app + logs-app: Logs app + metrics-app: Metrics app + infrastructure-app: Infrastructure app + siem-app: SIEM app + security-app: Elastic Security app + ml-app: Machine Learning + dev-tools-app: Dev Tools + ingest-manager-app: Ingest Manager + stack-manage-app: Stack Management + stack-monitor-app: Stack Monitoring + alerts-ui: Alerts and Actions + rules-ui: Rules + rac-ui: Rules and Connectors + connectors-ui: Connectors + connectors-feature: Actions and Connectors + stack-rules-feature: Stack Rules + user-experience: User Experience + ems: Elastic Maps Service + ems-init: EMS + hosted-ems: Elastic Maps Server + ipm-app: Index Pattern Management + ingest-pipelines: ingest pipelines + ingest-pipelines-app: Ingest Pipelines + ingest-pipelines-cap: Ingest pipelines + ls-pipelines: Logstash pipelines + ls-pipelines-app: Logstash Pipelines + maint-windows: maintenance windows + maint-windows-app: Maintenance Windows + maint-windows-cap: Maintenance windows + custom-roles-app: Custom Roles + data-source: data view + data-sources: data views + data-source-caps: Data View + data-sources-caps: Data Views + data-source-cap: Data view + data-sources-cap: Data views + project-settings: Project settings + manage-app: Management + index-manage-app: Index Management + data-views-app: Data Views + rules-app: Rules + saved-objects-app: Saved Objects + tags-app: Tags + api-keys-app: API keys + transforms-app: Transforms + connectors-app: Connectors + files-app: Files + reports-app: Reports + maps-app: Maps + alerts-app: Alerts + crawler: Enterprise Search web crawler + ents: Enterprise Search + app-search-crawler: App Search web crawler + agent: Elastic Agent + agents: Elastic Agents + fleet: Fleet + fleet-server: Fleet Server + integrations-server: Integrations Server + ingest-manager: Ingest Manager + ingest-management: ingest management + package-manager: Elastic Package Manager + integrations: Integrations + package-registry: Elastic Package Registry + artifact-registry: Elastic Artifact Registry + aws: AWS + stack: Elastic Stack + xpack: X-Pack + es: Elasticsearch + kib: Kibana + esms: Elastic Stack Monitoring Service + esms-init: ESMS + ls: Logstash + beats: Beats + auditbeat: Auditbeat + filebeat: Filebeat + heartbeat: Heartbeat + metricbeat: Metricbeat + packetbeat: Packetbeat + winlogbeat: Winlogbeat + functionbeat: Functionbeat + journalbeat: Journalbeat + es-sql: Elasticsearch SQL + esql: ES|QL + elastic-agent: Elastic Agent + k8s: Kubernetes + log-driver-long: Elastic Logging Plugin for Docker + security: X-Pack security + security-features: security features + operator-feature: operator privileges feature + es-security-features: Elasticsearch security features + stack-security-features: Elastic Stack security features + endpoint-sec: Endpoint Security + endpoint-cloud-sec: Endpoint and Cloud Security + elastic-defend: Elastic Defend + elastic-sec: Elastic Security + elastic-endpoint: Elastic Endpoint + swimlane: Swimlane + sn: ServiceNow + sn-itsm: ServiceNow ITSM + sn-itom: ServiceNow ITOM + sn-sir: ServiceNow SecOps + jira: Jira + ibm-r: IBM Resilient + webhook: Webhook + webhook-cm: Webhook - Case Management + opsgenie: Opsgenie + bedrock: Amazon Bedrock + gemini: Google Gemini + hive: TheHive + monitoring: X-Pack monitoring + monitor-features: monitoring features + stack-monitor-features: Elastic Stack monitoring features + watcher: Watcher + alert-features: alerting features + reporting: X-Pack reporting + report-features: reporting features + graph: X-Pack graph + graph-features: graph analytics features + searchprofiler: Search Profiler + xpackml: X-Pack machine learning + ml: machine learning + ml-cap: Machine learning + ml-init: ML + ml-features: machine learning features + stack-ml-features: Elastic Stack machine learning features + ccr: cross-cluster replication + ccr-cap: Cross-cluster replication + ccr-init: CCR + ccs: cross-cluster search + ccs-cap: Cross-cluster search + ccs-init: CCS + ilm: index lifecycle management + ilm-cap: Index lifecycle management + ilm-init: ILM + dlm: data lifecycle management + dlm-cap: Data lifecycle management + dlm-init: DLM + search-snap: searchable snapshot + search-snaps: searchable snapshots + search-snaps-cap: Searchable snapshots + slm: snapshot lifecycle management + slm-cap: Snapshot lifecycle management + slm-init: SLM + rollup-features: data rollup features + ipm: index pattern management + ipm-cap: Index pattern + rollup: rollup + rollup-cap: Rollup + rollups: rollups + rollups-cap: Rollups + rollup-job: rollup job + rollup-jobs: rollup jobs + rollup-jobs-cap: Rollup jobs + dfeed: datafeed + dfeeds: datafeeds + dfeed-cap: Datafeed + dfeeds-cap: Datafeeds + ml-jobs: machine learning jobs + ml-jobs-cap: Machine learning jobs + anomaly-detect: anomaly detection + anomaly-detect-cap: Anomaly detection + anomaly-job: anomaly detection job + anomaly-jobs: anomaly detection jobs + anomaly-jobs-cap: Anomaly detection jobs + dataframe: data frame + dataframes: data frames + dataframe-cap: Data frame + dataframes-cap: Data frames + watcher-transform: payload transform + watcher-transforms: payload transforms + watcher-transform-cap: Payload transform + watcher-transforms-cap: Payload transforms + transform: transform + transforms: transforms + transform-cap: Transform + transforms-cap: Transforms + dataframe-transform: transform + dataframe-transform-cap: Transform + dataframe-transforms: transforms + dataframe-transforms-cap: Transforms + dfanalytics-cap: Data frame analytics + dfanalytics: data frame analytics + dataframe-analytics-config: '{dataframe} analytics config' + dfanalytics-job: '{dataframe} analytics job' + dfanalytics-jobs: '{dataframe} analytics jobs' + dfanalytics-jobs-cap: '{dataframe-cap} analytics jobs' + cdataframe: continuous data frame + cdataframes: continuous data frames + cdataframe-cap: Continuous data frame + cdataframes-cap: Continuous data frames + cdataframe-transform: continuous transform + cdataframe-transforms: continuous transforms + cdataframe-transforms-cap: Continuous transforms + ctransform: continuous transform + ctransform-cap: Continuous transform + ctransforms: continuous transforms + ctransforms-cap: Continuous transforms + oldetection: outlier detection + oldetection-cap: Outlier detection + olscore: outlier score + olscores: outlier scores + fiscore: feature influence score + evaluatedf-api: evaluate {dataframe} analytics API + evaluatedf-api-cap: Evaluate {dataframe} analytics API + binarysc: binary soft classification + binarysc-cap: Binary soft classification + regression: regression + regression-cap: Regression + reganalysis: regression analysis + reganalysis-cap: Regression analysis + depvar: dependent variable + feature-var: feature variable + feature-vars: feature variables + feature-vars-cap: Feature variables + classification: classification + classification-cap: Classification + classanalysis: classification analysis + classanalysis-cap: Classification analysis + infer-cap: Inference + infer: inference + lang-ident-cap: Language identification + lang-ident: language identification + data-viz: Data Visualizer + file-data-viz: File Data Visualizer + feat-imp: feature importance + feat-imp-cap: Feature importance + nlp: natural language processing + nlp-cap: Natural language processing + apm-agent: APM agent + apm-go-agent: Elastic APM Go agent + apm-go-agents: Elastic APM Go agents + apm-ios-agent: Elastic APM iOS agent + apm-ios-agents: Elastic APM iOS agents + apm-java-agent: Elastic APM Java agent + apm-java-agents: Elastic APM Java agents + apm-dotnet-agent: Elastic APM .NET agent + apm-dotnet-agents: Elastic APM .NET agents + apm-node-agent: Elastic APM Node.js agent + apm-node-agents: Elastic APM Node.js agents + apm-php-agent: Elastic APM PHP agent + apm-php-agents: Elastic APM PHP agents + apm-py-agent: Elastic APM Python agent + apm-py-agents: Elastic APM Python agents + apm-ruby-agent: Elastic APM Ruby agent + apm-ruby-agents: Elastic APM Ruby agents + apm-rum-agent: Elastic APM Real User Monitoring (RUM) JavaScript agent + apm-rum-agents: Elastic APM RUM JavaScript agents + apm-lambda-ext: Elastic APM AWS Lambda extension + project-monitors: project monitors + project-monitors-cap: Project monitors + private-location: Private Location + private-locations: Private Locations + pwd: YOUR_PASSWORD + esh: ES-Hadoop + default-dist: default distribution + oss-dist: OSS-only distribution + observability: Observability + api-request-title: Request + api-prereq-title: Prerequisites + api-description-title: Description + api-path-parms-title: Path parameters + api-query-parms-title: Query parameters + api-request-body-title: Request body + api-response-codes-title: Response codes + api-response-body-title: Response body + api-example-title: Example + api-examples-title: Examples + api-definitions-title: Properties + multi-arg: †footnoteref:[multi-arg,This parameter accepts multiple arguments.] + multi-arg-ref: †footnoteref:[multi-arg] + yes-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png[Yes,20,15] + no-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png[No,20,15] + es-repo: https://github.com/elastic/elasticsearch/ + es-issue: https://github.com/elastic/elasticsearch/issues/ + es-pull: https://github.com/elastic/elasticsearch/pull/ + es-commit: https://github.com/elastic/elasticsearch/commit/ + kib-repo: https://github.com/elastic/kibana/ + kib-issue: https://github.com/elastic/kibana/issues/ + kibana-issue: '{kib-repo}issues/' + kib-pull: https://github.com/elastic/kibana/pull/ + kibana-pull: '{kib-repo}pull/' + kib-commit: https://github.com/elastic/kibana/commit/ + ml-repo: https://github.com/elastic/ml-cpp/ + ml-issue: https://github.com/elastic/ml-cpp/issues/ + ml-pull: https://github.com/elastic/ml-cpp/pull/ + ml-commit: https://github.com/elastic/ml-cpp/commit/ + apm-repo: https://github.com/elastic/apm-server/ + apm-issue: https://github.com/elastic/apm-server/issues/ + apm-pull: https://github.com/elastic/apm-server/pull/ + kibana-blob: https://github.com/elastic/kibana/blob/current/ + apm-get-started-ref: https://www.elastic.co/guide/en/apm/get-started/current + apm-server-ref: https://www.elastic.co/guide/en/apm/server/current + apm-server-ref-v: https://www.elastic.co/guide/en/apm/server/current + apm-server-ref-m: https://www.elastic.co/guide/en/apm/server/master + apm-server-ref-62: https://www.elastic.co/guide/en/apm/server/6.2 + apm-server-ref-64: https://www.elastic.co/guide/en/apm/server/6.4 + apm-server-ref-70: https://www.elastic.co/guide/en/apm/server/7.0 + apm-overview-ref-v: https://www.elastic.co/guide/en/apm/get-started/current + apm-overview-ref-70: https://www.elastic.co/guide/en/apm/get-started/7.0 + apm-overview-ref-m: https://www.elastic.co/guide/en/apm/get-started/master + infra-guide: https://www.elastic.co/guide/en/infrastructure/guide/current + a-data-source: a data view + icon-bug: pass:[] + icon-checkInCircleFilled: pass:[] + icon-warningFilled: pass:[] diff --git a/docs/source/migration/scripts/codeowner-gen/codeowner.py b/docs/source/migration/scripts/codeowner-gen/codeowner.py new file mode 100644 index 000000000..05c1ab523 --- /dev/null +++ b/docs/source/migration/scripts/codeowner-gen/codeowner.py @@ -0,0 +1,114 @@ +import yaml +from collections import defaultdict +import os + +def read_yaml(file_path): + """Reads and parses the YAML file.""" + with open(file_path, 'r', encoding='utf-8') as file: + return yaml.safe_load(file) + +def traverse_sections(sections, repo_paths): + """ + Recursively traverses nested sections to gather repository paths. + + Args: + sections (list): List of section dictionaries. + repo_paths (defaultdict): Dictionary mapping repo names to sets of paths. + """ + for section in sections: + # Gather sources in the current section + sources = section.get('sources', []) + for source in sources: + repo_name = source.get('repo') + path = source.get('path') + if repo_name and path: + # Remove trailing slashes and replace double slashes with single slashes + clean_path = path.rstrip('/').replace('//', '/') + # Format the path for CODEOWNERS + formatted_path = f"{clean_path}/*.asciidoc @docs-freeze-team" + repo_paths[repo_name].add(formatted_path) + + # If there are nested sections, traverse them recursively + nested_sections = section.get('sections', []) + if nested_sections: + traverse_sections(nested_sections, repo_paths) + +def gather_repo_paths(contents): + """ + Gathers all unique paths for each repository from the contents. + + Args: + contents (list): List of content dictionaries from YAML. + + Returns: + defaultdict: Dictionary mapping repo names to sets of formatted paths. + """ + repo_paths = defaultdict(set) + for content in contents: + sections = content.get('sections', []) + traverse_sections(sections, repo_paths) + return repo_paths + +def generate_markdown_output(repo_paths, repos_info): + """ + Generates Markdown output with repository headings and CODEOWNERS code blocks. + + Args: + repo_paths (dict): Dictionary mapping repo names to sets of paths. + repos_info (dict): Dictionary mapping repo names to their GitHub URLs. + + Returns: + str: Formatted Markdown content as a string. + """ + output = "" + for repo in sorted(repo_paths.keys()): + repo_url = repos_info.get(repo, '#') # Default to '#' if URL not found + if repo_url.endswith('.git'): + repo_url = repo_url[:-4] # Remove the '.git' suffix for proper URL + + # Create level three heading with repository link + output += f"### [{repo}]({repo_url})\n\n" + + # Start code block + output += "```\n" + + # Add each CODEOWNERS line within the code block + for path in sorted(repo_paths[repo]): + output += f"{path}\n" + + # End code block + output += "```\n\n" + + return output + +def main(): + # Define the path to the 'conf.yaml' file (assumes it's in the same directory) + script_dir = os.path.dirname(os.path.abspath(__file__)) + file_path = os.path.join(script_dir, 'conf.yaml') + + # Read and parse the YAML file + yaml_content = read_yaml(file_path) + + # Extract repository information + repos_info = yaml_content.get('repos', {}) + + # Extract contents + contents = yaml_content.get('contents', []) + + # Gather all repository paths + repo_paths = gather_repo_paths(contents) + + # Generate the Markdown content + markdown_output = generate_markdown_output(repo_paths, repos_info) + + # Define the output Markdown file path + output_path = os.path.join(script_dir, 'output.md') + + # Write the Markdown content to the file + with open(output_path, 'w', encoding='utf-8') as output_file: + output_file.write(markdown_output) + + print(f"Markdown content has been written to '{output_path}'") + +if __name__ == "__main__": + main() diff --git a/docs/source/migration/scripts/codeowner-gen/conf.yaml b/docs/source/migration/scripts/codeowner-gen/conf.yaml new file mode 100644 index 000000000..ccf2a7865 --- /dev/null +++ b/docs/source/migration/scripts/codeowner-gen/conf.yaml @@ -0,0 +1,3022 @@ +repos: + apm-aws-lambda: https://github.com/elastic/apm-aws-lambda.git + apm-k8s-attacher: https://github.com/elastic/apm-k8s-attacher.git + apm-server: https://github.com/elastic/apm-server.git + apm-agent-android: https://github.com/elastic/apm-agent-android.git + apm-agent-nodejs: https://github.com/elastic/apm-agent-nodejs.git + apm-agent-python: https://github.com/elastic/apm-agent-python.git + apm-agent-ruby: https://github.com/elastic/apm-agent-ruby.git + apm-agent-rum-js: https://github.com/elastic/apm-agent-rum-js.git + apm-agent-go: https://github.com/elastic/apm-agent-go.git + apm-agent-java: https://github.com/elastic/apm-agent-java.git + apm-agent-dotnet: https://github.com/elastic/apm-agent-dotnet.git + apm-agent-php: https://github.com/elastic/apm-agent-php.git + apm-agent-ios: https://github.com/elastic/apm-agent-ios.git + azure-marketplace: https://github.com/elastic/azure-marketplace.git + beats: https://github.com/elastic/beats.git + clients-team: https://github.com/elastic/clients-team.git + cloud: https://github.com/elastic/cloud.git + cloud-assets: https://github.com/elastic/cloud-assets.git + cloud-on-k8s: https://github.com/elastic/cloud-on-k8s.git + curator: https://github.com/elastic/curator.git + docs-content: https://github.com/elastic/docs-content.git + ecctl: https://github.com/elastic/ecctl.git + ecs: https://github.com/elastic/ecs.git + ecs-dotnet: https://github.com/elastic/ecs-dotnet.git + ecs-logging: https://github.com/elastic/ecs-logging.git + ecs-logging-go-logrus: https://github.com/elastic/ecs-logging-go-logrus.git + ecs-logging-go-zap: https://github.com/elastic/ecs-logging-go-zap.git + ecs-logging-go-zerolog: https://github.com/elastic/ecs-logging-go-zerolog.git + ecs-logging-java: https://github.com/elastic/ecs-logging-java.git + ecs-logging-nodejs: https://github.com/elastic/ecs-logging-nodejs.git + ecs-logging-php: https://github.com/elastic/ecs-logging-php.git + ecs-logging-python: https://github.com/elastic/ecs-logging-python.git + ecs-logging-ruby: https://github.com/elastic/ecs-logging-ruby.git + eland: https://github.com/elastic/eland.git + elasticsearch-hadoop: https://github.com/elastic/elasticsearch-hadoop.git + elasticsearch-java: https://github.com/elastic/elasticsearch-java.git + elasticsearch-js: https://github.com/elastic/elasticsearch-js.git + elasticsearch-js-legacy: https://github.com/elastic/elasticsearch-js-legacy.git + elasticsearch-ruby: https://github.com/elastic/elasticsearch-ruby.git + elasticsearch-net: https://github.com/elastic/elasticsearch-net.git + elasticsearch-php: https://github.com/elastic/elasticsearch-php.git + elasticsearch-php-cn: https://github.com/elasticsearch-cn/elasticsearch-php.git + elasticsearch-py: https://github.com/elastic/elasticsearch-py.git + elasticsearch-perl: https://github.com/elastic/elasticsearch-perl.git + go-elasticsearch: https://github.com/elastic/go-elasticsearch.git + elasticsearch-rs: https://github.com/elastic/elasticsearch-rs.git + elasticsearch: https://github.com/elastic/elasticsearch.git + enterprise-search-pubs: https://github.com/elastic/enterprise-search-pubs.git + enterprise-search-js: https://github.com/elastic/enterprise-search-js.git + enterprise-search-php: https://github.com/elastic/enterprise-search-php.git + enterprise-search-python: https://github.com/elastic/enterprise-search-python.git + enterprise-search-ruby: https://github.com/elastic/enterprise-search-ruby.git + esf: https://github.com/elastic/elastic-serverless-forwarder.git + guide: https://github.com/elastic/elasticsearch-definitive-guide.git + guide-cn: https://github.com/elasticsearch-cn/elasticsearch-definitive-guide.git + ingest-docs: https://github.com/elastic/ingest-docs.git + integration-docs: https://github.com/elastic/integration-docs.git + kibana: https://github.com/elastic/kibana.git + kibana-cn: https://github.com/elasticsearch-cn/kibana.git + logstash: https://github.com/elastic/logstash.git + logstash-docs: https://github.com/elastic/logstash-docs.git + observability-docs: https://github.com/elastic/observability-docs.git + package-spec: https://github.com/elastic/package-spec.git + search-ui: https://github.com/elastic/search-ui.git + security-docs: https://github.com/elastic/security-docs.git + sense: https://github.com/elastic/sense.git + stack-docs: https://github.com/elastic/stack-docs.git + swiftype: https://github.com/elastic/swiftype-doc-placeholder.git + tech-content: https://github.com/elastic/tech-content.git + terraform-provider-ec: https://github.com/elastic/terraform-provider-ec.git + x-pack: https://github.com/elastic/x-pack.git + x-pack-elasticsearch: https://github.com/elastic/x-pack-elasticsearch.git + x-pack-kibana: https://github.com/elastic/x-pack-kibana.git + x-pack-logstash: https://github.com/elastic/x-pack-logstash.git + +contents_title: Elastic documentation + +# Each item should take the form: +# : & +# The keys don't really matter, but by convention the are the same as the variable. +variables: + stackcurrent: &stackcurrent 8.17 + stacklive: &stacklive [ 8.17, 7.17 ] + + cloudSaasCurrent: &cloudSaasCurrent ms-117 + + mapCloudEceToClientsTeam: &mapCloudEceToClientsTeam + ms-105: main + ms-92: main + ms-81: main + ms-78: main + ms-75: main + ms-72: main + ms-70: main + ms-69: main + ms-65: main + ms-62: main + ms-59: main + ms-57: main + ms-53: main + ms-49: main + ms-47: main + release-ms-41: main + 2.5: main + 2.4: main + 2.3: main + 2.2: main + 2.1: main + 2.0: main + 1.1: main + 1.0: main + + # Use this when you're building a book that uses a "main" branch, but it has a dependency on a repo with a "master" branch + mapMainToMaster: &mapMainToMaster + main: master + + # Use this when you're building a book that uses a "master" branch, but it has a dependency on a repo with a "main" branch + mapMasterToMain: &mapMasterToMain + master: main + + beatsSharedExclude: &beatsSharedExclude [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + beatsXpackLibbeatExclude: &beatsXpackLibbeatExclude [ 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + beatsProcessorExclude: &beatsProcessorExclude [ 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + beatsOutputExclude: &beatsOutputExclude [ 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + + +toc_extra: extra/docs_landing.html +contents: + - title: Search UI + sections: + - title: Search UI + prefix: en/search-ui + current: main + branches: [ main ] + live: [ main ] + index: docs/index.asciidoc + chunk: 3 + tags: Search UI/Guide + subject: Search UI + sources: + - + repo: search-ui + path: docs + - title: Integrations + sections: + - title: Integrations + prefix: en/integrations + current: main + branches: [ main ] + live: [ main ] + index: dist/index.asciidoc + chunk: 2 + private: 1 + tags: Integrations/Reference + subject: Integrations + sources: + - + repo: integration-docs + path: dist + - title: Serverless + sections: + - title: Serverless + prefix: en/serverless + current: main + branches: [ main ] + live: [ main ] + index: serverless/index.asciidoc + chunk: 5 + tags: Serverless/Guide + subject: Serverless + sources: + - + repo: docs-content + path: serverless + - + repo: observability-docs + path: docs/en/serverless + - + repo: security-docs + path: docs/serverless + + - title: Search + sections: + - title: Elasticsearch Guide + prefix: en/elasticsearch/reference + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + live: *stacklive + index: docs/reference/index.x.asciidoc + chunk: 1 + tags: Elasticsearch/Reference + subject: Elasticsearch + sources: + - + repo: elasticsearch + path: docs/reference + - + repo: x-pack-elasticsearch + prefix: elasticsearch-extra/x-pack-elasticsearch + path: docs/en + private: true + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: x-pack-elasticsearch + prefix: elasticsearch-extra/x-pack-elasticsearch + path: qa/sql + private: true + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: docs/Versions.asciidoc + exclude_branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: docs/src/test/cluster/config + exclude_branches: [ 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: plugins/examples + exclude_branches: [ 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: buildSrc/ + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: build-tools-internal/ + exclude_branches: [7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: docs/painless + exclude_branches: [ 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: x-pack/docs + private: true + # only exists from 6.2 to 8.9 + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: x-pack/qa/sql + # only exists from 6.3 to 6.5 + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: x-pack/plugin/esql/qa/testFixtures/src/main/resources + # only exists from 8.11 + exclude_branches: [ 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: x-pack/plugin/sql/qa + exclude_branches: [ 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + alternatives: { source_lang: console, alternative_lang: php } + repo: elasticsearch-php + path: docs/examples + exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + alternatives: { source_lang: console, alternative_lang: python } + repo: elasticsearch-py + path: docs/examples + exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + alternatives: { source_lang: console, alternative_lang: ruby } + repo: elasticsearch-ruby + path: docs/examples/guide + exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + alternatives: { source_lang: console, alternative_lang: go } + repo: go-elasticsearch + path: .doc/examples/doc/ + exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: docs + path: shared/attributes62.asciidoc + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + alternatives: { source_lang: console, alternative_lang: js } + repo: elasticsearch-js + path: docs/doc_examples + exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: server/src/main/resources/org/elasticsearch/common + exclude_branches: [ 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - title: Enterprise Search Guide + prefix: en/enterprise-search + index: enterprise-search-docs/index.asciidoc + private: 1 + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7 ] + live: *stacklive + chunk: 1 + tags: Enterprise Search/Guide + subject: Enterprise Search + sources: + - + repo: enterprise-search-pubs + path: enterprise-search-docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: Workplace Search Guide + prefix: en/workplace-search + index: workplace-search-docs/index.asciidoc + private: 1 + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6 ] + live: *stacklive + chunk: 1 + tags: Workplace Search/Guide + subject: Workplace Search + sources: + - + repo: enterprise-search-pubs + path: workplace-search-docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: App Search Guide + prefix: en/app-search + index: app-search-docs/index.asciidoc + private: 1 + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7 ] + live: *stacklive + chunk: 1 + tags: App Search/Guide + subject: App Search + sources: + - + repo: enterprise-search-pubs + path: app-search-docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: Enterprise Search Clients + base_dir: en/enterprise-search-clients + sections: + - title: App Search JavaScript client + prefix: app-search-javascript + private: 1 + single: 1 + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] + live: *stacklive + index: client-docs/app-search-javascript/index.asciidoc + tags: App Search Clients/JavaScript + subject: App Search Clients + sources: + - + repo: enterprise-search-pubs + path: client-docs/app-search-javascript + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: App Search Node.js client + prefix: app-search-node + private: 1 + single: 1 + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] + live: *stacklive + index: client-docs/app-search-node/index.asciidoc + tags: App Search Clients/Node.js + subject: App Search Clients + sources: + - + repo: enterprise-search-pubs + path: client-docs/app-search-node + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: Enterprise Search Node.js client + prefix: enterprise-search-node + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6 ] + live: [ *stackcurrent ] + index: packages/enterprise-search/docs/index.asciidoc + tags: Enterprise Search Clients/Node.js + subject: Enterprise Search Clients + sources: + - + repo: enterprise-search-js + path: packages/enterprise-search/docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: Enterprise Search PHP client + prefix: php + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] + live: *stacklive + index: docs/guide/index.asciidoc + tags: Enterprise Search Clients/PHP + subject: Enterprise Search Clients + sources: + - + repo: enterprise-search-php + path: docs/guide/ + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: Enterprise Search Python client + prefix: python + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11 ] + live: *stacklive + index: docs/guide/index.asciidoc + tags: Enterprise Search Clients/Python + subject: Enterprise Search Clients + sources: + - + repo: enterprise-search-python + path: docs/guide/ + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: Enterprise Search Ruby client + prefix: ruby + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11 ] + live: *stacklive + index: docs/guide/index.asciidoc + tags: Enterprise Search Clients/Ruby + subject: Enterprise Search Clients + sources: + - + repo: enterprise-search-ruby + path: docs/guide/ + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: Workplace Search Node.js client + prefix: workplace-search-node + private: 1 + single: 1 + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] + live: *stacklive + index: client-docs/workplace-search-node/index.asciidoc + tags: Workplace Search Clients/Node.js + subject: Workplace Search Clients + sources: + - + repo: enterprise-search-pubs + path: client-docs/workplace-search-node + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: "Observability: APM, Logs, Metrics, and Uptime" + sections: + - title: Observability + prefix: en/observability + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9 ] + live: *stacklive + index: docs/en/observability/index.asciidoc + chunk: 4 + tags: Observability/Guide + subject: Observability + sources: + - + repo: observability-docs + path: docs/en + - + repo: ingest-docs + path: docs/en + - + repo: apm-server + path: docs + exclude_branches: [ 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: apm-server + path: changelogs + exclude_branches: [ 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: apm-server + path: CHANGELOG.asciidoc + exclude_branches: [ 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: beats + path: libbeat/docs + exclude_branches: [ 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - title: Application Performance Monitoring (APM) + base_dir: en/apm + toc_extra: extra/apm_docs_landing.html + sections: + - title: APM Guide + prefix: guide + toc_extra: extra/apm_guide_landing.html + index: docs/en/apm-server/integrations-index.asciidoc + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] + live: *stacklive + chunk: 2 + tags: APM Guide + subject: APM + sources: + - + repo: observability-docs + path: docs/en + exclude_branches: [ 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + map_branches: *mapMasterToMain + - + repo: apm-server + path: changelogs + exclude_branches: [ 6.0 ] + - + repo: apm-server + path: docs/data + - + repo: apm-server + path: docs/spec + - + repo: apm-server + path: CHANGELOG.asciidoc + - + repo: ingest-docs + path: docs/en + exclude_branches: [ 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - title: APM Agents + base_dir: agent + sections: + - title: APM Android Agent + prefix: android + current: 0.x + branches: [ {main: master}, 0.x ] + live: [ 0.x ] + index: docs/index.asciidoc + tags: APM Android Agent/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-agent-android + path: docs + - + repo: apm-agent-android + path: CHANGELOG.asciidoc + - title: APM Go Agent + prefix: go + current: 2.x + branches: [ {main: master}, 2.x, 1.x, 0.5 ] + live: [ 2.x, 1.x ] + index: docs/index.asciidoc + tags: APM Go Agent/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-agent-go + path: docs + - + repo: apm-agent-go + path: CHANGELOG.asciidoc + exclude_branches: [ 0.5 ] + - title: APM iOS Agent + prefix: swift + current: 1.x + branches: [ main, 1.x, 0.x ] + live: [ 1.x ] + index: docs/index.asciidoc + tags: APM iOS Agent/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-agent-ios + path: docs + - + repo: apm-agent-ios + path: CHANGELOG.asciidoc + - title: APM Java Agent + prefix: java + current: 1.x + branches: [ {main: master}, 1.x, 0.7, 0.6 ] + live: [ 1.x ] + index: docs/index.asciidoc + tags: APM Java Agent/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-agent-java + path: docs + - + repo: apm-agent-java + path: CHANGELOG.asciidoc + exclude_branches: [ 0.7, 0.6] + - + repo: apm-aws-lambda + path: docs + exclude_branches: [ 0.7, 0.6 ] + map_branches: + 1.x: main + - title: APM .NET Agent + prefix: dotnet + current: 1.x + branches: [ {main: master}, 1.x, 1.8 ] + live: [ 1.x ] + index: docs/index.asciidoc + tags: APM .NET Agent/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-agent-dotnet + path: docs + - + repo: apm-agent-dotnet + path: CHANGELOG.asciidoc + - title: APM Node.js Agent + prefix: nodejs + current: 4.x + branches: [ {main: master}, 4.x, 3.x, 2.x, 1.x ] + live: [ 4.x ] + index: docs/index.asciidoc + tags: APM Node.js Agent/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-agent-nodejs + path: docs + - + repo: apm-agent-nodejs + path: CHANGELOG.asciidoc + exclude_branches: [ 1.x, 0.x ] + - + repo: apm-aws-lambda + path: docs + exclude_branches: [ 2.x, 1.x, 0.x ] + map_branches: + 3.x: main + 4.x: main + - title: APM PHP Agent + prefix: php + current: 1.x + branches: [ {main: master}, 1.x ] + live: [ 1.x ] + index: docs/index.asciidoc + tags: APM PHP Agent/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-agent-php + path: docs + - + repo: apm-agent-php + path: CHANGELOG.asciidoc + - title: APM Python Agent + prefix: python + current: 6.x + branches: [ {main: master}, 6.x, 5.x, 4.x, 3.x, 2.x, 1.x ] + live: [ 6.x, 5.x ] + index: docs/index.asciidoc + tags: APM Python Agent/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-agent-python + path: docs + - + repo: apm-agent-python + path: CHANGELOG.asciidoc + exclude_branches: [ 4.x, 3.x, 2.x, 1.x ] + - + repo: apm-aws-lambda + path: docs + exclude_branches: [ 5.x, 4.x, 3.x, 2.x, 1.x ] + map_branches: + 6.x: main + - title: APM Ruby Agent + prefix: ruby + current: 4.x + branches: [ {main: master}, 4.x, 3.x, 2.x, 1.x ] + live: [ 4.x ] + index: docs/index.asciidoc + tags: APM Ruby Agent/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-agent-ruby + path: docs + - + repo: apm-agent-ruby + path: CHANGELOG.asciidoc + exclude_branches: [ 1.x, 0.x ] + - title: APM Real User Monitoring JavaScript Agent + prefix: rum-js + current: 5.x + branches: [ {main: master}, 5.x, 4.x, 3.x, 2.x, 1.x, 0.x ] + live: [ 5.x, 4.x] + index: docs/index.asciidoc + tags: APM Real User Monitoring JavaScript Agent/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-agent-rum-js + path: docs + - + repo: apm-agent-rum-js + path: CHANGELOG.asciidoc + exclude_branches: [ 3.x, 2.x, 1.x, 0.x ] + - title: APM AWS Lambda Extension + prefix: lambda + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/index.asciidoc + tags: APM AWS Lambda extension/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-aws-lambda + path: docs + - + repo: apm-aws-lambda + path: CHANGELOG.asciidoc + - title: APM Attacher + prefix: attacher + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/index.asciidoc + tags: APM Attacher/Reference + subject: APM + chunk: 1 + sources: + - + repo: apm-k8s-attacher + path: docs + - title: ECS logging + base_dir: en/ecs-logging + sections: + - title: ECS Logging Overview + prefix: overview + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/index.asciidoc + chunk: 1 + tags: ECS-logging/Guide + subject: ECS Logging Overview + sources: + - + repo: ecs-logging + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - title: ECS Logging Go (Logrus) Reference + prefix: go-logrus + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/index.asciidoc + chunk: 1 + tags: ECS-logging/go-logrus/Guide + subject: ECS Logging Go (Logrus) Reference + sources: + - + repo: ecs-logging-go-logrus + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: ecs-logging + path: docs + - title: ECS Logging Go (Zap) Reference + prefix: go-zap + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/index.asciidoc + chunk: 1 + tags: ECS-logging/go-zap/Guide + subject: ECS Logging Go (Zap) Reference + sources: + - + repo: ecs-logging-go-zap + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: ecs-logging + path: docs + - title: ECS Logging Go (zerolog) Reference + prefix: go-zerolog + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/index.asciidoc + chunk: 1 + tags: ECS-logging/go-zerolog/Guide + subject: ECS Logging Go (zerolog) Reference + sources: + - + repo: ecs-logging-go-zerolog + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: ecs-logging + path: docs + - title: ECS Logging Java Reference + prefix: java + current: 1.x + branches: [ {main: master}, 1.x, 0.x ] + live: [ 1.x ] + index: docs/index.asciidoc + chunk: 1 + tags: ECS-logging/java/Guide + subject: ECS Logging Java Reference + sources: + - + repo: ecs-logging-java + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: ecs-logging + path: docs + map_branches: + 1.x: main + 0.x: main + - title: ECS Logging .NET Reference + prefix: dotnet + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/index.asciidoc + chunk: 1 + tags: ECS-logging/.NET/Guide + subject: ECS Logging .NET Reference + sources: + - + repo: ecs-dotnet + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: ecs-logging + path: docs + - title: ECS Logging Node.js Reference + prefix: nodejs + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/index.asciidoc + chunk: 1 + tags: ECS-logging/nodejs/Guide + subject: ECS Logging Node.js Reference + sources: + - + repo: ecs-logging-nodejs + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: ecs-logging + path: docs + - title: ECS Logging Ruby Reference + prefix: ruby + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/index.asciidoc + chunk: 1 + tags: ECS-logging/ruby/Guide + subject: ECS Logging Ruby Reference + sources: + - + repo: ecs-logging-ruby + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: ecs-logging + path: docs + - title: ECS Logging PHP Reference + prefix: php + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/index.asciidoc + chunk: 1 + tags: ECS-logging/php/Guide + subject: ECS Logging PHP Reference + sources: + - + repo: ecs-logging-php + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: ecs-logging + path: docs + - title: ECS Logging Python Reference + prefix: python + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/index.asciidoc + chunk: 1 + tags: ECS-logging/python/Guide + subject: ECS Logging Python Reference + sources: + - + repo: ecs-logging-python + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: ecs-logging + path: docs + - title: Security + sections: + - title: Elastic Security + prefix: en/security + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8 ] + live: *stacklive + index: docs/index.asciidoc + chunk: 1 + tags: Security/Guide + subject: Security + sources: + - + repo: security-docs + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: stack-docs + path: docs/en + - title: Elastic Stack + sections: + - title: "Starting with the Elasticsearch Platform and its Solutions" + prefix: en/starting-with-the-elasticsearch-platform-and-its-solutions + current: *stackcurrent + index: welcome-to-elastic/index.asciidoc + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 7.17 ] + live: [ *stackcurrent ] + chunk: 1 + tags: Elastic/Starting with the Elasticsearch Platform and its Solutions + subject: Starting with the Elasticsearch Platform and its Solutions + sources: + - + repo: tech-content + path: welcome-to-elastic + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: Curator Index Management + prefix: en/elasticsearch/client/curator + current: 8.0 + branches: [ 8.0, 7.0, 6.0, 5.8, 5.7, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.3, 4.2, 4.1, 4.0, 3.5, 3.4, 3.3 ] + index: docs/asciidoc/index.asciidoc + tags: Clients/Curator + subject: Clients + sources: + - + repo: curator + path: docs/asciidoc + - title: Elastic Common Schema (ECS) Reference + prefix: en/ecs + # Please do not update current to 8.17 + current: 8.16 + branches: [ {main: master}, 8.16, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 1.12, 1.11, 1.10, 1.9, 1.8, 1.7, 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0 ] + live: [ 8.16, 1.12 ] + index: docs/index.asciidoc + chunk: 2 + tags: Elastic Common Schema (ECS)/Reference + subject: Elastic Common Schema (ECS) + sources: + - + repo: ecs + path: docs/ + - title: Elasticsearch Clients + base_dir: en/elasticsearch/client + toc_extra: extra/client_docs_landing.html + sections: + - title: Java Client + prefix: java-api-client + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] + live: *stacklive + index: docs/index.asciidoc + chunk: 1 + tags: Clients/Java + subject: Clients + sources: + - + repo: elasticsearch-java + path: docs/ + - + repo: elasticsearch-java + path: java-client/src/test/java/co/elastic/clients/documentation + - + repo: elasticsearch + path: docs/java-rest/ + - + repo: elasticsearch + path: client + - title: JavaScript Client + prefix: javascript-api + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 6.x, 5.x ] + live: *stacklive + index: docs/index.asciidoc + chunk: 1 + tags: Clients/JavaScript + subject: Clients + sources: + - + repo: elasticsearch-js + path: docs/ + - title: Ruby Client + prefix: ruby-api + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] + live: *stacklive + index: docs/index.asciidoc + chunk: 1 + tags: Clients/Ruby + subject: Clients + sources: + - + repo: elasticsearch-ruby + path: docs/ + - title: Go Client + prefix: go-api + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] + live: *stacklive + index: .doc/index.asciidoc + chunk: 1 + tags: Clients/Go + subject: Clients + sources: + - + repo: go-elasticsearch + path: .doc/ + - title: .NET Clients + prefix: net-api + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 6.x, 5.x, 2.x, 1.x ] + live: *stacklive + index: docs/index.asciidoc + tags: Clients/.Net + subject: Clients + chunk: 1 + sources: + - + repo: elasticsearch-net + path: docs/ + - + repo: elasticsearch-net + path: tests/Tests/Documentation + - title: PHP Client + prefix: php-api + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.x, 6.x, 5.x, 2.x, 1.x, 0.4 ] + live: *stacklive + index: docs/index.asciidoc + chunk: 1 + tags: Clients/PHP + subject: Clients + sources: + - + repo: elasticsearch-php + path: docs/ + - + repo: docs + path: shared/attributes.asciidoc + - title: Perl Client + prefix: perl-api + current: master + branches: [ master, 8.x, 7.x ] + live: [ master, 8.x, 7.x ] + index: docs/index.asciidoc + chunk: 1 + tags: Clients/Perl + subject: Clients + sources: + - + repo: elasticsearch-perl + path: docs/ + - title: Python Client + prefix: python-api + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] + live: *stacklive + index: docs/guide/index.asciidoc + chunk: 1 + tags: Clients/Python + subject: Clients + sources: + - + repo: elasticsearch-py + path: docs/guide/ + - title: eland + prefix: eland + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/guide/index.asciidoc + chunk: 1 + tags: Clients/eland + subject: Clients + sources: + - + repo: eland + path: docs/guide + - title: Rust Client + prefix: rust-api + current: main + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] + live: [ main, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] + index: docs/index.asciidoc + chunk: 1 + tags: Clients/Rust + subject: Clients + sources: + - + repo: elasticsearch-rs + path: docs/ + - title: Java REST Client (deprecated) + prefix: java-rest + current: 7.17 + branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + live: [ 7.17, 6.8 ] + index: docs/java-rest/index.asciidoc + tags: Clients/JavaREST + subject: Clients + chunk: 1 + sources: + - + repo: elasticsearch + path: docs/java-rest + - + repo: elasticsearch + path: docs/Versions.asciidoc + - + repo: elasticsearch + path: client + exclude_branches: [ 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - title: Java Transport Client (deprecated) + prefix: java-api + current: 7.17 + branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + live: [7.17, 6.8] + index: docs/java-api/index.asciidoc + tags: Clients/Java + subject: Clients + chunk: 1 + sources: + - + repo: elasticsearch + path: docs/java-api + - + repo: elasticsearch + path: docs/Versions.asciidoc + exclude_branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: client/rest-high-level/src/test/java/org/elasticsearch/client + exclude_branches: [ 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + + - + repo: elasticsearch + path: server/src/internalClusterTest/java/org/elasticsearch/client/documentation + exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: server/src/test/java/org/elasticsearch/client/documentation + exclude_branches: [ 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: modules/reindex/src/internalClusterTest/java/org/elasticsearch/client/documentation + exclude_branches: [ 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: modules/reindex/src/test/java/org/elasticsearch/client/documentation + exclude_branches: [ 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + + - title: Community Contributed Clients + prefix: community + branches: [{main: master}] + current: main + index: docs/community-clients/index.asciidoc + single: 1 + tags: Clients/Community + subject: Clients + sources: + - + repo: elasticsearch + path: docs/community-clients + - title: Elasticsearch for Apache Hadoop and Spark + prefix: en/elasticsearch/hadoop + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0 ] + live: *stacklive + index: docs/src/reference/asciidoc/index.adoc + tags: Elasticsearch/Apache Hadoop + subject: Elasticsearch + sources: + - + repo: elasticsearch-hadoop + path: docs/src/reference/asciidoc + - title: Elasticsearch Relevance Engine (ESRE) + prefix: en/esre + index: esre-docs/index.asciidoc + private: 1 + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8 ] + live: [ 8.10 ] + chunk: 1 + tags: ESRE/Guide + subject: ESRE + sources: + - + repo: enterprise-search-pubs + path: esre-docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - title: Glossary + prefix: en/elastic-stack-glossary + current: main + index: docs/en/glossary/index.asciidoc + branches: [ {main: master} ] + tags: Elastic Stack/Glossary + subject: Elastic Stack + sources: + - + repo: stack-docs + path: docs/en + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - title: Installation and Upgrade Guide + prefix: en/elastic-stack + current: *stackcurrent + index: docs/en/install-upgrade/index.asciidoc + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + live: *stacklive + chunk: 1 + tags: Elastic Stack/Installation and Upgrade + subject: Elastic Stack + sources: + - + repo: stack-docs + path: docs/en + - + repo: apm-server + path: changelogs + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.5, 8.4, 8.3, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: apm-server + path: docs/ + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: beats + path: libbeat/docs + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: elasticsearch + path: docs/ + - + repo: elasticsearch-hadoop + path: docs/src/reference/asciidoc + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: security-docs + path: docs/ + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: kibana + path: docs/ + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: logstash + path: docs/ + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: observability-docs + path: docs/en/observability + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + map_branches: *mapMainToMaster + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: docs + path: shared/attributes62.asciidoc + exclude_branches: [ 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - title: Kibana Guide + prefix: en/kibana + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] + live: *stacklive + index: docs/index.x.asciidoc + chunk: 1 + tags: Kibana/Reference + subject: Kibana + toc_extra: extra/kibana_landing.html + sources: + - + repo: kibana + path: docs/ + - + repo: x-pack-kibana + prefix: kibana-extra/x-pack-kibana + path: docs/en + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: [ 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] + - + repo: docs + path: shared/attributes62.asciidoc + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] + - + repo: docs + path: shared/legacy-attrs.asciidoc + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 3.0 ] + - + repo: kibana + # git-archive requires `:(glob)` for ** to match no directory (in order to include `examples/README.asciidoc`) + path: ":(glob)examples/**/*.asciidoc" + exclude_branches: [ 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] + - + repo: kibana + path: ":(glob)src/**/*.asciidoc" + exclude_branches: [ 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] + - + repo: kibana + path: ":(glob)x-pack/**/*.asciidoc" + exclude_branches: [ 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] + - title: Machine Learning + prefix: en/machine-learning + current: *stackcurrent + index: docs/en/stack/ml/index.asciidoc + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3 ] + live: *stacklive + chunk: 1 + tags: Elastic Stack/Machine Learning + subject: Machine Learning + sources: + - + repo: stack-docs + path: docs/en/stack + - + repo: elasticsearch + path: docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: docs + path: shared/settings.asciidoc + - title: Painless Scripting Language + prefix: en/elasticsearch/painless + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5] + live: *stacklive + index: docs/painless/index.asciidoc + chunk: 1 + tags: Elasticsearch/Painless + subject: Elasticsearch + sources: + - + repo: elasticsearch + path: docs/painless + - + repo: elasticsearch + path: docs/Versions.asciidoc + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - title: Plugins and Integrations + prefix: en/elasticsearch/plugins + repo: elasticsearch + current: *stackcurrent + index: docs/plugins/index.asciidoc + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7 ] + live: *stacklive + chunk: 2 + tags: Elasticsearch/Plugins + subject: Elasticsearch + sources: + - + repo: elasticsearch + path: docs/plugins + - + repo: elasticsearch + path: docs/Versions.asciidoc + exclude_branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: buildSrc/src/main/resources/ + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: build-tools-internal/src/main/resources/ + exclude_branches: [7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: elasticsearch + path: build-tools/src/main/resources/ + exclude_branches: [ 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - title: Reference Architectures + prefix: en/reference-architectures + current: main + index: docs/en/reference-architectures/index.asciidoc + branches: [ {main: master} ] + tags: Reference Architectures + subject: Reference Architectures + sources: + - + repo: stack-docs + path: docs/en + - + repo: docs + path: shared/attributes.asciidoc + - title: "Ingest: Add your data" + sections: + - title: Elastic Ingest Reference Architectures + prefix: en/ingest + current: *stackcurrent + index: docs/en/ingest-arch/index.asciidoc + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9 ] + live: [ *stackcurrent ] + chunk: 1 + tags: Ingest/Reference + subject: Ingest + sources: + - + repo: ingest-docs + path: docs/en + - + repo: docs + path: shared/attributes.asciidoc + - title: Fleet and Elastic Agent Guide + prefix: en/fleet + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8 ] + live: *stacklive + index: docs/en/ingest-management/index.asciidoc + chunk: 2 + tags: Fleet/Guide/Elastic Agent + subject: Fleet and Elastic Agent + sources: + - + repo: ingest-docs + path: docs/en + - + repo: observability-docs + path: docs/en + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + # Required only for versions 7.12-7.15 + repo: apm-server + path: docs + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - title: Logstash Reference + prefix: en/logstash + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.5 ] + live: *stacklive + index: docs/index.x.asciidoc + chunk: 1 + tags: Logstash/Reference + subject: Logstash + respect_edit_url_overrides: true + sources: + - + repo: logstash + path: docs/ + - + repo: x-pack-logstash + prefix: logstash-extra/x-pack-logstash + path: docs/en + private: true + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.5 ] + - + repo: logstash-docs + path: docs/ + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: [ 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.5 ] + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.5 ] + - + repo: docs + path: shared/attributes62.asciidoc + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.5 ] + - + repo: docs + path: shared/legacy-attrs.asciidoc + exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0] + - title: Logstash Versioned Plugin Reference + prefix: en/logstash-versioned-plugins + current: versioned_plugin_docs + branches: [ versioned_plugin_docs ] + index: docs/versioned-plugins/index.asciidoc + private: 1 + chunk: 1 + noindex: 1 + tags: Logstash/Plugin Reference + subject: Logstash + sources: + - + repo: logstash-docs + path: docs/versioned-plugins + - + repo: docs + path: shared/attributes.asciidoc + - title: Elastic Logging Plugin for Docker + prefix: en/beats/loggingplugin + current: *stackcurrent + index: x-pack/dockerlogbeat/docs/index.asciidoc + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6 ] + chunk: 1 + tags: Elastic Logging Plugin/Reference + respect_edit_url_overrides: true + subject: Elastic Logging Plugin + sources: + - + repo: beats + path: x-pack/dockerlogbeat/docs + - + repo: beats + path: libbeat/docs + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - title: Elastic Serverless Forwarder Guide + prefix: en/esf + index: docs/en/index.asciidoc + current: main + branches: [ {main: master} ] + live: [ main ] + chunk: 2 + tags: Cloud Native Ingest/Reference + subject: cloud native ingest + sources: + - + repo: esf + path: docs/en + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - title: Integrations Developer Guide + prefix: en/integrations-developer + current: main + branches: [ {main: master} ] + live: [ main ] + index: docs/en/integrations/index.asciidoc + chunk: 1 + tags: Integrations/Developer + subject: Integrations + sources: + - + repo: observability-docs + path: docs/en + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: package-spec + path: versions + - + repo: package-spec + path: spec + - title: Auditbeat Reference + prefix: en/beats/auditbeat + index: auditbeat/docs/index.asciidoc + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0 ] + live: *stacklive + chunk: 1 + tags: Auditbeat/Reference + respect_edit_url_overrides: true + subject: Auditbeat + sources: + - + repo: beats + path: auditbeat + - + repo: beats + path: auditbeat/docs + - + repo: beats + path: x-pack/auditbeat + exclude_branches: [ 6.5, 6.4, 6.3, 6.2, 6.1, 6.0 ] + - + repo: beats + path: auditbeat/module + - + repo: beats + path: auditbeat/scripts + - + repo: beats + path: CHANGELOG.asciidoc + - + repo: beats + path: libbeat/docs + - + repo: beats + path: libbeat/processors/*/docs/* + exclude_branches: *beatsProcessorExclude + - + repo: beats + path: x-pack/libbeat/processors/*/docs/* + exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + - + repo: beats + path: x-pack/auditbeat/processors/*/docs/* + exclude_branches: [ 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + - + repo: beats + path: libbeat/outputs/*/docs/* + exclude_branches: *beatsOutputExclude + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: *beatsSharedExclude + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: *beatsSharedExclude + - title: Beats Developer Guide + prefix: en/beats/devguide + index: docs/devguide/index.asciidoc + current: main + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0 ] + live: *stacklive + chunk: 1 + tags: Devguide/Reference + subject: Beats + respect_edit_url_overrides: true + sources: + - + repo: beats + path: docs + - + repo: beats + path: libbeat/docs + - + repo: beats + path: metricbeat/module + - + repo: beats + path: metricbeat/scripts + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: *beatsSharedExclude + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: *beatsSharedExclude + - title: Beats Platform Reference + prefix: en/beats/libbeat + index: libbeat/docs/index.asciidoc + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1] + live: *stacklive + chunk: 1 + tags: Libbeat/Reference + subject: libbeat + respect_edit_url_overrides: true + sources: + - + repo: beats + path: libbeat/docs + - + repo: beats + path: CHANGELOG.asciidoc + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: *beatsSharedExclude + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: *beatsSharedExclude + - title: Filebeat Reference + prefix: en/beats/filebeat + index: filebeat/docs/index.asciidoc + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1] + live: *stacklive + chunk: 1 + tags: Filebeat/Reference + respect_edit_url_overrides: true + subject: Filebeat + sources: + - + repo: beats + path: filebeat + - + repo: beats + path: filebeat/docs + - + repo: beats + path: x-pack/filebeat/docs + exclude_branches: [ 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + - + repo: beats + path: x-pack/libbeat/docs + exclude_branches: *beatsXpackLibbeatExclude + - + repo: beats + path: CHANGELOG.asciidoc + - + repo: beats + path: libbeat/docs + - + repo: beats + path: libbeat/processors/*/docs/* + exclude_branches: *beatsProcessorExclude + - + repo: beats + path: x-pack/filebeat/processors/*/docs/* + exclude_branches: *beatsProcessorExclude + - + repo: beats + path: x-pack/libbeat/processors/*/docs/* + exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + - + repo: beats + path: libbeat/outputs/*/docs/* + exclude_branches: *beatsOutputExclude + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: *beatsSharedExclude + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: *beatsSharedExclude + - title: Heartbeat Reference + prefix: en/beats/heartbeat + current: *stackcurrent + index: heartbeat/docs/index.asciidoc + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2 ] + live: *stacklive + chunk: 1 + tags: Heartbeat/Reference + respect_edit_url_overrides: true + subject: Heartbeat + sources: + - + repo: beats + path: heartbeat + - + repo: beats + path: heartbeat/docs + - + repo: beats + path: CHANGELOG.asciidoc + - + repo: beats + path: libbeat/docs + - + repo: beats + path: x-pack/libbeat/docs + exclude_branches: *beatsXpackLibbeatExclude + - + repo: beats + path: libbeat/processors/*/docs/* + exclude_branches: *beatsProcessorExclude + - + repo: beats + path: x-pack/libbeat/processors/*/docs/* + exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + - + repo: beats + path: libbeat/outputs/*/docs/* + exclude_branches: *beatsOutputExclude + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: *beatsSharedExclude + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: *beatsSharedExclude + - title: Metricbeat Reference + prefix: en/beats/metricbeat + index: metricbeat/docs/index.asciidoc + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + live: *stacklive + chunk: 1 + tags: Metricbeat/Reference + respect_edit_url_overrides: true + subject: Metricbeat + sources: + - + repo: beats + path: metricbeat + - + repo: beats + path: metricbeat/docs + - + repo: beats + path: metricbeat/module + - + repo: beats + path: x-pack/libbeat/docs + exclude_branches: *beatsXpackLibbeatExclude + - + repo: beats + path: x-pack/metricbeat/module + exclude_branches: [ 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + - + repo: beats + path: metricbeat/scripts + - + repo: beats + path: CHANGELOG.asciidoc + - + repo: beats + path: libbeat/docs + - + repo: beats + path: libbeat/processors/*/docs/* + exclude_branches: *beatsProcessorExclude + - + repo: beats + path: x-pack/libbeat/processors/*/docs/* + exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + - + repo: beats + path: libbeat/outputs/*/docs/* + exclude_branches: *beatsOutputExclude + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: *beatsSharedExclude + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: *beatsSharedExclude + - title: Packetbeat Reference + prefix: en/beats/packetbeat + index: packetbeat/docs/index.asciidoc + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1] + live: *stacklive + chunk: 1 + tags: Packetbeat/Reference + respect_edit_url_overrides: true + subject: Packetbeat + sources: + - + repo: beats + path: packetbeat + - + repo: beats + path: packetbeat/docs + - + repo: beats + path: CHANGELOG.asciidoc + - + repo: beats + path: libbeat/docs + - + repo: beats + path: libbeat/processors/*/docs/* + exclude_branches: *beatsProcessorExclude + - + repo: beats + path: x-pack/libbeat/processors/*/docs/* + exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + - + repo: beats + path: libbeat/outputs/*/docs/* + exclude_branches: *beatsOutputExclude + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: *beatsSharedExclude + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: *beatsSharedExclude + - title: Winlogbeat Reference + prefix: en/beats/winlogbeat + index: winlogbeat/docs/index.asciidoc + current: *stackcurrent + branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1 ] + live: *stacklive + chunk: 1 + tags: Winlogbeat/Reference + respect_edit_url_overrides: true + subject: Winlogbeat + sources: + - + repo: beats + path: winlogbeat + - + repo: beats + path: winlogbeat/docs + - + repo: beats + path: CHANGELOG.asciidoc + - + repo: beats + path: libbeat/docs + - + repo: beats + path: libbeat/processors/*/docs/* + exclude_branches: *beatsProcessorExclude + - + repo: beats + path: x-pack/libbeat/processors/*/docs/* + exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + - + repo: beats + path: libbeat/outputs/*/docs/* + exclude_branches: *beatsOutputExclude + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: *beatsSharedExclude + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: *beatsSharedExclude + + - title: "Cloud: Provision, Manage, and Monitor the Elastic Stack" + sections: + - title: Elastic Cloud, Hosted Elastic Stack + prefix: en/cloud + tags: Cloud/Reference + subject: Elastic Cloud + current: *cloudSaasCurrent + branches: [ { *cloudSaasCurrent : latest} ] + index: docs/saas/index.asciidoc + chunk: 1 + private: 1 + sources: + - + repo: cloud + path: docs/saas + - + repo: cloud + path: docs/shared + - title: Elasticsearch Add-On for Heroku - Hosted Elasticsearch and Kibana for Heroku Users + prefix: en/cloud-heroku + tags: Cloud-Heroku/Reference + subject: Elasticsearch Add-On for Heroku + current: *cloudSaasCurrent + branches: [ { *cloudSaasCurrent : latest} ] + index: docs/heroku/index.asciidoc + chunk: 1 + noindex: 1 + private: 1 + sources: + - + repo: cloud + path: docs/saas + - + repo: cloud + path: docs/shared + - + repo: cloud + path: docs/heroku + - title: Elastic Cloud Enterprise - Elastic Cloud on your Infrastructure + prefix: en/cloud-enterprise + tags: CloudEnterprise/Reference + subject: ECE + current: ms-105 + live: + - ms-105 + - ms-92 + - ms-81 + - ms-78 + - ms-75 + - ms-72 + - ms-70 + - ms-69 + branches: + - ms-105: 3.7 + - ms-92: 3.6 + - ms-81: 3.5 + - ms-78: 3.4 + - ms-75: 3.3 + - ms-72: 3.2 + - ms-70: 3.1 + - ms-69: 3.0 + - ms-65: 2.13 + - ms-62: 2.12 + - ms-59: 2.11 + - ms-57: 2.10 + - ms-53: 2.9 + - ms-49: 2.8 + - ms-47: 2.7 + - release-ms-41: 2.6 + - 2.5 + - 2.4 + - 2.3 + - 2.2 + - 2.1 + - 2.0 + - 1.1 + - 1.0 + index: docs/cloud-enterprise/index.asciidoc + chunk: 2 + private: 1 + sources: + - + repo: cloud + # Grab the entire docs/ directory to get `ece-version.asciidoc` + path: docs + - + repo: cloud + path: docs/shared + exclude_branches: [ 1.0 ] + - + repo: docs + path: shared/versions/ece/{version}.asciidoc + - + repo: cloud-assets + path: docs + map_branches: + ms-105: master + ms-92: master + ms-81: master + ms-78: master + ms-75: master + ms-72: master + ms-70: master + ms-69: master + ms-65: master + ms-62: master + ms-59: master + ms-57: master + ms-53: master + ms-49: master + ms-47: master + release-ms-41: master + 2.5: master + 2.4: master + 2.3: master + 2.2: master + 2.1: master + 2.0: master + 1.1: master + 1.0: master + - + alternatives: { source_lang: console, alternative_lang: php } + repo: clients-team + path: docs/examples/elastic-cloud/php + map_branches: *mapCloudEceToClientsTeam + - + alternatives: { source_lang: console, alternative_lang: go } + repo: clients-team + path: docs/examples/elastic-cloud/go + map_branches: *mapCloudEceToClientsTeam + - + alternatives: { source_lang: console, alternative_lang: ruby } + repo: clients-team + path: docs/examples/elastic-cloud/ruby + map_branches: *mapCloudEceToClientsTeam + - + alternatives: { source_lang: console, alternative_lang: java } + repo: clients-team + path: docs/examples/elastic-cloud/java + map_branches: *mapCloudEceToClientsTeam + - + alternatives: { source_lang: console, alternative_lang: javascript } + repo: clients-team + path: docs/examples/elastic-cloud/javascript + map_branches: *mapCloudEceToClientsTeam + - + alternatives: { source_lang: console, alternative_lang: python } + repo: clients-team + path: docs/examples/elastic-cloud/python + map_branches: *mapCloudEceToClientsTeam + - + alternatives: { source_lang: console, alternative_lang: csharp } + repo: clients-team + path: docs/examples/elastic-cloud/csharp + map_branches: *mapCloudEceToClientsTeam + - title: Elastic Cloud on Kubernetes + prefix: en/cloud-on-k8s + tags: Kubernetes/Reference + subject: ECK + current: 2.16 + branches: [ {main: master}, 2.16, 2.15, 2.14, 2.13, 2.12, 2.11, 2.10, 2.9, 2.8, 2.7, 2.6, 2.5, 2.4, 2.3, 2.2, 2.1, 2.0, 1.9, 1.8, 1.7, 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0, 1.0-beta, 0.9, 0.8 ] + index: docs/index.asciidoc + chunk: 1 + sources: + - + repo: cloud-on-k8s + path: docs/ + - + repo: docs + path: shared/versions/stack/current.asciidoc + exclude_branches: [ 0.9, 0.8 ] + - + repo: docs + path: shared/attributes.asciidoc + - title: Elastic Cloud Control - The Command-Line Interface for Elasticsearch Service and ECE + prefix: en/ecctl + tags: CloudControl/Reference + subject: ECCTL + current: 1.14 + branches: [ master, 1.14, 1.13, 1.12, 1.11, 1.10, 1.9, 1.8, 1.7, 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0 ] + index: docs/index.asciidoc + chunk: 1 + sources: + - + repo: ecctl + path: docs/ + - title: Elastic Cloud Terraform Provider + prefix: en/tpec + tags: CloudTerraform/Reference + subject: TPEC + current: master + branches: [ master ] + index: docs-elastic/index.asciidoc + single: 1 + chunk: 1 + sources: + - + repo: terraform-provider-ec + path: docs-elastic/ + + - title: Legacy Documentation + sections: + - title: Elastic Stack and Google Cloud's Anthos + noindex: 1 + prefix: en/elastic-stack-gke + current: main + index: docs/en/gke-on-prem/index.asciidoc + branches: [ {main: master} ] + private: 1 + chunk: 1 + tags: Elastic Stack/Google + subject: Elastic Stack + sources: + - + repo: stack-docs + path: docs/en/gke-on-prem + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + + - title: Elasticsearch - The Definitive Guide + noindex: 1 + prefix: en/elasticsearch/guide + current: 2.x + branches: [ master, 2.x, 1.x ] + index: book.asciidoc + chunk: 1 + private: 1 + tags: Legacy/Elasticsearch/Definitive Guide + subject: Elasticsearch + suppress_migration_warnings: true + sources: + - + repo: guide + path: / + - + repo: docs + path: shared/legacy-attrs.asciidoc + exclude_branches: [ master, 2.x] + + - title: Elasticsearch Resiliency Status + noindex: 1 + prefix: en/elasticsearch/resiliency + toc: 1 + branches: [{main: master}] + current: main + index: docs/resiliency/index.asciidoc + single: 1 + tags: Elasticsearch/Resiliency Status + subject: Elasticsearch + sources: + - + repo: elasticsearch + path: docs/resiliency + - + repo: elasticsearch + path: docs/Versions.asciidoc + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + - + repo: docs + path: shared/attributes.asciidoc + exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + + - title: Elasticsearch.js for 5.6-7.6 + noindex: 1 + prefix: en/elasticsearch/client/elasticsearch-js + current: 16.x + branches: [ 16.x ] + index: docs/index.asciidoc + chunk: 1 + private: 1 + tags: Legacy/Clients/Elasticsearch-js + subject: Clients + sources: + - + repo: elasticsearch-js-legacy + path: docs + + - title: Functionbeat Reference + noindex: 1 + prefix: en/beats/functionbeat + current: 8.15 + index: x-pack/functionbeat/docs/index.asciidoc + branches: [ 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5 ] + chunk: 1 + tags: Functionbeat/Reference + respect_edit_url_overrides: true + subject: Functionbeat + sources: + - + repo: beats + path: x-pack/functionbeat + - + repo: beats + path: x-pack/functionbeat/docs + - + repo: beats + path: CHANGELOG.asciidoc + - + repo: beats + path: libbeat/docs + - + repo: beats + path: libbeat/processors/*/docs/* + exclude_branches: *beatsProcessorExclude + - + repo: beats + path: x-pack/libbeat/processors/*/docs/* + exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + - + repo: beats + path: libbeat/outputs/*/docs/* + exclude_branches: *beatsOutputExclude + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: beats + path: x-pack/libbeat/docs + exclude_branches: *beatsXpackLibbeatExclude + - + repo: beats + path: filebeat/docs + exclude_branches: [ 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2 ] + + - title: Getting Started + noindex: 1 + prefix: en/elastic-stack-get-started + current: 8.2 + index: docs/en/getting-started/index.asciidoc + branches: [ 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3 ] + chunk: 1 + tags: Elastic Stack/Getting started + subject: Elastic Stack + sources: + - + repo: stack-docs + path: docs/en + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: elasticsearch + path: docs/ + exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3 ] + + - title: Graph Reference for 2.x + noindex: 1 + prefix: en/graph + repo: x-pack + chunk: 1 + private: 1 + tags: Legacy/Graph/Reference + subject: Graph + current: 2.4 + index: docs/public/graph/index.asciidoc + branches: [ 2.4, 2.3 ] + sources: + - + repo: x-pack + path: docs/public/graph + - + repo: docs + path: shared/legacy-attrs.asciidoc + + - title: Groovy API + noindex: 1 + prefix: en/elasticsearch/client/groovy-api + current: 2.4 + branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + index: docs/groovy-api/index.asciidoc + private: 1 + tags: Legacy/Clients/Groovy + subject: Clients + sources: + - + repo: elasticsearch + path: docs/groovy-api + - + repo: elasticsearch + path: docs/Versions.asciidoc + exclude_branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + + - title: Infrastructure Monitoring Guide for 6.5-7.4 + noindex: 1 + prefix: en/infrastructure/guide + current: 7.4 + branches: [ 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5 ] + index: docs/en/infraops/index.asciidoc + chunk: 1 + private: 1 + tags: Infrastructure/Guide + subject: Infrastructure + sources: + - + repo: stack-docs + path: docs/en + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + + - title: Journalbeat Reference for 6.5-7.15 + noindex: 1 + prefix: en/beats/journalbeat + current: 7.15 + index: journalbeat/docs/index.asciidoc + branches: [ 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5 ] + chunk: 1 + tags: Journalbeat/Reference + respect_edit_url_overrides: true + subject: Journalbeat + sources: + - + repo: beats + path: journalbeat + - + repo: beats + path: journalbeat/docs + - + repo: beats + path: CHANGELOG.asciidoc + - + repo: beats + path: libbeat/docs + - + repo: beats + path: libbeat/processors/*/docs/* + exclude_branches: *beatsProcessorExclude + - + repo: beats + path: x-pack/libbeat/processors/*/docs/* + exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] + - + repo: beats + path: libbeat/outputs/*/docs/* + exclude_branches: *beatsOutputExclude + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + + - title: Legacy APM Overview + noindex: 1 + prefix: get-started + index: docs/guide/index.asciidoc + current: 7.15 + branches: [ 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0 ] + chunk: 1 + tags: APM Server/Reference + subject: APM + sources: + - + repo: apm-server + path: docs/guide + - + repo: apm-server + path: docs + + - title: Legacy APM Server Reference + noindex: 1 + prefix: server + index: docs/index.asciidoc + current: 7.15 + branches: [ 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0 ] + chunk: 1 + tags: APM Server/Reference + subject: APM + sources: + - + repo: apm-server + path: changelogs + exclude_branches: [ 6.0 ] + - + repo: apm-server + path: docs + - + repo: apm-server + path: CHANGELOG.asciidoc + + - title: Logs Monitoring Guide for 7.5-7.9 + noindex: 1 + prefix: en/logs/guide + current: 7.9 + branches: [ 7.9, 7.8, 7.7, 7.6, 7.5 ] + index: docs/en/logs/index.asciidoc + chunk: 1 + private: 1 + tags: Logs/Guide + subject: Logs + sources: + - + repo: observability-docs + path: docs/en + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + + - title: Marvel Reference for 2.x and 1.x + noindex: 1 + prefix: en/marvel + chunk: 1 + private: 1 + tags: Legacy/Marvel/Reference + subject: Marvel + current: 2.4 + index: docs/public/marvel/index.asciidoc + branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, {marvel-1.3: 1.3}] + sources: + - + repo: x-pack + path: docs/public/marvel + - + repo: docs + path: shared/legacy-attrs.asciidoc + exclude_branches: [marvel-1.3] + + - title: Metrics Monitoring Guide for 7.5-7.9 + noindex: 1 + prefix: en/metrics/guide + current: 7.9 + branches: [ 7.9, 7.8, 7.7, 7.6, 7.5 ] + index: docs/en/metrics/index.asciidoc + chunk: 1 + private: 1 + tags: Metrics/Guide + subject: Metrics + sources: + - + repo: observability-docs + path: docs/en + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + + - title: Reporting Reference for 2.x + noindex: 1 + prefix: en/reporting + chunk: 1 + private: 1 + tags: Legacy/Reporting/Reference + subject: Reporting + current: 2.4 + index: docs/public/reporting/index.asciidoc + branches: [ 2.4 ] + sources: + - + repo: x-pack + path: docs/public/reporting + + - title: Sense Editor for 4.x + noindex: 1 + prefix: en/sense + current: master + branches: [ master ] + index: docs/index.asciidoc + private: 1 + tags: Legacy/Elasticsearch/Sense-Editor + subject: Sense + sources: + - + repo: sense + path: docs + + - title: Shield Reference for 2.x and 1.x + noindex: 1 + prefix: en/shield + chunk: 1 + private: 1 + tags: Legacy/Shield/Reference + subject: Shield + current: 2.4 + index: docs/public/shield/index.asciidoc + branches: [2.4, 2.3, 2.2, 2.1, 2.0, {shield-1.3: 1.3}, {shield-1.2: 1.2}, {shield-1.1: 1.1}, {shield-1.0: 1.0}] + sources: + - + repo: x-pack + path: docs/public/shield + - + repo: docs + path: shared/legacy-attrs.asciidoc + exclude_branches: [shield-1.2, shield-1.1 , shield-1.0] + + - title: SIEM Guide + noindex: 1 + prefix: en/siem/guide + current: 7.8 + branches: [ 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2 ] + index: docs/en/siem/index.asciidoc + chunk: 1 + tags: SIEM/Guide + subject: SIEM + sources: + - + repo: stack-docs + path: docs/en + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + + - title: Site Search Reference + noindex: 1 + prefix: en/swiftype/sitesearch + index: docs/sitesearch/index.asciidoc + private: 1 + current: master + branches: [ master ] + single: 1 + tags: Site Search/Reference + subject: Swiftype + sources: + - + repo: swiftype + path: docs + + - title: Topbeat Reference + noindex: 1 + prefix: en/beats/topbeat + index: topbeat/docs/index.asciidoc + current: 1.3 + branches: [ 1.3, 1.2, 1.1, 1.0.1 ] + chunk: 1 + tags: Legacy/Topbeat/Reference + respect_edit_url_overrides: true + subject: Topbeat + sources: + - + repo: beats + path: topbeat/docs + - + repo: beats + path: CHANGELOG.asciidoc + - + repo: beats + path: libbeat/docs + + - title: Uptime Monitoring Guide for 7.2-7.9 + noindex: 1 + prefix: en/uptime + current: 7.9 + branches: [ 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2 ] + index: docs/en/uptime/index.asciidoc + chunk: 1 + private: 1 + tags: Uptime/Guide + subject: Uptime + sources: + - + repo: observability-docs + path: docs/en + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + + - title: Stack Overview + noindex: 1 + prefix: en/elastic-stack-overview + current: 7.4 + index: docs/en/stack/index.asciidoc + branches: [ 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3 ] + chunk: 1 + tags: Legacy/Elastic Stack/Overview + subject: Elastic Stack + sources: + - + repo: stack-docs + path: docs/en/stack + - + repo: docs + path: shared/versions/stack/{version}.asciidoc + - + repo: docs + path: shared/attributes.asciidoc + - + repo: docs + path: shared/settings.asciidoc + + - title: Watcher Reference for 2.x and 1.x + noindex: 1 + prefix: en/watcher + chunk: 1 + private: 1 + tags: Legacy/Watcher/Reference + subject: Watcher + current: 2.4 + index: docs/public/watcher/index.asciidoc + branches: [2.4, 2.3, 2.2, 2.1, 2.0, {watcher-1.0: 1.0}] + sources: + - + repo: x-pack + path: docs/public/watcher + - + repo: docs + path: shared/legacy-attrs.asciidoc + + - title: X-Pack Reference for 6.0-6.2 and 5.x + noindex: 1 + prefix: en/x-pack + chunk: 1 + private: 1 + tags: Legacy/XPack/Reference + current: 6.2 + subject: X-Pack + index: docs/en/index.asciidoc + branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] + sources: + - + repo: x-pack + path: docs/en + - + repo: x-pack-kibana + prefix: kibana-extra/x-pack-kibana + path: docs/en + exclude_branches: [ master, 6.7, 6.5, 6.4, 6.3, 5.3, 5.2, 5.1, 5.0] + - + repo: x-pack-elasticsearch + prefix: elasticsearch-extra/x-pack-elasticsearch + path: docs/en + exclude_branches: [ master, 6.7, 6.5, 6.4, 6.3, 5.3, 5.2, 5.1, 5.0] + - + repo: docs + path: shared/attributes62.asciidoc + exclude_branches: [ 5.4, 5.3, 5.2, 5.1, 5.0 ] + + - title: 简体中文 + base_dir: cn + lang: zh_cn + sections: + - title: 《Elasticsearch 权威指南》中文版 + noindex: 1 + prefix: elasticsearch/guide + index: book.asciidoc + current: cn + branches: [ {cn: 2.x} ] + chunk: 1 + private: 1 + lang: zh_cn + tags: Elasticsearch/Definitive Guide + subject: Elasticsearch + suppress_migration_warnings: true + sources: + - + repo: guide-cn + path: / + - title: PHP API + noindex: 1 + prefix: elasticsearch/php + index: index.asciidoc + current: cn + branches: [ {cn: 6.0} ] + lang: zh_cn + tags: Elasticsearch/PHP + subject: Elasticsearch + sources: + - + repo: elasticsearch-php-cn + path: / + - title: Kibana 用户手册 + noindex: 1 + prefix: kibana + index: docs/index.asciidoc + current: cn + branches: [ {cn: 6.0} ] + lang: zh_cn + chunk: 1 + private: 1 + tags: Kibana/Reference + subject: Kibana + sources: + - + repo: kibana-cn + path: /docs + - title: 日本語 + base_dir: jp + lang: ja + sections: + - title: Elasticsearchリファレンス + noindex: 1 + prefix: elasticsearch/reference + index: docs/jp/reference/gs-index.asciidoc + current: 5.4 + branches: [ 5.4, 5.3 ] + chunk: 1 + private: 1 + lang: ja + tags: Elasticsearch/Reference + subject: Elasticsearch + sources: + - + repo: elasticsearch + path: /docs/jp/reference + - + repo: elasticsearch + path: /docs + - title: Logstashリファレンス + noindex: 1 + prefix: logstash + index: docs/jp/gs-index.asciidoc + current: 5.4 + branches: [ 5.4, 5.3 ] + chunk: 1 + private: 1 + lang: ja + tags: Logstash/Reference + subject: Logstash + sources: + - + repo: logstash + path: /docs/jp + - title: Kibanaユーザーガイド + noindex: 1 + prefix: kibana + index: docs/jp/gs-index.asciidoc + current: 5.4 + branches: [ 5.4, 5.3 ] + chunk: 1 + private: 1 + lang: ja + tags: Kibana/Reference + subject: Kibana + sources: + - + repo: kibana + path: /docs/jp + - title: X-Packリファレンス + noindex: 1 + prefix: x-pack + index: docs/jp/gs-index.asciidoc + current: 5.4 + branches: [ 5.4 ] + chunk: 1 + private: 1 + lang: ja + tags: X-Pack/Reference + subject: X-Pack + sources: + - + repo: x-pack + path: /docs/jp + - + repo: x-pack-kibana + path: docs/jp + prefix: kibana-extra/x-pack-kibana + - + repo: x-pack-elasticsearch + path: /docs/jp + prefix: elasticsearch-extra/x-pack-elasticsearch + - title: 한국어 + base_dir: kr + lang: ko + sections: + - title: Elasticsearch 참조 + noindex: 1 + prefix: elasticsearch/reference + index: docs/kr/reference/gs-index.asciidoc + current: 5.4 + branches: [ 5.4, 5.3 ] + chunk: 1 + private: 1 + lang: ko + tags: Elasticsearch/Reference + subject: Elasticsearch + sources: + - + repo: elasticsearch + path: /docs/kr/reference + - + repo: elasticsearch + path: /docs + - title: Logstash 참조 + noindex: 1 + prefix: logstash + index: docs/kr/gs-index.asciidoc + current: 5.4 + branches: [ 5.4, 5.3 ] + chunk: 1 + private: 1 + lang: ko + tags: Logstash/Reference + subject: Logstash + sources: + - + repo: logstash + path: /docs/kr + - title: Kibana 사용자 가이드 + noindex: 1 + prefix: kibana + index: docs/kr/gs-index.asciidoc + current: 5.4 + branches: [ 5.4, 5.3 ] + chunk: 1 + private: 1 + lang: ko + tags: Kibana/Reference + subject: Kibana + sources: + - + repo: kibana + path: /docs/kr + - title: X-Pack 참조 + noindex: 1 + prefix: x-pack + index: docs/kr/gs-index.asciidoc + current: 5.4 + branches: [ 5.4 ] + chunk: 1 + private: 1 + lang: ko + tags: X-Pack/Reference + subject: X-Pack + sources: + - + repo: x-pack + path: /docs/kr + - + repo: x-pack-kibana + path: /docs/kr + prefix: kibana-extra/x-pack-kibana + - + repo: x-pack-elasticsearch + path: /docs/kr + prefix: elasticsearch-extra/x-pack-elasticsearch + +redirects: + - + prefix: en/ + redirect: /guide + - + prefix: en/elasticsearch + redirect: /guide + - + prefix: cn/elasticsearch + redirect: /cn diff --git a/docs/source/migration/scripts/codeowner-gen/output.md b/docs/source/migration/scripts/codeowner-gen/output.md new file mode 100644 index 000000000..9b029595f --- /dev/null +++ b/docs/source/migration/scripts/codeowner-gen/output.md @@ -0,0 +1,577 @@ +### [apm-agent-android](https://github.com/elastic/apm-agent-android) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-agent-dotnet](https://github.com/elastic/apm-agent-dotnet) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-agent-go](https://github.com/elastic/apm-agent-go) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-agent-ios](https://github.com/elastic/apm-agent-ios) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-agent-java](https://github.com/elastic/apm-agent-java) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-agent-nodejs](https://github.com/elastic/apm-agent-nodejs) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-agent-php](https://github.com/elastic/apm-agent-php) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-agent-python](https://github.com/elastic/apm-agent-python) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-agent-ruby](https://github.com/elastic/apm-agent-ruby) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-agent-rum-js](https://github.com/elastic/apm-agent-rum-js) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-aws-lambda](https://github.com/elastic/apm-aws-lambda) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-k8s-attacher](https://github.com/elastic/apm-k8s-attacher) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [apm-server](https://github.com/elastic/apm-server) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +changelogs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +docs/data/*.asciidoc @docs-freeze-team +docs/guide/*.asciidoc @docs-freeze-team +docs/spec/*.asciidoc @docs-freeze-team +``` + +### [beats](https://github.com/elastic/beats) + +``` +CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team +auditbeat/*.asciidoc @docs-freeze-team +auditbeat/docs/*.asciidoc @docs-freeze-team +auditbeat/module/*.asciidoc @docs-freeze-team +auditbeat/scripts/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +filebeat/*.asciidoc @docs-freeze-team +filebeat/docs/*.asciidoc @docs-freeze-team +heartbeat/*.asciidoc @docs-freeze-team +heartbeat/docs/*.asciidoc @docs-freeze-team +journalbeat/*.asciidoc @docs-freeze-team +journalbeat/docs/*.asciidoc @docs-freeze-team +libbeat/docs/*.asciidoc @docs-freeze-team +libbeat/outputs/*/docs/*/*.asciidoc @docs-freeze-team +libbeat/processors/*/docs/*/*.asciidoc @docs-freeze-team +metricbeat/*.asciidoc @docs-freeze-team +metricbeat/docs/*.asciidoc @docs-freeze-team +metricbeat/module/*.asciidoc @docs-freeze-team +metricbeat/scripts/*.asciidoc @docs-freeze-team +packetbeat/*.asciidoc @docs-freeze-team +packetbeat/docs/*.asciidoc @docs-freeze-team +topbeat/docs/*.asciidoc @docs-freeze-team +winlogbeat/*.asciidoc @docs-freeze-team +winlogbeat/docs/*.asciidoc @docs-freeze-team +x-pack/auditbeat/*.asciidoc @docs-freeze-team +x-pack/auditbeat/processors/*/docs/*/*.asciidoc @docs-freeze-team +x-pack/dockerlogbeat/docs/*.asciidoc @docs-freeze-team +x-pack/filebeat/docs/*.asciidoc @docs-freeze-team +x-pack/filebeat/processors/*/docs/*/*.asciidoc @docs-freeze-team +x-pack/functionbeat/*.asciidoc @docs-freeze-team +x-pack/functionbeat/docs/*.asciidoc @docs-freeze-team +x-pack/libbeat/docs/*.asciidoc @docs-freeze-team +x-pack/libbeat/processors/*/docs/*/*.asciidoc @docs-freeze-team +x-pack/metricbeat/module/*.asciidoc @docs-freeze-team +``` + +### [clients-team](https://github.com/elastic/clients-team) + +``` +docs/examples/elastic-cloud/csharp/*.asciidoc @docs-freeze-team +docs/examples/elastic-cloud/go/*.asciidoc @docs-freeze-team +docs/examples/elastic-cloud/java/*.asciidoc @docs-freeze-team +docs/examples/elastic-cloud/javascript/*.asciidoc @docs-freeze-team +docs/examples/elastic-cloud/php/*.asciidoc @docs-freeze-team +docs/examples/elastic-cloud/python/*.asciidoc @docs-freeze-team +docs/examples/elastic-cloud/ruby/*.asciidoc @docs-freeze-team +``` + +### [cloud](https://github.com/elastic/cloud) + +``` +docs/*.asciidoc @docs-freeze-team +docs/heroku/*.asciidoc @docs-freeze-team +docs/saas/*.asciidoc @docs-freeze-team +docs/shared/*.asciidoc @docs-freeze-team +``` + +### [cloud-assets](https://github.com/elastic/cloud-assets) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [cloud-on-k8s](https://github.com/elastic/cloud-on-k8s) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [curator](https://github.com/elastic/curator) + +``` +docs/asciidoc/*.asciidoc @docs-freeze-team +``` + +### [docs](#) + +``` +shared/attributes.asciidoc/*.asciidoc @docs-freeze-team +shared/attributes62.asciidoc/*.asciidoc @docs-freeze-team +shared/legacy-attrs.asciidoc/*.asciidoc @docs-freeze-team +shared/settings.asciidoc/*.asciidoc @docs-freeze-team +shared/versions/ece/{version}.asciidoc/*.asciidoc @docs-freeze-team +shared/versions/stack/current.asciidoc/*.asciidoc @docs-freeze-team +shared/versions/stack/{version}.asciidoc/*.asciidoc @docs-freeze-team +``` + +### [docs-content](https://github.com/elastic/docs-content) + +``` +serverless/*.asciidoc @docs-freeze-team +``` + +### [ecctl](https://github.com/elastic/ecctl) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [ecs](https://github.com/elastic/ecs) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [ecs-dotnet](https://github.com/elastic/ecs-dotnet) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [ecs-logging](https://github.com/elastic/ecs-logging) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [ecs-logging-go-logrus](https://github.com/elastic/ecs-logging-go-logrus) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [ecs-logging-go-zap](https://github.com/elastic/ecs-logging-go-zap) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [ecs-logging-go-zerolog](https://github.com/elastic/ecs-logging-go-zerolog) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [ecs-logging-java](https://github.com/elastic/ecs-logging-java) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [ecs-logging-nodejs](https://github.com/elastic/ecs-logging-nodejs) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [ecs-logging-php](https://github.com/elastic/ecs-logging-php) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [ecs-logging-python](https://github.com/elastic/ecs-logging-python) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [ecs-logging-ruby](https://github.com/elastic/ecs-logging-ruby) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [eland](https://github.com/elastic/eland) + +``` +docs/guide/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch](https://github.com/elastic/elasticsearch) + +``` +/docs/*.asciidoc @docs-freeze-team +/docs/jp/reference/*.asciidoc @docs-freeze-team +/docs/kr/reference/*.asciidoc @docs-freeze-team +build-tools-internal/*.asciidoc @docs-freeze-team +build-tools-internal/src/main/resources/*.asciidoc @docs-freeze-team +build-tools/src/main/resources/*.asciidoc @docs-freeze-team +buildSrc/*.asciidoc @docs-freeze-team +buildSrc/src/main/resources/*.asciidoc @docs-freeze-team +client/*.asciidoc @docs-freeze-team +client/rest-high-level/src/test/java/org/elasticsearch/client/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +docs/Versions.asciidoc/*.asciidoc @docs-freeze-team +docs/community-clients/*.asciidoc @docs-freeze-team +docs/groovy-api/*.asciidoc @docs-freeze-team +docs/java-api/*.asciidoc @docs-freeze-team +docs/java-rest/*.asciidoc @docs-freeze-team +docs/painless/*.asciidoc @docs-freeze-team +docs/plugins/*.asciidoc @docs-freeze-team +docs/reference/*.asciidoc @docs-freeze-team +docs/resiliency/*.asciidoc @docs-freeze-team +docs/src/test/cluster/config/*.asciidoc @docs-freeze-team +modules/reindex/src/internalClusterTest/java/org/elasticsearch/client/documentation/*.asciidoc @docs-freeze-team +modules/reindex/src/test/java/org/elasticsearch/client/documentation/*.asciidoc @docs-freeze-team +plugins/examples/*.asciidoc @docs-freeze-team +server/src/internalClusterTest/java/org/elasticsearch/client/documentation/*.asciidoc @docs-freeze-team +server/src/main/resources/org/elasticsearch/common/*.asciidoc @docs-freeze-team +server/src/test/java/org/elasticsearch/client/documentation/*.asciidoc @docs-freeze-team +x-pack/docs/*.asciidoc @docs-freeze-team +x-pack/plugin/esql/qa/testFixtures/src/main/resources/*.asciidoc @docs-freeze-team +x-pack/plugin/sql/qa/*.asciidoc @docs-freeze-team +x-pack/qa/sql/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch-hadoop](https://github.com/elastic/elasticsearch-hadoop) + +``` +docs/src/reference/asciidoc/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch-java](https://github.com/elastic/elasticsearch-java) + +``` +docs/*.asciidoc @docs-freeze-team +java-client/src/test/java/co/elastic/clients/documentation/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch-js](https://github.com/elastic/elasticsearch-js) + +``` +docs/*.asciidoc @docs-freeze-team +docs/doc_examples/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch-js-legacy](https://github.com/elastic/elasticsearch-js-legacy) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch-net](https://github.com/elastic/elasticsearch-net) + +``` +docs/*.asciidoc @docs-freeze-team +tests/Tests/Documentation/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch-perl](https://github.com/elastic/elasticsearch-perl) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch-php](https://github.com/elastic/elasticsearch-php) + +``` +docs/*.asciidoc @docs-freeze-team +docs/examples/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch-php-cn](https://github.com/elasticsearch-cn/elasticsearch-php) + +``` +/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch-py](https://github.com/elastic/elasticsearch-py) + +``` +docs/examples/*.asciidoc @docs-freeze-team +docs/guide/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch-rs](https://github.com/elastic/elasticsearch-rs) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [elasticsearch-ruby](https://github.com/elastic/elasticsearch-ruby) + +``` +docs/*.asciidoc @docs-freeze-team +docs/examples/guide/*.asciidoc @docs-freeze-team +``` + +### [enterprise-search-js](https://github.com/elastic/enterprise-search-js) + +``` +packages/enterprise-search/docs/*.asciidoc @docs-freeze-team +``` + +### [enterprise-search-php](https://github.com/elastic/enterprise-search-php) + +``` +docs/guide/*.asciidoc @docs-freeze-team +``` + +### [enterprise-search-pubs](https://github.com/elastic/enterprise-search-pubs) + +``` +app-search-docs/*.asciidoc @docs-freeze-team +client-docs/app-search-javascript/*.asciidoc @docs-freeze-team +client-docs/app-search-node/*.asciidoc @docs-freeze-team +client-docs/workplace-search-node/*.asciidoc @docs-freeze-team +enterprise-search-docs/*.asciidoc @docs-freeze-team +esre-docs/*.asciidoc @docs-freeze-team +workplace-search-docs/*.asciidoc @docs-freeze-team +``` + +### [enterprise-search-python](https://github.com/elastic/enterprise-search-python) + +``` +docs/guide/*.asciidoc @docs-freeze-team +``` + +### [enterprise-search-ruby](https://github.com/elastic/enterprise-search-ruby) + +``` +docs/guide/*.asciidoc @docs-freeze-team +``` + +### [esf](https://github.com/elastic/elastic-serverless-forwarder) + +``` +docs/en/*.asciidoc @docs-freeze-team +``` + +### [go-elasticsearch](https://github.com/elastic/go-elasticsearch) + +``` +.doc/*.asciidoc @docs-freeze-team +.doc/examples/doc/*.asciidoc @docs-freeze-team +``` + +### [guide](https://github.com/elastic/elasticsearch-definitive-guide) + +``` +/*.asciidoc @docs-freeze-team +``` + +### [guide-cn](https://github.com/elasticsearch-cn/elasticsearch-definitive-guide) + +``` +/*.asciidoc @docs-freeze-team +``` + +### [ingest-docs](https://github.com/elastic/ingest-docs) + +``` +docs/en/*.asciidoc @docs-freeze-team +``` + +### [integration-docs](https://github.com/elastic/integration-docs) + +``` +dist/*.asciidoc @docs-freeze-team +``` + +### [kibana](https://github.com/elastic/kibana) + +``` +/docs/jp/*.asciidoc @docs-freeze-team +/docs/kr/*.asciidoc @docs-freeze-team +:(glob)examples/**/*.asciidoc/*.asciidoc @docs-freeze-team +:(glob)src/**/*.asciidoc/*.asciidoc @docs-freeze-team +:(glob)x-pack/**/*.asciidoc/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [kibana-cn](https://github.com/elasticsearch-cn/kibana) + +``` +/docs/*.asciidoc @docs-freeze-team +``` + +### [logstash](https://github.com/elastic/logstash) + +``` +/docs/jp/*.asciidoc @docs-freeze-team +/docs/kr/*.asciidoc @docs-freeze-team +docs/*.asciidoc @docs-freeze-team +``` + +### [logstash-docs](https://github.com/elastic/logstash-docs) + +``` +docs/*.asciidoc @docs-freeze-team +docs/versioned-plugins/*.asciidoc @docs-freeze-team +``` + +### [observability-docs](https://github.com/elastic/observability-docs) + +``` +docs/en/*.asciidoc @docs-freeze-team +docs/en/observability/*.asciidoc @docs-freeze-team +docs/en/serverless/*.asciidoc @docs-freeze-team +``` + +### [package-spec](https://github.com/elastic/package-spec) + +``` +spec/*.asciidoc @docs-freeze-team +versions/*.asciidoc @docs-freeze-team +``` + +### [search-ui](https://github.com/elastic/search-ui) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [security-docs](https://github.com/elastic/security-docs) + +``` +docs/*.asciidoc @docs-freeze-team +docs/serverless/*.asciidoc @docs-freeze-team +``` + +### [sense](https://github.com/elastic/sense) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [stack-docs](https://github.com/elastic/stack-docs) + +``` +docs/en/*.asciidoc @docs-freeze-team +docs/en/gke-on-prem/*.asciidoc @docs-freeze-team +docs/en/stack/*.asciidoc @docs-freeze-team +``` + +### [swiftype](https://github.com/elastic/swiftype-doc-placeholder) + +``` +docs/*.asciidoc @docs-freeze-team +``` + +### [tech-content](https://github.com/elastic/tech-content) + +``` +welcome-to-elastic/*.asciidoc @docs-freeze-team +``` + +### [terraform-provider-ec](https://github.com/elastic/terraform-provider-ec) + +``` +docs-elastic/*.asciidoc @docs-freeze-team +``` + +### [x-pack](https://github.com/elastic/x-pack) + +``` +/docs/jp/*.asciidoc @docs-freeze-team +/docs/kr/*.asciidoc @docs-freeze-team +docs/en/*.asciidoc @docs-freeze-team +docs/public/graph/*.asciidoc @docs-freeze-team +docs/public/marvel/*.asciidoc @docs-freeze-team +docs/public/reporting/*.asciidoc @docs-freeze-team +docs/public/shield/*.asciidoc @docs-freeze-team +docs/public/watcher/*.asciidoc @docs-freeze-team +``` + +### [x-pack-elasticsearch](https://github.com/elastic/x-pack-elasticsearch) + +``` +/docs/jp/*.asciidoc @docs-freeze-team +/docs/kr/*.asciidoc @docs-freeze-team +docs/en/*.asciidoc @docs-freeze-team +qa/sql/*.asciidoc @docs-freeze-team +``` + +### [x-pack-kibana](https://github.com/elastic/x-pack-kibana) + +``` +/docs/kr/*.asciidoc @docs-freeze-team +docs/en/*.asciidoc @docs-freeze-team +docs/jp/*.asciidoc @docs-freeze-team +``` + +### [x-pack-logstash](https://github.com/elastic/x-pack-logstash) + +``` +docs/en/*.asciidoc @docs-freeze-team +``` + diff --git a/docs/source/migration/scripts/tab-converter/tab.py b/docs/source/migration/scripts/tab-converter/tab.py new file mode 100644 index 000000000..30e74b3bc --- /dev/null +++ b/docs/source/migration/scripts/tab-converter/tab.py @@ -0,0 +1,64 @@ +import os +from pathlib import Path +import re +import argparse + +def extract_tab_info(html_content): + # Extract tab titles + button_pattern = r']*>\s*(.*?)\s*' + titles = re.findall(button_pattern, html_content, re.DOTALL) + + # Extract tab content + panel_pattern = r']*role="tabpanel"[^>]*>(.*?)' + contents = re.findall(panel_pattern, html_content, re.DOTALL) + + # Clean up the content (remove extra whitespace) + titles = [title.strip() for title in titles] + contents = [content.strip() for content in contents] + + return list(zip(titles, contents)) + +def html_to_md_tabs(html_content): + # Get tab information + tabs = extract_tab_info(html_content) + + # Generate markdown output + md_output = '::::{tab-set}\n\n' + + for title, content in tabs: + md_output += f":::{{tab-item}} {title}\n" # Fixed: Added curly braces + md_output += f"{content}\n" + md_output += ":::\n\n" + + md_output += "::::" + + return md_output + +def convert_file(file_path): + with open(file_path, 'r', encoding='utf-8') as file: + content = file.read() + + # Find tab sections + tab_pattern = r'
]*>.*?
\s*' + matches = re.findall(tab_pattern, content, re.DOTALL) + + if matches: + for match in matches: + md_tabs = html_to_md_tabs(match) + content = content.replace(match, md_tabs) + + with open(file_path, 'w', encoding='utf-8') as file: + file.write(content) + print(f"Converted HTML tabs in '{file_path}' to Markdown.") + +def main(): + parser = argparse.ArgumentParser(description='Convert HTML tabs to Markdown in .md files.') + parser.add_argument('-dir', type=str, required=True, help='Path to the directory containing Markdown files.') + args = parser.parse_args() + + # Walk through all .md files in the directory + for md_file in Path(args.dir).rglob('*.md'): + convert_file(md_file) + +if __name__ == "__main__": + main() diff --git a/docs/source/migration/tabs.md b/docs/source/migration/tabs.md new file mode 100644 index 000000000..c59221a46 --- /dev/null +++ b/docs/source/migration/tabs.md @@ -0,0 +1,42 @@ +--- +title: HTML to Markdown Tab Converter +--- + +### HTML to Markdown Tab Converter + +The tab converter script is used to convert HTML tabs into Markdown tabs within documentation files. The script scans through specified directories, finds all Markdown (`.md`) files, and replaces any HTML-based tab structures with their Markdown equivalents. + +**Note**: Running this script may or may not be necessary depending on the evolution of our migration tool. Use it as needed based on the current state of the documentation. + +#### How to Run the Script + +To execute the script and convert HTML tabs to Markdown tabs, follow these steps: + +1. **Navigate to the Script Directory**: + + From the root of the repository, navigate to the tab converter script directory: + + ```sh + cd docs/source/migration/scripts/tab-converter + ``` + +2. **Run the Script**: + + Execute the script by pointing it to the directory containing the Markdown files you wish to process. Replace `/path/to/markdown/files` with the actual path to your Markdown files. + + ```sh + python3 tab_converter.py /path/to/markdown/files + ``` + + **Example**: + + ```sh + python3 tab_converter.py ../../../content/docs/ + ``` + + This command processes all `.md` files within the `content/docs/` directory relative to the script's location. + +#### Important Notes + +- **Backup Your Files**: Before running the script, it's recommended to back up your Markdown files or ensure they are under version control (e.g., in a Git repository). This allows you to revert changes if necessary. +- **Verify Changes**: After running the script, review the modified files to ensure that the tabs have been converted correctly. \ No newline at end of file diff --git a/docs/source/syntax/automated_settings.md b/docs/source/syntax/automated_settings.md index 0eeeb616a..19a5ea51c 100644 --- a/docs/source/syntax/automated_settings.md +++ b/docs/source/syntax/automated_settings.md @@ -11,6 +11,23 @@ Elastic Docs V3 supports the ability to build a markdown settings reference from ::: ``` +### Example + +```yaml +groups: + - group: Group name + id: Link ID + settings: + - setting: Setting name + default: Default value + platform: Supported platforms + description: | + A multi-line description with markdown support. + More here. + example: | + A multi-line example with markdown support. +``` + ### Result _Everything below this line is auto-generated._ From 8b4680b931c38d7016aec42e5de8f3b20ebc2593 Mon Sep 17 00:00:00 2001 From: bmorelli25 Date: Fri, 10 Jan 2025 15:40:24 -0800 Subject: [PATCH 02/10] =?UTF-8?q?Update=20to=20use=20Martijn=E2=80=99s=20d?= =?UTF-8?q?ev=20folder=20instead?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/build/index.md | 7 ------- docs/source/build/infra.md | 5 ----- docs/source/{build => development}/link-validation.md | 0 docs/source/development/toc.yml | 1 + 4 files changed, 1 insertion(+), 12 deletions(-) delete mode 100644 docs/source/build/index.md delete mode 100644 docs/source/build/infra.md rename docs/source/{build => development}/link-validation.md (100%) diff --git a/docs/source/build/index.md b/docs/source/build/index.md deleted file mode 100644 index 5e9d846f4..000000000 --- a/docs/source/build/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Docs build internals ---- - -Placeholder for now. - -* [Link validation](link-validation.md) \ No newline at end of file diff --git a/docs/source/build/infra.md b/docs/source/build/infra.md deleted file mode 100644 index 7244c2774..000000000 --- a/docs/source/build/infra.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: AWS ---- - -Placeholder \ No newline at end of file diff --git a/docs/source/build/link-validation.md b/docs/source/development/link-validation.md similarity index 100% rename from docs/source/build/link-validation.md rename to docs/source/development/link-validation.md diff --git a/docs/source/development/toc.yml b/docs/source/development/toc.yml index dec679b99..09cd04c72 100644 --- a/docs/source/development/toc.yml +++ b/docs/source/development/toc.yml @@ -1,2 +1,3 @@ toc: - file: index.md + - file: link-validation.md From b5b99d23627540b80ddc8b480ad5d9ac6871feda Mon Sep 17 00:00:00 2001 From: bmorelli25 Date: Fri, 10 Jan 2025 15:48:11 -0800 Subject: [PATCH 03/10] fix warnings --- docs/source/development/link-validation.md | 3 ++- docs/source/docset.yml | 2 ++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/source/development/link-validation.md b/docs/source/development/link-validation.md index 8a3d32681..4b6eec67a 100644 --- a/docs/source/development/link-validation.md +++ b/docs/source/development/link-validation.md @@ -5,7 +5,8 @@ title: Link validation * See the [RFC](https://docs.google.com/document/d/1fZNeJCVLKu19s4WIKkkqrHyE9YlWQHNed94Y_V7ofRI/edit?tab=t.0#heading=h.z8tixe192fr4). * Infrastructure lives in [docs-infra](https://github.com/elastic/docs-infra). -```{mermaid} +The mermaid chart below is currently unsupported. +``` flowchart TD subgraph **Repository Build Process** direction LR diff --git a/docs/source/docset.yml b/docs/source/docset.yml index f603232da..60720a429 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -15,6 +15,8 @@ external_hosts: - yarnpkg.com - react.dev - palletsprojects.com + - google.com + - checkvist.com exclude: - '_*.md' subs: From 10ee6c45d9af4e03ac2896c093af1e194a19ad79 Mon Sep 17 00:00:00 2001 From: bmorelli25 Date: Fri, 10 Jan 2025 19:11:52 -0800 Subject: [PATCH 04/10] more updates and gh issue templates --- .github/ISSUE_TEMPLATE/bug-report.yaml | 38 ++ .github/ISSUE_TEMPLATE/enhancement.yaml | 90 ++++ docs/source/contribute/change-browser.md | 3 - docs/source/contribute/index.md | 28 +- .../{change-local.md => locally.md} | 34 +- docs/source/contribute/on-the-web.md | 12 + docs/source/development/link-validation.md | 1 + docs/source/docset.yml | 11 +- docs/source/index.md | 16 +- docs/source/migration/gh-action.md | 51 +++ docs/source/migration/index.md | 2 +- .../scripts/codeowner-gen/codeowner.py | 2 +- .../migration/scripts/codeowner-gen/output.md | 415 +++++++++--------- 13 files changed, 463 insertions(+), 240 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/enhancement.yaml delete mode 100644 docs/source/contribute/change-browser.md rename docs/source/contribute/{change-local.md => locally.md} (83%) create mode 100644 docs/source/contribute/on-the-web.md create mode 100644 docs/source/migration/gh-action.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 000000000..dc43518e4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,38 @@ +name: "Bug Report" +description: "File a bug report." +labels: ["bug"] +projects: ["elastic/1625"] +body: + - type: "textarea" + id: description + attributes: + label: "Describe the bug" + description: "A clear and concise description of what the bug is. If applicable, add screenshots to help explain your problem." + validations: + required: true + - type: "textarea" + id: expected + attributes: + label: "Expected behavior" + description: "A clear and concise description of what you expected to happen." + validations: + required: true + - type: "textarea" + id: repro + attributes: + label: "Steps to reproduce" + description: "If relevant, provide steps to reproduce the issue." + validations: + required: false + - type: "checkboxes" + id: tooling + attributes: + label: "Tooling" + description: "Select the tool this bug relates to." + options: + - label: "docs-builder" + required: false + - label: "migration tooling" + required: false + - label: "I'm not sure" + required: false diff --git a/.github/ISSUE_TEMPLATE/enhancement.yaml b/.github/ISSUE_TEMPLATE/enhancement.yaml new file mode 100644 index 000000000..d6881173a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yaml @@ -0,0 +1,90 @@ +name: Feature Request +description: Suggest an idea for improving docs-builder. +title: "[Feature Request]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to suggest an improvement to docs-builder! Please fill out this form as completely as possible. + + - type: checkboxes + attributes: + label: Prerequisites + description: Please verify you have completed the following + options: + - label: I have searched existing issues to ensure this feature hasn't already been requested + required: true + - label: I have tested using the latest version of docs-builder + required: true + + - type: textarea + id: problem + attributes: + label: What problem are you trying to solve? + description: | + Describe the context and limitation you're encountering. Remember that it might not be obvious to others why this is important! + placeholder: | + Example: When building documentation for my project, I often need to update the revision date at the top of each file. Currently, I have to manually edit each file, which is time-consuming and error-prone. + validations: + required: true + + - type: textarea + id: solution + attributes: + label: Proposed Solution + description: | + Describe your proposed solution. Include as much detail as you can, but remember that there might be other solutions we haven't thought of! + placeholder: | + Example: Add a CLI flag --auto-update-revision-date that automatically updates a specified metadata field in all documentation files when building. + validations: + required: true + + - type: textarea + id: examples + attributes: + label: Examples and Research + description: | + Please provide any relevant examples, research, or references that support this feature request: + - Similar features in other documentation tools + - Code samples showing how you'd use this feature + - Links to relevant standards or conventions + - Screenshots or diagrams of your proposed solution + placeholder: | + - MkDocs has a similar feature using their `git-revision-date-localized` plugin + - Jekyll's `last_modified_at` plugin demonstrates this functionality + validations: + required: false + + - type: textarea + id: alternatives + attributes: + label: Alternative Solutions + description: | + What alternative solutions have you considered or tried? Why aren't they sufficient? + placeholder: | + I've tried using git hooks to update the dates, but this doesn't work well in CI/CD pipelines. + validations: + required: false + + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context about the feature request here. + placeholder: | + - This would be particularly useful for compliance documentation where revision dates are mandatory + - Could potentially integrate with git history for more accurate dating + validations: + required: false + + - type: dropdown + id: priority + attributes: + label: How important is this feature to you? + options: + - Nice to have + - Important + - Critical + validations: + required: true diff --git a/docs/source/contribute/change-browser.md b/docs/source/contribute/change-browser.md deleted file mode 100644 index 271ba1759..000000000 --- a/docs/source/contribute/change-browser.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Update the docs in your browser ---- \ No newline at end of file diff --git a/docs/source/contribute/index.md b/docs/source/contribute/index.md index 345042a7f..ae6f3c7a0 100644 --- a/docs/source/contribute/index.md +++ b/docs/source/contribute/index.md @@ -1,10 +1,28 @@ --- title: Elastic Docs contribution guide -navigation_title: Contribution guide +navigation_title: Contribute --- -Want to contribute to the Elastic documentation? You're in the right spot! Select an option below to get started: +Welcome, **contributor**! -* I just want to suggest a change --> [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml) -* I want to make a small change to a single page --> [Update the docs in your _web browser_](change-browser.md). -* I want to make a larger change or a change to multiple pages --> [Update the docs in your _code editor_](change-local.md). +Whether you're a technical writer or you've only edited Elastic docs once or twice, you're a valued contributor. Every word matters! + +## Contribute to the docs [#contribute] + +* Simple bugs and enhancements --> [Contribute on the web](on-the-web.md) +* Complex or multi-page updates --> [Contribute locally](locally.md) + +## Report a bug + +* It's a **documentation** problem --> [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml) *or* [Fix it myself](locally.md) +* It's a **build tool (docs-builder)** problem --> [Open a bug report](https://github.com/elastic/docs-builder/issues/new?template=bug-report.yaml) +* It's a **migration tooling** problem --> [Open a bug report](https://github.com/elastic/docs-builder/issues/new?template=bug-report.yaml) + +## Request an enhancement + +* Make the **documentation** better --> [Open a docs issue](https://github.com/elastic/docs-content/issues/new?template=internal-request.yaml) +* Make our **build tool (docs-builder)** better --> [Open a docs-builder issue](https://github.com/elastic/docs-builder/issues/new?template=enhancement.yaml) + +## Work on docs-builder + +That sounds great! See [development](../development/index.md) to learn how to contribute to our documentation build system. diff --git a/docs/source/contribute/change-local.md b/docs/source/contribute/locally.md similarity index 83% rename from docs/source/contribute/change-local.md rename to docs/source/contribute/locally.md index 8be7b601d..4c0706aeb 100644 --- a/docs/source/contribute/change-local.md +++ b/docs/source/contribute/locally.md @@ -1,22 +1,20 @@ --- -title: Build the docs locally +title: Contribute locally --- -1. Install dependencies -2. Clone repositories -3. Make changes -4. Open a Pull Request -5. Work with CI -6. Get approvals and merge -7. View your changes live on elastic.co +Follow these steps to contribute to Elastic docs. +* [Step 1: Install `docs-builder`](#step-one) +* [Step 2: Clone the `docs-content` repository](#step-two) +* [Step 3: Serve the Documentation](#step-three) +* [Step 4: Open a PR](#step-three) -Follow these instructions to get started with docs-builder on your machine. +## Step 1: Install `docs-builder` [#step-one] ::::{tab-set} :::{tab-item} macOS -### macOS Installation +### macOS 1. **Download the Binary:** Download the latest macOS binary from [releases](https://github.com/elastic/docs-builder/releases/latest/): @@ -40,7 +38,7 @@ Follow these instructions to get started with docs-builder on your machine. :::{tab-item} Windows -### Windows Installation +### Windows 1. **Download the Binary:** Download the latest Windows binary from [releases](https://github.com/elastic/docs-builder/releases/latest/): @@ -64,7 +62,7 @@ Follow these instructions to get started with docs-builder on your machine. :::{tab-item} Linux -### Linux Installation +### Linux 1. **Download the Binary:** Download the latest Linux binary from [releases](https://github.com/elastic/docs-builder/releases/latest/): @@ -88,14 +86,14 @@ Follow these instructions to get started with docs-builder on your machine. :::: -### Clone the `docs-content` Repository +## Clone the `docs-content` Repository [#step-two] Clone the `docs-content` repository to a directory of your choice: ```sh git clone https://github.com/elastic/docs-content.git ``` -### Serve the Documentation +## Serve the Documentation [#step-three] 1. **Navigate to the cloned repository:** ```sh @@ -113,3 +111,11 @@ git clone https://github.com/elastic/docs-content.git ``` Now you should be able to view the documentation locally by navigating to http://localhost:5000. + +## Step 4: Open a PR [#step-four] + +Open a PR. Good luck. + +## Step 5: View on elastic.co/docs + +soon... \ No newline at end of file diff --git a/docs/source/contribute/on-the-web.md b/docs/source/contribute/on-the-web.md new file mode 100644 index 000000000..b01bf82bf --- /dev/null +++ b/docs/source/contribute/on-the-web.md @@ -0,0 +1,12 @@ +--- +title: Contribute on the web +--- + +:::{warning} +This feature is not supported yet. See [#171](https://github.com/elastic/docs-builder/issues/171) for more information. +::: + +1. On the right side of the page you want to edit, select **Edit this page**. +1. Do something on GitHub. +1. Take the dog for a walk. +1. Success! \ No newline at end of file diff --git a/docs/source/development/link-validation.md b/docs/source/development/link-validation.md index 4b6eec67a..04dcd0b2d 100644 --- a/docs/source/development/link-validation.md +++ b/docs/source/development/link-validation.md @@ -6,6 +6,7 @@ title: Link validation * Infrastructure lives in [docs-infra](https://github.com/elastic/docs-infra). The mermaid chart below is currently unsupported. + ``` flowchart TD subgraph **Repository Build Process** diff --git a/docs/source/docset.yml b/docs/source/docset.yml index 60720a429..4d2193a30 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -23,6 +23,11 @@ subs: a-global-variable: "This was defined in docset.yml" toc: - file: index.md + - folder: contribute + children: + - file: index.md + - file: locally.md + - file: on-the-web.md - folder: migration children: - file: index.md @@ -30,12 +35,8 @@ toc: - file: file-structure.md - file: mapping.md - file: tabs.md + - file: gh-action.md - file: codeowner.md - - folder: contribute - children: - - file: index.md - - file: change-browser.md - - file: change-local.md - folder: configure children: - file: index.md diff --git a/docs/source/index.md b/docs/source/index.md index 6ead94c85..ba93d473e 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,8 +1,18 @@ --- -title: Elastic Docs v3 +title: Welcome to Elastic Docs v3 --- -You've reached the home of the latest incarnation of the documentation tooling. +Elastic Docs V3 is our next-generation documentation platform designed to improve the experience of learning, using, and contributing to Elastic products. Built on a foundation of modern authoring tools and scalable infrastructure, V3 offers faster builds, streamlined versioning, and enhanced navigation to guide users through Elastic’s complex ecosystem. + +**What do you want to do today?** + +* [Contribute to Elastic documentation](/contribute/index.html) +* [Learn about migration to Elastic Docs V3](/migration/index.html) +* [Configure content sets in V3](/configure/index.html) +* [Learn about V3 syntax](/syntax/index.html) +* [Contribute to V3 (developer guide)](/development/index.html) + +## About this repo This repository is host to: @@ -104,7 +114,7 @@ environment: url: ${{ steps.deployment.outputs.page_url }} steps: - uses: actions/checkout@v4 - + - name: Publish Github uses: elastic/docs-builder/actions/publish@main id: deployment diff --git a/docs/source/migration/gh-action.md b/docs/source/migration/gh-action.md new file mode 100644 index 000000000..c4fd06a33 --- /dev/null +++ b/docs/source/migration/gh-action.md @@ -0,0 +1,51 @@ +--- +title: Documentation Freeze GH Action +--- + +## Overview +This GitHub Action enforces documentation freezes by adding comments to pull requests that modify `.asciidoc` files. It complements the use of `CODEOWNERS` to ensure changes during a freeze period are reviewed and approved by the `@docs-freeze-team`. + +## How It Works +1. **Trigger**: The Action is triggered on pull request events (`opened`, `reopened`, or `synchronize`). +2. **Check Changes**: It checks the diff between the latest commits to detect modifications to `.asciidoc` files. +3. **Add Comment**: If changes are detected, the Action posts a comment in the pull request, reminding the contributor of the freeze. + +```yaml +name: Comment on PR for .asciidoc changes + +on: + pull_request: + types: + - synchronize + - opened + - reopened + +jobs: + comment-on-asciidoc-change: + runs-on: ubuntu-latest + + steps: + - name: Checkout the repository + uses: actions/checkout@v3 + + - name: Check for changes in .asciidoc files + id: check-files + run: | + if git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -E '\.asciidoc$'; then + echo "asciidoc_changed=true" >> $GITHUB_ENV + else + echo "asciidoc_changed=false" >> $GITHUB_ENV + fi + + - name: Add a comment if .asciidoc files changed + if: env.asciidoc_changed == 'true' + uses: actions/github-script@v6 + with: + script: | + github.rest.issues.createComment({ + owner: context.repo.owner, + repo: context.repo.repo, + issue_number: context.payload.pull_request.number, + body: 'It looks like this PR modifies one or more `.asciidoc` files. The documentation is currently under a documentation freeze. Please do not merge this PR. See [link](link) to learn more.' + }); +``` \ No newline at end of file diff --git a/docs/source/migration/index.md b/docs/source/migration/index.md index 4f9472bc0..9eb21094c 100644 --- a/docs/source/migration/index.md +++ b/docs/source/migration/index.md @@ -16,7 +16,7 @@ To make the transition to Elastic Docs v3 as smooth as possible, we’ve establi * Open an issue in [elastic/docs-content](https://github.com/elastic/docs-content/issues), including details about the documentation requirements, links to resources, and drafts of documentation in GDocs. * Post in [#docs](https://elastic.slack.com/archives/C0JF80CJZ) for emergency documentation requests. -During the documentation freeze, maintaining consistency and avoiding conflicts is key. To prevent documentation changes from merging during the documentation freeze, [codeowners](./codeowner.md) are being added to /docs directories for public-facing documentation in all relevant repositories. +During the documentation freeze, maintaining consistency and avoiding conflicts is key. To prevent documentation changes from merging during the documentation freeze, [CODEOWNERS](./codeowner.md) and a [GH Action](./gh-action.md) are being added to /docs directories for public-facing documentation in all relevant repositories. ## Improved information architecture diff --git a/docs/source/migration/scripts/codeowner-gen/codeowner.py b/docs/source/migration/scripts/codeowner-gen/codeowner.py index 05c1ab523..b45e845d9 100644 --- a/docs/source/migration/scripts/codeowner-gen/codeowner.py +++ b/docs/source/migration/scripts/codeowner-gen/codeowner.py @@ -25,7 +25,7 @@ def traverse_sections(sections, repo_paths): # Remove trailing slashes and replace double slashes with single slashes clean_path = path.rstrip('/').replace('//', '/') # Format the path for CODEOWNERS - formatted_path = f"{clean_path}/*.asciidoc @docs-freeze-team" + formatted_path = f"{clean_path}/*.asciidoc @elastic/docs-freeze-team" repo_paths[repo_name].add(formatted_path) # If there are nested sections, traverse them recursively diff --git a/docs/source/migration/scripts/codeowner-gen/output.md b/docs/source/migration/scripts/codeowner-gen/output.md index 9b029595f..cc6740685 100644 --- a/docs/source/migration/scripts/codeowner-gen/output.md +++ b/docs/source/migration/scripts/codeowner-gen/output.md @@ -1,577 +1,576 @@ ### [apm-agent-android](https://github.com/elastic/apm-agent-android) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-agent-dotnet](https://github.com/elastic/apm-agent-dotnet) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-agent-go](https://github.com/elastic/apm-agent-go) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-agent-ios](https://github.com/elastic/apm-agent-ios) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-agent-java](https://github.com/elastic/apm-agent-java) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-agent-nodejs](https://github.com/elastic/apm-agent-nodejs) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-agent-php](https://github.com/elastic/apm-agent-php) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-agent-python](https://github.com/elastic/apm-agent-python) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-agent-ruby](https://github.com/elastic/apm-agent-ruby) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-agent-rum-js](https://github.com/elastic/apm-agent-rum-js) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-aws-lambda](https://github.com/elastic/apm-aws-lambda) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-k8s-attacher](https://github.com/elastic/apm-k8s-attacher) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [apm-server](https://github.com/elastic/apm-server) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -changelogs/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team -docs/data/*.asciidoc @docs-freeze-team -docs/guide/*.asciidoc @docs-freeze-team -docs/spec/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +changelogs/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team +docs/data/*.asciidoc @elastic/docs-freeze-team +docs/guide/*.asciidoc @elastic/docs-freeze-team +docs/spec/*.asciidoc @elastic/docs-freeze-team ``` ### [beats](https://github.com/elastic/beats) ``` -CHANGELOG.asciidoc/*.asciidoc @docs-freeze-team -auditbeat/*.asciidoc @docs-freeze-team -auditbeat/docs/*.asciidoc @docs-freeze-team -auditbeat/module/*.asciidoc @docs-freeze-team -auditbeat/scripts/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team -filebeat/*.asciidoc @docs-freeze-team -filebeat/docs/*.asciidoc @docs-freeze-team -heartbeat/*.asciidoc @docs-freeze-team -heartbeat/docs/*.asciidoc @docs-freeze-team -journalbeat/*.asciidoc @docs-freeze-team -journalbeat/docs/*.asciidoc @docs-freeze-team -libbeat/docs/*.asciidoc @docs-freeze-team -libbeat/outputs/*/docs/*/*.asciidoc @docs-freeze-team -libbeat/processors/*/docs/*/*.asciidoc @docs-freeze-team -metricbeat/*.asciidoc @docs-freeze-team -metricbeat/docs/*.asciidoc @docs-freeze-team -metricbeat/module/*.asciidoc @docs-freeze-team -metricbeat/scripts/*.asciidoc @docs-freeze-team -packetbeat/*.asciidoc @docs-freeze-team -packetbeat/docs/*.asciidoc @docs-freeze-team -topbeat/docs/*.asciidoc @docs-freeze-team -winlogbeat/*.asciidoc @docs-freeze-team -winlogbeat/docs/*.asciidoc @docs-freeze-team -x-pack/auditbeat/*.asciidoc @docs-freeze-team -x-pack/auditbeat/processors/*/docs/*/*.asciidoc @docs-freeze-team -x-pack/dockerlogbeat/docs/*.asciidoc @docs-freeze-team -x-pack/filebeat/docs/*.asciidoc @docs-freeze-team -x-pack/filebeat/processors/*/docs/*/*.asciidoc @docs-freeze-team -x-pack/functionbeat/*.asciidoc @docs-freeze-team -x-pack/functionbeat/docs/*.asciidoc @docs-freeze-team -x-pack/libbeat/docs/*.asciidoc @docs-freeze-team -x-pack/libbeat/processors/*/docs/*/*.asciidoc @docs-freeze-team -x-pack/metricbeat/module/*.asciidoc @docs-freeze-team +CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team +auditbeat/*.asciidoc @elastic/docs-freeze-team +auditbeat/docs/*.asciidoc @elastic/docs-freeze-team +auditbeat/module/*.asciidoc @elastic/docs-freeze-team +auditbeat/scripts/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team +filebeat/*.asciidoc @elastic/docs-freeze-team +filebeat/docs/*.asciidoc @elastic/docs-freeze-team +heartbeat/*.asciidoc @elastic/docs-freeze-team +heartbeat/docs/*.asciidoc @elastic/docs-freeze-team +journalbeat/*.asciidoc @elastic/docs-freeze-team +journalbeat/docs/*.asciidoc @elastic/docs-freeze-team +libbeat/docs/*.asciidoc @elastic/docs-freeze-team +libbeat/outputs/*/docs/*/*.asciidoc @elastic/docs-freeze-team +libbeat/processors/*/docs/*/*.asciidoc @elastic/docs-freeze-team +metricbeat/*.asciidoc @elastic/docs-freeze-team +metricbeat/docs/*.asciidoc @elastic/docs-freeze-team +metricbeat/module/*.asciidoc @elastic/docs-freeze-team +metricbeat/scripts/*.asciidoc @elastic/docs-freeze-team +packetbeat/*.asciidoc @elastic/docs-freeze-team +packetbeat/docs/*.asciidoc @elastic/docs-freeze-team +topbeat/docs/*.asciidoc @elastic/docs-freeze-team +winlogbeat/*.asciidoc @elastic/docs-freeze-team +winlogbeat/docs/*.asciidoc @elastic/docs-freeze-team +x-pack/auditbeat/*.asciidoc @elastic/docs-freeze-team +x-pack/auditbeat/processors/*/docs/*/*.asciidoc @elastic/docs-freeze-team +x-pack/dockerlogbeat/docs/*.asciidoc @elastic/docs-freeze-team +x-pack/filebeat/docs/*.asciidoc @elastic/docs-freeze-team +x-pack/filebeat/processors/*/docs/*/*.asciidoc @elastic/docs-freeze-team +x-pack/functionbeat/*.asciidoc @elastic/docs-freeze-team +x-pack/functionbeat/docs/*.asciidoc @elastic/docs-freeze-team +x-pack/libbeat/docs/*.asciidoc @elastic/docs-freeze-team +x-pack/libbeat/processors/*/docs/*/*.asciidoc @elastic/docs-freeze-team +x-pack/metricbeat/module/*.asciidoc @elastic/docs-freeze-team ``` ### [clients-team](https://github.com/elastic/clients-team) ``` -docs/examples/elastic-cloud/csharp/*.asciidoc @docs-freeze-team -docs/examples/elastic-cloud/go/*.asciidoc @docs-freeze-team -docs/examples/elastic-cloud/java/*.asciidoc @docs-freeze-team -docs/examples/elastic-cloud/javascript/*.asciidoc @docs-freeze-team -docs/examples/elastic-cloud/php/*.asciidoc @docs-freeze-team -docs/examples/elastic-cloud/python/*.asciidoc @docs-freeze-team -docs/examples/elastic-cloud/ruby/*.asciidoc @docs-freeze-team +docs/examples/elastic-cloud/csharp/*.asciidoc @elastic/docs-freeze-team +docs/examples/elastic-cloud/go/*.asciidoc @elastic/docs-freeze-team +docs/examples/elastic-cloud/java/*.asciidoc @elastic/docs-freeze-team +docs/examples/elastic-cloud/javascript/*.asciidoc @elastic/docs-freeze-team +docs/examples/elastic-cloud/php/*.asciidoc @elastic/docs-freeze-team +docs/examples/elastic-cloud/python/*.asciidoc @elastic/docs-freeze-team +docs/examples/elastic-cloud/ruby/*.asciidoc @elastic/docs-freeze-team ``` ### [cloud](https://github.com/elastic/cloud) ``` -docs/*.asciidoc @docs-freeze-team -docs/heroku/*.asciidoc @docs-freeze-team -docs/saas/*.asciidoc @docs-freeze-team -docs/shared/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team +docs/heroku/*.asciidoc @elastic/docs-freeze-team +docs/saas/*.asciidoc @elastic/docs-freeze-team +docs/shared/*.asciidoc @elastic/docs-freeze-team ``` ### [cloud-assets](https://github.com/elastic/cloud-assets) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [cloud-on-k8s](https://github.com/elastic/cloud-on-k8s) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [curator](https://github.com/elastic/curator) ``` -docs/asciidoc/*.asciidoc @docs-freeze-team +docs/asciidoc/*.asciidoc @elastic/docs-freeze-team ``` ### [docs](#) ``` -shared/attributes.asciidoc/*.asciidoc @docs-freeze-team -shared/attributes62.asciidoc/*.asciidoc @docs-freeze-team -shared/legacy-attrs.asciidoc/*.asciidoc @docs-freeze-team -shared/settings.asciidoc/*.asciidoc @docs-freeze-team -shared/versions/ece/{version}.asciidoc/*.asciidoc @docs-freeze-team -shared/versions/stack/current.asciidoc/*.asciidoc @docs-freeze-team -shared/versions/stack/{version}.asciidoc/*.asciidoc @docs-freeze-team +shared/attributes.asciidoc/*.asciidoc @elastic/docs-freeze-team +shared/attributes62.asciidoc/*.asciidoc @elastic/docs-freeze-team +shared/legacy-attrs.asciidoc/*.asciidoc @elastic/docs-freeze-team +shared/settings.asciidoc/*.asciidoc @elastic/docs-freeze-team +shared/versions/ece/{version}.asciidoc/*.asciidoc @elastic/docs-freeze-team +shared/versions/stack/current.asciidoc/*.asciidoc @elastic/docs-freeze-team +shared/versions/stack/{version}.asciidoc/*.asciidoc @elastic/docs-freeze-team ``` ### [docs-content](https://github.com/elastic/docs-content) ``` -serverless/*.asciidoc @docs-freeze-team +serverless/*.asciidoc @elastic/docs-freeze-team ``` ### [ecctl](https://github.com/elastic/ecctl) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [ecs](https://github.com/elastic/ecs) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [ecs-dotnet](https://github.com/elastic/ecs-dotnet) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [ecs-logging](https://github.com/elastic/ecs-logging) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [ecs-logging-go-logrus](https://github.com/elastic/ecs-logging-go-logrus) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [ecs-logging-go-zap](https://github.com/elastic/ecs-logging-go-zap) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [ecs-logging-go-zerolog](https://github.com/elastic/ecs-logging-go-zerolog) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [ecs-logging-java](https://github.com/elastic/ecs-logging-java) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [ecs-logging-nodejs](https://github.com/elastic/ecs-logging-nodejs) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [ecs-logging-php](https://github.com/elastic/ecs-logging-php) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [ecs-logging-python](https://github.com/elastic/ecs-logging-python) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [ecs-logging-ruby](https://github.com/elastic/ecs-logging-ruby) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [eland](https://github.com/elastic/eland) ``` -docs/guide/*.asciidoc @docs-freeze-team +docs/guide/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch](https://github.com/elastic/elasticsearch) ``` -/docs/*.asciidoc @docs-freeze-team -/docs/jp/reference/*.asciidoc @docs-freeze-team -/docs/kr/reference/*.asciidoc @docs-freeze-team -build-tools-internal/*.asciidoc @docs-freeze-team -build-tools-internal/src/main/resources/*.asciidoc @docs-freeze-team -build-tools/src/main/resources/*.asciidoc @docs-freeze-team -buildSrc/*.asciidoc @docs-freeze-team -buildSrc/src/main/resources/*.asciidoc @docs-freeze-team -client/*.asciidoc @docs-freeze-team -client/rest-high-level/src/test/java/org/elasticsearch/client/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team -docs/Versions.asciidoc/*.asciidoc @docs-freeze-team -docs/community-clients/*.asciidoc @docs-freeze-team -docs/groovy-api/*.asciidoc @docs-freeze-team -docs/java-api/*.asciidoc @docs-freeze-team -docs/java-rest/*.asciidoc @docs-freeze-team -docs/painless/*.asciidoc @docs-freeze-team -docs/plugins/*.asciidoc @docs-freeze-team -docs/reference/*.asciidoc @docs-freeze-team -docs/resiliency/*.asciidoc @docs-freeze-team -docs/src/test/cluster/config/*.asciidoc @docs-freeze-team -modules/reindex/src/internalClusterTest/java/org/elasticsearch/client/documentation/*.asciidoc @docs-freeze-team -modules/reindex/src/test/java/org/elasticsearch/client/documentation/*.asciidoc @docs-freeze-team -plugins/examples/*.asciidoc @docs-freeze-team -server/src/internalClusterTest/java/org/elasticsearch/client/documentation/*.asciidoc @docs-freeze-team -server/src/main/resources/org/elasticsearch/common/*.asciidoc @docs-freeze-team -server/src/test/java/org/elasticsearch/client/documentation/*.asciidoc @docs-freeze-team -x-pack/docs/*.asciidoc @docs-freeze-team -x-pack/plugin/esql/qa/testFixtures/src/main/resources/*.asciidoc @docs-freeze-team -x-pack/plugin/sql/qa/*.asciidoc @docs-freeze-team -x-pack/qa/sql/*.asciidoc @docs-freeze-team +/docs/*.asciidoc @elastic/docs-freeze-team +/docs/jp/reference/*.asciidoc @elastic/docs-freeze-team +/docs/kr/reference/*.asciidoc @elastic/docs-freeze-team +build-tools-internal/*.asciidoc @elastic/docs-freeze-team +build-tools-internal/src/main/resources/*.asciidoc @elastic/docs-freeze-team +build-tools/src/main/resources/*.asciidoc @elastic/docs-freeze-team +buildSrc/*.asciidoc @elastic/docs-freeze-team +buildSrc/src/main/resources/*.asciidoc @elastic/docs-freeze-team +client/*.asciidoc @elastic/docs-freeze-team +client/rest-high-level/src/test/java/org/elasticsearch/client/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team +docs/Versions.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/community-clients/*.asciidoc @elastic/docs-freeze-team +docs/groovy-api/*.asciidoc @elastic/docs-freeze-team +docs/java-api/*.asciidoc @elastic/docs-freeze-team +docs/java-rest/*.asciidoc @elastic/docs-freeze-team +docs/painless/*.asciidoc @elastic/docs-freeze-team +docs/plugins/*.asciidoc @elastic/docs-freeze-team +docs/reference/*.asciidoc @elastic/docs-freeze-team +docs/resiliency/*.asciidoc @elastic/docs-freeze-team +docs/src/test/cluster/config/*.asciidoc @elastic/docs-freeze-team +modules/reindex/src/internalClusterTest/java/org/elasticsearch/client/documentation/*.asciidoc @elastic/docs-freeze-team +modules/reindex/src/test/java/org/elasticsearch/client/documentation/*.asciidoc @elastic/docs-freeze-team +plugins/examples/*.asciidoc @elastic/docs-freeze-team +server/src/internalClusterTest/java/org/elasticsearch/client/documentation/*.asciidoc @elastic/docs-freeze-team +server/src/main/resources/org/elasticsearch/common/*.asciidoc @elastic/docs-freeze-team +server/src/test/java/org/elasticsearch/client/documentation/*.asciidoc @elastic/docs-freeze-team +x-pack/docs/*.asciidoc @elastic/docs-freeze-team +x-pack/plugin/esql/qa/testFixtures/src/main/resources/*.asciidoc @elastic/docs-freeze-team +x-pack/plugin/sql/qa/*.asciidoc @elastic/docs-freeze-team +x-pack/qa/sql/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch-hadoop](https://github.com/elastic/elasticsearch-hadoop) ``` -docs/src/reference/asciidoc/*.asciidoc @docs-freeze-team +docs/src/reference/asciidoc/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch-java](https://github.com/elastic/elasticsearch-java) ``` -docs/*.asciidoc @docs-freeze-team -java-client/src/test/java/co/elastic/clients/documentation/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team +java-client/src/test/java/co/elastic/clients/documentation/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch-js](https://github.com/elastic/elasticsearch-js) ``` -docs/*.asciidoc @docs-freeze-team -docs/doc_examples/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team +docs/doc_examples/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch-js-legacy](https://github.com/elastic/elasticsearch-js-legacy) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch-net](https://github.com/elastic/elasticsearch-net) ``` -docs/*.asciidoc @docs-freeze-team -tests/Tests/Documentation/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team +tests/Tests/Documentation/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch-perl](https://github.com/elastic/elasticsearch-perl) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch-php](https://github.com/elastic/elasticsearch-php) ``` -docs/*.asciidoc @docs-freeze-team -docs/examples/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team +docs/examples/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch-php-cn](https://github.com/elasticsearch-cn/elasticsearch-php) ``` -/*.asciidoc @docs-freeze-team +/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch-py](https://github.com/elastic/elasticsearch-py) ``` -docs/examples/*.asciidoc @docs-freeze-team -docs/guide/*.asciidoc @docs-freeze-team +docs/examples/*.asciidoc @elastic/docs-freeze-team +docs/guide/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch-rs](https://github.com/elastic/elasticsearch-rs) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [elasticsearch-ruby](https://github.com/elastic/elasticsearch-ruby) ``` -docs/*.asciidoc @docs-freeze-team -docs/examples/guide/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team +docs/examples/guide/*.asciidoc @elastic/docs-freeze-team ``` ### [enterprise-search-js](https://github.com/elastic/enterprise-search-js) ``` -packages/enterprise-search/docs/*.asciidoc @docs-freeze-team +packages/enterprise-search/docs/*.asciidoc @elastic/docs-freeze-team ``` ### [enterprise-search-php](https://github.com/elastic/enterprise-search-php) ``` -docs/guide/*.asciidoc @docs-freeze-team +docs/guide/*.asciidoc @elastic/docs-freeze-team ``` ### [enterprise-search-pubs](https://github.com/elastic/enterprise-search-pubs) ``` -app-search-docs/*.asciidoc @docs-freeze-team -client-docs/app-search-javascript/*.asciidoc @docs-freeze-team -client-docs/app-search-node/*.asciidoc @docs-freeze-team -client-docs/workplace-search-node/*.asciidoc @docs-freeze-team -enterprise-search-docs/*.asciidoc @docs-freeze-team -esre-docs/*.asciidoc @docs-freeze-team -workplace-search-docs/*.asciidoc @docs-freeze-team +app-search-docs/*.asciidoc @elastic/docs-freeze-team +client-docs/app-search-javascript/*.asciidoc @elastic/docs-freeze-team +client-docs/app-search-node/*.asciidoc @elastic/docs-freeze-team +client-docs/workplace-search-node/*.asciidoc @elastic/docs-freeze-team +enterprise-search-docs/*.asciidoc @elastic/docs-freeze-team +esre-docs/*.asciidoc @elastic/docs-freeze-team +workplace-search-docs/*.asciidoc @elastic/docs-freeze-team ``` ### [enterprise-search-python](https://github.com/elastic/enterprise-search-python) ``` -docs/guide/*.asciidoc @docs-freeze-team +docs/guide/*.asciidoc @elastic/docs-freeze-team ``` ### [enterprise-search-ruby](https://github.com/elastic/enterprise-search-ruby) ``` -docs/guide/*.asciidoc @docs-freeze-team +docs/guide/*.asciidoc @elastic/docs-freeze-team ``` ### [esf](https://github.com/elastic/elastic-serverless-forwarder) ``` -docs/en/*.asciidoc @docs-freeze-team +docs/en/*.asciidoc @elastic/docs-freeze-team ``` ### [go-elasticsearch](https://github.com/elastic/go-elasticsearch) ``` -.doc/*.asciidoc @docs-freeze-team -.doc/examples/doc/*.asciidoc @docs-freeze-team +.doc/*.asciidoc @elastic/docs-freeze-team +.doc/examples/doc/*.asciidoc @elastic/docs-freeze-team ``` ### [guide](https://github.com/elastic/elasticsearch-definitive-guide) ``` -/*.asciidoc @docs-freeze-team +/*.asciidoc @elastic/docs-freeze-team ``` ### [guide-cn](https://github.com/elasticsearch-cn/elasticsearch-definitive-guide) ``` -/*.asciidoc @docs-freeze-team +/*.asciidoc @elastic/docs-freeze-team ``` ### [ingest-docs](https://github.com/elastic/ingest-docs) ``` -docs/en/*.asciidoc @docs-freeze-team +docs/en/*.asciidoc @elastic/docs-freeze-team ``` ### [integration-docs](https://github.com/elastic/integration-docs) ``` -dist/*.asciidoc @docs-freeze-team +dist/*.asciidoc @elastic/docs-freeze-team ``` ### [kibana](https://github.com/elastic/kibana) ``` -/docs/jp/*.asciidoc @docs-freeze-team -/docs/kr/*.asciidoc @docs-freeze-team -:(glob)examples/**/*.asciidoc/*.asciidoc @docs-freeze-team -:(glob)src/**/*.asciidoc/*.asciidoc @docs-freeze-team -:(glob)x-pack/**/*.asciidoc/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +/docs/jp/*.asciidoc @elastic/docs-freeze-team +/docs/kr/*.asciidoc @elastic/docs-freeze-team +:(glob)examples/**/*.asciidoc/*.asciidoc @elastic/docs-freeze-team +:(glob)src/**/*.asciidoc/*.asciidoc @elastic/docs-freeze-team +:(glob)x-pack/**/*.asciidoc/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [kibana-cn](https://github.com/elasticsearch-cn/kibana) ``` -/docs/*.asciidoc @docs-freeze-team +/docs/*.asciidoc @elastic/docs-freeze-team ``` ### [logstash](https://github.com/elastic/logstash) ``` -/docs/jp/*.asciidoc @docs-freeze-team -/docs/kr/*.asciidoc @docs-freeze-team -docs/*.asciidoc @docs-freeze-team +/docs/jp/*.asciidoc @elastic/docs-freeze-team +/docs/kr/*.asciidoc @elastic/docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [logstash-docs](https://github.com/elastic/logstash-docs) ``` -docs/*.asciidoc @docs-freeze-team -docs/versioned-plugins/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team +docs/versioned-plugins/*.asciidoc @elastic/docs-freeze-team ``` ### [observability-docs](https://github.com/elastic/observability-docs) ``` -docs/en/*.asciidoc @docs-freeze-team -docs/en/observability/*.asciidoc @docs-freeze-team -docs/en/serverless/*.asciidoc @docs-freeze-team +docs/en/*.asciidoc @elastic/docs-freeze-team +docs/en/observability/*.asciidoc @elastic/docs-freeze-team +docs/en/serverless/*.asciidoc @elastic/docs-freeze-team ``` ### [package-spec](https://github.com/elastic/package-spec) ``` -spec/*.asciidoc @docs-freeze-team -versions/*.asciidoc @docs-freeze-team +spec/*.asciidoc @elastic/docs-freeze-team +versions/*.asciidoc @elastic/docs-freeze-team ``` ### [search-ui](https://github.com/elastic/search-ui) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [security-docs](https://github.com/elastic/security-docs) ``` -docs/*.asciidoc @docs-freeze-team -docs/serverless/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team +docs/serverless/*.asciidoc @elastic/docs-freeze-team ``` ### [sense](https://github.com/elastic/sense) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [stack-docs](https://github.com/elastic/stack-docs) ``` -docs/en/*.asciidoc @docs-freeze-team -docs/en/gke-on-prem/*.asciidoc @docs-freeze-team -docs/en/stack/*.asciidoc @docs-freeze-team +docs/en/*.asciidoc @elastic/docs-freeze-team +docs/en/gke-on-prem/*.asciidoc @elastic/docs-freeze-team +docs/en/stack/*.asciidoc @elastic/docs-freeze-team ``` ### [swiftype](https://github.com/elastic/swiftype-doc-placeholder) ``` -docs/*.asciidoc @docs-freeze-team +docs/*.asciidoc @elastic/docs-freeze-team ``` ### [tech-content](https://github.com/elastic/tech-content) ``` -welcome-to-elastic/*.asciidoc @docs-freeze-team +welcome-to-elastic/*.asciidoc @elastic/docs-freeze-team ``` ### [terraform-provider-ec](https://github.com/elastic/terraform-provider-ec) ``` -docs-elastic/*.asciidoc @docs-freeze-team +docs-elastic/*.asciidoc @elastic/docs-freeze-team ``` ### [x-pack](https://github.com/elastic/x-pack) ``` -/docs/jp/*.asciidoc @docs-freeze-team -/docs/kr/*.asciidoc @docs-freeze-team -docs/en/*.asciidoc @docs-freeze-team -docs/public/graph/*.asciidoc @docs-freeze-team -docs/public/marvel/*.asciidoc @docs-freeze-team -docs/public/reporting/*.asciidoc @docs-freeze-team -docs/public/shield/*.asciidoc @docs-freeze-team -docs/public/watcher/*.asciidoc @docs-freeze-team +/docs/jp/*.asciidoc @elastic/docs-freeze-team +/docs/kr/*.asciidoc @elastic/docs-freeze-team +docs/en/*.asciidoc @elastic/docs-freeze-team +docs/public/graph/*.asciidoc @elastic/docs-freeze-team +docs/public/marvel/*.asciidoc @elastic/docs-freeze-team +docs/public/reporting/*.asciidoc @elastic/docs-freeze-team +docs/public/shield/*.asciidoc @elastic/docs-freeze-team +docs/public/watcher/*.asciidoc @elastic/docs-freeze-team ``` ### [x-pack-elasticsearch](https://github.com/elastic/x-pack-elasticsearch) ``` -/docs/jp/*.asciidoc @docs-freeze-team -/docs/kr/*.asciidoc @docs-freeze-team -docs/en/*.asciidoc @docs-freeze-team -qa/sql/*.asciidoc @docs-freeze-team +/docs/jp/*.asciidoc @elastic/docs-freeze-team +/docs/kr/*.asciidoc @elastic/docs-freeze-team +docs/en/*.asciidoc @elastic/docs-freeze-team +qa/sql/*.asciidoc @elastic/docs-freeze-team ``` ### [x-pack-kibana](https://github.com/elastic/x-pack-kibana) ``` -/docs/kr/*.asciidoc @docs-freeze-team -docs/en/*.asciidoc @docs-freeze-team -docs/jp/*.asciidoc @docs-freeze-team +/docs/kr/*.asciidoc @elastic/docs-freeze-team +docs/en/*.asciidoc @elastic/docs-freeze-team +docs/jp/*.asciidoc @elastic/docs-freeze-team ``` ### [x-pack-logstash](https://github.com/elastic/x-pack-logstash) ``` -docs/en/*.asciidoc @docs-freeze-team +docs/en/*.asciidoc @elastic/docs-freeze-team ``` - From ae74b707da725a04351c88c0ffa6197627b96ab0 Mon Sep 17 00:00:00 2001 From: bmorelli25 Date: Fri, 10 Jan 2025 19:59:13 -0800 Subject: [PATCH 05/10] more cleanup --- docs/source/docset.yml | 21 +++-- docs/source/index.md | 10 +-- docs/source/migration/engineering.md | 20 +++++ .../migration/{ => freeze}/codeowner.md | 4 +- .../migration/{ => freeze}/gh-action.md | 2 +- docs/source/migration/freeze/index.md | 12 +++ .../scripts/attribute-converter/attr.py | 0 .../attribute-converter/attributes.asciidoc | 0 .../attribute-converter/attributes.yml | 0 .../scripts/codeowner-gen/codeowner.py | 0 .../scripts/codeowner-gen/conf.yaml | 0 .../scripts/codeowner-gen/output.md | 0 .../{ => freeze}/scripts/tab-converter/tab.py | 0 .../migration/{ => guide}/file-structure.md | 0 .../migration/{guide.md => guide/index.md} | 0 docs/source/migration/{ => guide}/mapping.md | 1 + .../{tabs.md => guide/migration-scripts.md} | 13 ++- docs/source/migration/ia.md | 20 +++++ docs/source/migration/index.md | 79 +++---------------- docs/source/migration/syntax.md | 14 ++++ docs/source/migration/versioning.md | 12 +++ 21 files changed, 122 insertions(+), 86 deletions(-) create mode 100644 docs/source/migration/engineering.md rename docs/source/migration/{ => freeze}/codeowner.md (91%) rename docs/source/migration/{ => freeze}/gh-action.md (97%) create mode 100644 docs/source/migration/freeze/index.md rename docs/source/migration/{ => freeze}/scripts/attribute-converter/attr.py (100%) rename docs/source/migration/{ => freeze}/scripts/attribute-converter/attributes.asciidoc (100%) rename docs/source/migration/{ => freeze}/scripts/attribute-converter/attributes.yml (100%) rename docs/source/migration/{ => freeze}/scripts/codeowner-gen/codeowner.py (100%) rename docs/source/migration/{ => freeze}/scripts/codeowner-gen/conf.yaml (100%) rename docs/source/migration/{ => freeze}/scripts/codeowner-gen/output.md (100%) rename docs/source/migration/{ => freeze}/scripts/tab-converter/tab.py (100%) rename docs/source/migration/{ => guide}/file-structure.md (100%) rename docs/source/migration/{guide.md => guide/index.md} (100%) rename docs/source/migration/{ => guide}/mapping.md (99%) rename docs/source/migration/{tabs.md => guide/migration-scripts.md} (88%) create mode 100644 docs/source/migration/ia.md create mode 100644 docs/source/migration/syntax.md create mode 100644 docs/source/migration/versioning.md diff --git a/docs/source/docset.yml b/docs/source/docset.yml index 4d2193a30..0842b1012 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -31,12 +31,21 @@ toc: - folder: migration children: - file: index.md - - file: guide.md - - file: file-structure.md - - file: mapping.md - - file: tabs.md - - file: gh-action.md - - file: codeowner.md + - folder: freeze + children: + - file: index.md + - file: codeowner.md + - file: gh-action.md + - file: syntax.md + - file: ia.md + - file: versioning.md + - file: engineering.md + - folder: guide + children: + - file: index.md + - file: file-structure.md + - file: mapping.md + - file: migration-scripts.md - folder: configure children: - file: index.md diff --git a/docs/source/index.md b/docs/source/index.md index ba93d473e..b04d69b88 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -6,11 +6,11 @@ Elastic Docs V3 is our next-generation documentation platform designed to improv **What do you want to do today?** -* [Contribute to Elastic documentation](/contribute/index.html) -* [Learn about migration to Elastic Docs V3](/migration/index.html) -* [Configure content sets in V3](/configure/index.html) -* [Learn about V3 syntax](/syntax/index.html) -* [Contribute to V3 (developer guide)](/development/index.html) +* [Contribute to Elastic documentation](./contribute/index.html) +* [Learn about migration to Elastic Docs V3](./migration/index.html) +* [Configure content sets in V3](./configure/index.html) +* [Learn about V3 syntax](./syntax/index.html) +* [Contribute to V3 (developer guide)](./development/index.md) ## About this repo diff --git a/docs/source/migration/engineering.md b/docs/source/migration/engineering.md new file mode 100644 index 000000000..4ed9a7564 --- /dev/null +++ b/docs/source/migration/engineering.md @@ -0,0 +1,20 @@ +--- +title: Reference docs guidelines +--- + +## Engineering ownership of reference documentation + +As part of the transition to Elastic Docs v3, responsibility for maintaining reference documentation will reside with Engineering teams so that code and corresponding documentation remain tightly integrated, allowing for easier updates and greater accuracy. + +After migration, all narrative and instructional documentation actively maintained by writers will move to the elastic/docs-content repository. Reference documentation, such as API specifications, will remain in the respective product repositories so that Engineering teams can manage both the code and its related documentation in one place. + +## API documentation guidelines + +To improve consistency and maintain high-quality reference documentation, all API documentation must adhere to the following standards: + +* **Switch to OAS (OpenAPI specification)**: Engineering teams should stop creating AsciiDoc-based API documentation. All API documentation should now use OAS files, alongside our API documentation that lives at elastic.co/docs/api. +* **Comprehensive API descriptions**: Ensure that OAS files include: + * API descriptions + * Request descriptions + * Response descriptions +* **Fix linting warnings**: Address all new and existing linting warnings in OAS files to maintain clean and consistent documentation. diff --git a/docs/source/migration/codeowner.md b/docs/source/migration/freeze/codeowner.md similarity index 91% rename from docs/source/migration/codeowner.md rename to docs/source/migration/freeze/codeowner.md index d5c6260e4..c4f7b20a5 100644 --- a/docs/source/migration/codeowner.md +++ b/docs/source/migration/freeze/codeowner.md @@ -1,5 +1,5 @@ --- -title: Documentation freeze CODEOWNERS +title: Codeowner --- This document lists the CODEOWNERS configuration used to enforce documentation freezes across Elastic repositories. During a documentation freeze, the `@docs-freeze-team` must approve any pull requests that modify documentation files (`.asciidoc`) before they can be merged. This prevents unintended documentation changes during crucial periods such as releases. @@ -7,7 +7,7 @@ This document lists the CODEOWNERS configuration used to enforce documentation f To regenerate this list, run the following commands from the repository root: ```sh -cd docs/source/migration/scripts/codeowner-gen +cd docs/source/migration/freeze/scripts/codeowner-gen python3 codeowner.py ``` diff --git a/docs/source/migration/gh-action.md b/docs/source/migration/freeze/gh-action.md similarity index 97% rename from docs/source/migration/gh-action.md rename to docs/source/migration/freeze/gh-action.md index c4fd06a33..7324fe43c 100644 --- a/docs/source/migration/gh-action.md +++ b/docs/source/migration/freeze/gh-action.md @@ -1,5 +1,5 @@ --- -title: Documentation Freeze GH Action +title: GH Action --- ## Overview diff --git a/docs/source/migration/freeze/index.md b/docs/source/migration/freeze/index.md new file mode 100644 index 000000000..f8ba70ad2 --- /dev/null +++ b/docs/source/migration/freeze/index.md @@ -0,0 +1,12 @@ +--- +title: Documentation Freeze +--- + +During the documentation freeze, the Docs team will focus almost entirely on migration tasks to ensure all content is successfully migrated and will handle only emergency documentation requests and release-related activities. When the migration is complete, writers will address documentation requests needed during the documentation freeze, ensuring that updates align with the new information architecture and format. + +To make the transition to Elastic Docs v3 as smooth as possible, we’ve established a process to track and manage documentation requests during the migration: + +* Open an issue in [elastic/docs-content](https://github.com/elastic/docs-content/issues), including details about the documentation requirements, links to resources, and drafts of documentation in GDocs. +* Post in [#docs](https://elastic.slack.com/archives/C0JF80CJZ) for emergency documentation requests. + +During the documentation freeze, maintaining consistency and avoiding conflicts is key. To prevent documentation changes from merging during the documentation freeze, [CODEOWNERS](./codeowner.md) and a [GH Action](./gh-action.md) are being added to /docs directories for public-facing documentation in all relevant repositories. \ No newline at end of file diff --git a/docs/source/migration/scripts/attribute-converter/attr.py b/docs/source/migration/freeze/scripts/attribute-converter/attr.py similarity index 100% rename from docs/source/migration/scripts/attribute-converter/attr.py rename to docs/source/migration/freeze/scripts/attribute-converter/attr.py diff --git a/docs/source/migration/scripts/attribute-converter/attributes.asciidoc b/docs/source/migration/freeze/scripts/attribute-converter/attributes.asciidoc similarity index 100% rename from docs/source/migration/scripts/attribute-converter/attributes.asciidoc rename to docs/source/migration/freeze/scripts/attribute-converter/attributes.asciidoc diff --git a/docs/source/migration/scripts/attribute-converter/attributes.yml b/docs/source/migration/freeze/scripts/attribute-converter/attributes.yml similarity index 100% rename from docs/source/migration/scripts/attribute-converter/attributes.yml rename to docs/source/migration/freeze/scripts/attribute-converter/attributes.yml diff --git a/docs/source/migration/scripts/codeowner-gen/codeowner.py b/docs/source/migration/freeze/scripts/codeowner-gen/codeowner.py similarity index 100% rename from docs/source/migration/scripts/codeowner-gen/codeowner.py rename to docs/source/migration/freeze/scripts/codeowner-gen/codeowner.py diff --git a/docs/source/migration/scripts/codeowner-gen/conf.yaml b/docs/source/migration/freeze/scripts/codeowner-gen/conf.yaml similarity index 100% rename from docs/source/migration/scripts/codeowner-gen/conf.yaml rename to docs/source/migration/freeze/scripts/codeowner-gen/conf.yaml diff --git a/docs/source/migration/scripts/codeowner-gen/output.md b/docs/source/migration/freeze/scripts/codeowner-gen/output.md similarity index 100% rename from docs/source/migration/scripts/codeowner-gen/output.md rename to docs/source/migration/freeze/scripts/codeowner-gen/output.md diff --git a/docs/source/migration/scripts/tab-converter/tab.py b/docs/source/migration/freeze/scripts/tab-converter/tab.py similarity index 100% rename from docs/source/migration/scripts/tab-converter/tab.py rename to docs/source/migration/freeze/scripts/tab-converter/tab.py diff --git a/docs/source/migration/file-structure.md b/docs/source/migration/guide/file-structure.md similarity index 100% rename from docs/source/migration/file-structure.md rename to docs/source/migration/guide/file-structure.md diff --git a/docs/source/migration/guide.md b/docs/source/migration/guide/index.md similarity index 100% rename from docs/source/migration/guide.md rename to docs/source/migration/guide/index.md diff --git a/docs/source/migration/mapping.md b/docs/source/migration/guide/mapping.md similarity index 99% rename from docs/source/migration/mapping.md rename to docs/source/migration/guide/mapping.md index f1999d9ea..4ead918fd 100644 --- a/docs/source/migration/mapping.md +++ b/docs/source/migration/guide/mapping.md @@ -1,5 +1,6 @@ --- title: Book to content set mapping +navigation_title: What books are migrating --- What full books are staying in Asciidoc? What books are migrating `main`/`master`? See the table below. diff --git a/docs/source/migration/tabs.md b/docs/source/migration/guide/migration-scripts.md similarity index 88% rename from docs/source/migration/tabs.md rename to docs/source/migration/guide/migration-scripts.md index c59221a46..f56fac213 100644 --- a/docs/source/migration/tabs.md +++ b/docs/source/migration/guide/migration-scripts.md @@ -1,14 +1,19 @@ --- -title: HTML to Markdown Tab Converter +title: Other migration scripts +navigation_title: Other scripts --- -### HTML to Markdown Tab Converter +:::{tip} +This page probably doesn't apply to you 😊 +::: + +## HTML to Markdown Tab Converter The tab converter script is used to convert HTML tabs into Markdown tabs within documentation files. The script scans through specified directories, finds all Markdown (`.md`) files, and replaces any HTML-based tab structures with their Markdown equivalents. **Note**: Running this script may or may not be necessary depending on the evolution of our migration tool. Use it as needed based on the current state of the documentation. -#### How to Run the Script +### How to Run the Script To execute the script and convert HTML tabs to Markdown tabs, follow these steps: @@ -36,7 +41,7 @@ To execute the script and convert HTML tabs to Markdown tabs, follow these steps This command processes all `.md` files within the `content/docs/` directory relative to the script's location. -#### Important Notes +### Important Notes - **Backup Your Files**: Before running the script, it's recommended to back up your Markdown files or ensure they are under version control (e.g., in a Git repository). This allows you to revert changes if necessary. - **Verify Changes**: After running the script, review the modified files to ensure that the tabs have been converted correctly. \ No newline at end of file diff --git a/docs/source/migration/ia.md b/docs/source/migration/ia.md new file mode 100644 index 000000000..72239dc8a --- /dev/null +++ b/docs/source/migration/ia.md @@ -0,0 +1,20 @@ +--- +title: Improved information architecture +navigation_title: New IA +--- + +The improved information architecture fundamentally transforms how we organize and present Elastic Docs. By addressing longstanding challenges—such as fragmented content across many books and duplicated information—this new structure introduces a cohesive framework that emphasizes clarity, usability, and alignment with user goals. These updates are designed to create a seamless experience for both readers and contributors, fostering greater understanding of our products and their benefits. + +The new IA design does the following: + +* Provides a clear narrative pathway for users to follow, including new topics that compare similar technologies and features. +* Organizes content by user goal and role. +* Consolidates content previously duplicated across our books, including serverless and stateful content, and many tasks that are common across deployment types and solutions. +* Explains the context a topic applies to (deployment type, version) - see Consolidated versioning below for more information. +* Separates reference content into its own section for easy access. + +To learn more: + +* Explore the new IA in detail in our [working doc](https://docs.google.com/spreadsheets/d/1LfPI3TZqdpONGxOmL8B8V-Feo1flLwObz9_ibCEMkIQ/edit?gid=502629814#gid=502629814). +* Learn about the general shape of the IA in our [expandable-collapsible view](https://checkvist.com/p/Nur1EAtMopm5gxry5AncM5) (does not represent all pages or guarantee final page locations). +* For more context on our IA design, including our guiding principles, refer to our [IA plan deck](https://docs.google.com/presentation/d/1e1QtEtLVCoFX0kCj02mkwxBrLSaCFyd8Nu6UlJkLP2c/edit#slide=id.g217776b7fee_0_916). \ No newline at end of file diff --git a/docs/source/migration/index.md b/docs/source/migration/index.md index 9eb21094c..095eafb1b 100644 --- a/docs/source/migration/index.md +++ b/docs/source/migration/index.md @@ -1,76 +1,19 @@ --- -title: "Migration to docs-builder: Key updates & timeline" +title: "Migration to docs-builder" navigation_title: Migration --- -:::{tip} -Want to learn _how_ to migrate? See the [migration guide](./guide.md). -::: - -## Documentation Freeze - -During the documentation freeze, the Docs team will focus almost entirely on migration tasks to ensure all content is successfully migrated and will handle only emergency documentation requests and release-related activities. When the migration is complete, writers will address documentation requests needed during the documentation freeze, ensuring that updates align with the new information architecture and format. - -To make the transition to Elastic Docs v3 as smooth as possible, we’ve established a process to track and manage documentation requests during the migration: - -* Open an issue in [elastic/docs-content](https://github.com/elastic/docs-content/issues), including details about the documentation requirements, links to resources, and drafts of documentation in GDocs. -* Post in [#docs](https://elastic.slack.com/archives/C0JF80CJZ) for emergency documentation requests. - -During the documentation freeze, maintaining consistency and avoiding conflicts is key. To prevent documentation changes from merging during the documentation freeze, [CODEOWNERS](./codeowner.md) and a [GH Action](./gh-action.md) are being added to /docs directories for public-facing documentation in all relevant repositories. - -## Improved information architecture - -The improved information architecture fundamentally transforms how we organize and present Elastic Docs. By addressing longstanding challenges—such as fragmented content across many books and duplicated information—this new structure introduces a cohesive framework that emphasizes clarity, usability, and alignment with user goals. These updates are designed to create a seamless experience for both readers and contributors, fostering greater understanding of our products and their benefits. - -The new IA design does the following: - -* Provides a clear narrative pathway for users to follow, including new topics that compare similar technologies and features. -* Organizes content by user goal and role. -* Consolidates content previously duplicated across our books, including serverless and stateful content, and many tasks that are common across deployment types and solutions. -* Explains the context a topic applies to (deployment type, version) - see Consolidated versioning below for more information. -* Separates reference content into its own section for easy access. - -To learn more: - -* Explore the new IA in detail in our [working doc](https://docs.google.com/spreadsheets/d/1LfPI3TZqdpONGxOmL8B8V-Feo1flLwObz9_ibCEMkIQ/edit?gid=502629814#gid=502629814). -* Learn about the general shape of the IA in our [expandable-collapsible view](https://checkvist.com/p/Nur1EAtMopm5gxry5AncM5) (does not represent all pages or guarantee final page locations). -* For more context on our IA design, including our guiding principles, refer to our [IA plan deck](https://docs.google.com/presentation/d/1e1QtEtLVCoFX0kCj02mkwxBrLSaCFyd8Nu6UlJkLP2c/edit#slide=id.g217776b7fee_0_916). - -## Consolidated versioning +We are ready to migrate our documentation to our new build system, [elastic/docs-builder](https://github.com/elastic/docs-builder)! -As part of the new information architecture, pages with varying versioning schemes are now interwoven, creating the opportunity and necessity to rethink the scope and versioning of each page. The previous approach of creating entirely separate docs sets for every minor version resulted in fragmentation and unnecessary duplication. Consolidating versioning resolves these issues while maintaining clarity and usability. - -To ensure a seamless experience for users and contributors, the new versioning approach adheres to the following: - -Context awareness — Each page explicitly states the context it applies to, including relevant deployment types (e.g., Elastic Cloud Hosted and Elastic Cloud Serverless) and versions. Context clarity ensures users know if the content is applicable to their environment. When users land on a Docs page that doesn’t apply to their version or deployment type, clear cues and instructions will guide them to the appropriate content. -Simplified contributor workflow — For pages that apply to multiple versions or deployment types, we’ve optimized the contributor experience by reducing complexity. Contributors can now manage multi-context content with ease, without duplicating information or navigating confusing workflows. - -For versioning plan details, check [Docs Versioning plan](https://docs.google.com/presentation/d/1fX8YBGcFlHJPi1kVfB9tC-988iUvxZJAZiH21kE4A5M/edit#slide=id.g319e4ce75b5_0_0). - -To learn how to callout versioning differences in docs-builder, see [product availability](../syntax/applies.md). - -## Transition from AsciiDoc to Markdown - -With the migration to Elastic Docs v3, the primary format for all Elastic Docs is transitioning from AsciiDoc to Markdown. Why Markdown? Markdown is already an industry standard across the industry, and 90% of Elastic developers are comfortable working with Markdown syntax [[source](https://docs.google.com/presentation/d/1morhFX4tyVB0A2f1_fnySzeJvPYf0kXGjVVYU_lVRys/edit#slide=id.g13b75c8f1f3_0_463)]. - -## How does this impact teams with automatically generated Docs? - -For teams that generate documentation programmatically, the transition means automatically generated files must now be output in Markdown format instead of AsciiDoc. This adjustment will require updating documentation generation pipelines, but it aligns with the broader benefits of a simpler and more extensible documentation framework. - -See our [syntax guide](../syntax/index.md) to learn more about the flavor of Markdown that we support. In addition, we're refining support for including YAML files directly in the docs. See [automated settings](../syntax/automated_settings.md) to learn more. - -## Engineering ownership of reference documentation - -As part of the transition to Elastic Docs v3, responsibility for maintaining reference documentation will reside with Engineering teams so that code and corresponding documentation remain tightly integrated, allowing for easier updates and greater accuracy. +:::{important} +We will enforce a [Documentation Freeze](./freeze/index.html) while we migration docs between our two build systems. +::: -After migration, all narrative and instructional documentation actively maintained by writers will move to the elastic/docs-content repository. Reference documentation, such as API specifications, will remain in the respective product repositories so that Engineering teams can manage both the code and its related documentation in one place. +Migrating to Elastic Docs V3 is more than just moving to a new documentation build system. This migration also includes: -## Guidelines for API documentation -To improve consistency and maintain high-quality reference documentation, all API documentation must adhere to the following standards: +* [Transition from AsciiDoc to Markdown](./syntax.md) +* [Improved information architecture](./ia.md) +* [Consolidated versioning](./versioning.md) +* [Engineering ownership of reference documentation & New API guidelines](./engineering.md) -* **Switch to OAS (OpenAPI specification)**: Engineering teams should stop creating AsciiDoc-based API documentation. All API documentation should now use OAS files, alongside our API documentation that lives at elastic.co/docs/api. -* **Comprehensive API descriptions**: Ensure that OAS files include: - * API descriptions - * Request descriptions - * Response descriptions -* **Fix linting warnings**: Address all new and existing linting warnings in OAS files to maintain clean and consistent documentation. \ No newline at end of file +View the [migration guide](./guide/index.md) to learn more about migration tooling, what content sets are migrating, how to migrate content, and more. \ No newline at end of file diff --git a/docs/source/migration/syntax.md b/docs/source/migration/syntax.md new file mode 100644 index 000000000..6d0563d4b --- /dev/null +++ b/docs/source/migration/syntax.md @@ -0,0 +1,14 @@ +--- +title: New syntax +navigation_title: New syntax +--- + +With the migration to Elastic Docs v3, the primary format for all Elastic Docs is transitioning from AsciiDoc to Markdown. Why Markdown? Markdown is already an industry standard across the industry, and 90% of Elastic developers are comfortable working with Markdown syntax [[source](https://docs.google.com/presentation/d/1morhFX4tyVB0A2f1_fnySzeJvPYf0kXGjVVYU_lVRys/edit#slide=id.g13b75c8f1f3_0_463)]. + +See our [syntax guide](../syntax/index.md) to learn more about the flavor of Markdown that we support. + +## How does this impact teams with automatically generated Docs? + +For teams that generate documentation programmatically, the transition means automatically generated files must now be output in Markdown format instead of AsciiDoc. This adjustment will require updating documentation generation pipelines, but it aligns with the broader benefits of a simpler and more extensible documentation framework. + +In addition, we're refining support for including YAML files directly in the docs. See [automated settings](../syntax/automated_settings.md) to learn more. \ No newline at end of file diff --git a/docs/source/migration/versioning.md b/docs/source/migration/versioning.md new file mode 100644 index 000000000..5cd6c95ac --- /dev/null +++ b/docs/source/migration/versioning.md @@ -0,0 +1,12 @@ +--- +title: Consolidated versioning +--- + +As part of the new information architecture, pages with varying versioning schemes are now interwoven, creating the opportunity and necessity to rethink the scope and versioning of each page. The previous approach of creating entirely separate docs sets for every minor version resulted in fragmentation and unnecessary duplication. Consolidating versioning resolves these issues while maintaining clarity and usability. + +To ensure a seamless experience for users and contributors, the new versioning approach adheres to the following: + +* Context awareness — Each page explicitly states the context it applies to, including relevant deployment types (e.g., Elastic Cloud Hosted and Elastic Cloud Serverless) and versions. Context clarity ensures users know if the content is applicable to their environment. When users land on a Docs page that doesn’t apply to their version or deployment type, clear cues and instructions will guide them to the appropriate content. +* Simplified contributor workflow — For pages that apply to multiple versions or deployment types, we’ve optimized the contributor experience by reducing complexity. Contributors can now manage multi-context content with ease, without duplicating information or navigating confusing workflows. + +For versioning plan details, check [Docs Versioning plan](https://docs.google.com/presentation/d/1fX8YBGcFlHJPi1kVfB9tC-988iUvxZJAZiH21kE4A5M/edit#slide=id.g319e4ce75b5_0_0). To learn how to call out versioning differences in docs-builder, see [product availability](../syntax/applies.md). \ No newline at end of file From 3a65c26cb08a7dd5c06267a0127eccf791413aba Mon Sep 17 00:00:00 2001 From: bmorelli25 Date: Fri, 10 Jan 2025 20:48:11 -0800 Subject: [PATCH 06/10] fix links --- docs/source/index.md | 8 ++++---- docs/source/migration/index.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/index.md b/docs/source/index.md index b04d69b88..40f903ccb 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -6,10 +6,10 @@ Elastic Docs V3 is our next-generation documentation platform designed to improv **What do you want to do today?** -* [Contribute to Elastic documentation](./contribute/index.html) -* [Learn about migration to Elastic Docs V3](./migration/index.html) -* [Configure content sets in V3](./configure/index.html) -* [Learn about V3 syntax](./syntax/index.html) +* [Contribute to Elastic documentation](./contribute/index.md) +* [Learn about migration to Elastic Docs V3](./migration/index.md) +* [Configure content sets in V3](./configure/index.md) +* [Learn about V3 syntax](./syntax/index.md) * [Contribute to V3 (developer guide)](./development/index.md) ## About this repo diff --git a/docs/source/migration/index.md b/docs/source/migration/index.md index 095eafb1b..ddcd545a8 100644 --- a/docs/source/migration/index.md +++ b/docs/source/migration/index.md @@ -6,7 +6,7 @@ navigation_title: Migration We are ready to migrate our documentation to our new build system, [elastic/docs-builder](https://github.com/elastic/docs-builder)! :::{important} -We will enforce a [Documentation Freeze](./freeze/index.html) while we migration docs between our two build systems. +We will enforce a [Documentation Freeze](./freeze/index.md) while we migration docs between our two build systems. ::: Migrating to Elastic Docs V3 is more than just moving to a new documentation build system. This migration also includes: From a8144b93260fb2fb0584e4870c807726435bd03f Mon Sep 17 00:00:00 2001 From: bmorelli25 Date: Fri, 10 Jan 2025 20:53:06 -0800 Subject: [PATCH 07/10] few more bugs --- docs/source/migration/guide/index.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/source/migration/guide/index.md b/docs/source/migration/guide/index.md index 2d42a6c16..54265cc8b 100644 --- a/docs/source/migration/guide/index.md +++ b/docs/source/migration/guide/index.md @@ -4,9 +4,8 @@ title: Migration Guide How to migrate content from Asciidoc to V3. -1. Clone https://github.com/elastic/adoc-to-md -2. Run the migration tool -3. Copy the output to the appropriate directory in https://github.com/elastic/docs-content -4. Update the `docset.yml` file to reflect the new IA of the content set -5. Build your changes with https://github.com/elastic/docs-builder -6. Open a PR and merge your changes \ No newline at end of file +## Migration tooling + +Use the [adoc-to-md](https://github.com/elastic/adoc-to-md) conversion tool to migrate content sets from Asciidoc syntax to docs-builder syntax. Instructions to use the tool are in the readme file. + +After running the migration tool, you can move, and manipulate files while viewing a live preview of the content with docs-builder. From 0aaab5fac15d0597ea2eb17b193b569e88492c9b Mon Sep 17 00:00:00 2001 From: bmorelli25 Date: Sun, 12 Jan 2025 18:04:05 -0800 Subject: [PATCH 08/10] remove tab script --- docs/source/docset.yml | 1 - .../freeze/scripts/tab-converter/tab.py | 64 ------------------- .../migration/guide/migration-scripts.md | 47 -------------- 3 files changed, 112 deletions(-) delete mode 100644 docs/source/migration/freeze/scripts/tab-converter/tab.py delete mode 100644 docs/source/migration/guide/migration-scripts.md diff --git a/docs/source/docset.yml b/docs/source/docset.yml index 0842b1012..66a8392e0 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -45,7 +45,6 @@ toc: - file: index.md - file: file-structure.md - file: mapping.md - - file: migration-scripts.md - folder: configure children: - file: index.md diff --git a/docs/source/migration/freeze/scripts/tab-converter/tab.py b/docs/source/migration/freeze/scripts/tab-converter/tab.py deleted file mode 100644 index 30e74b3bc..000000000 --- a/docs/source/migration/freeze/scripts/tab-converter/tab.py +++ /dev/null @@ -1,64 +0,0 @@ -import os -from pathlib import Path -import re -import argparse - -def extract_tab_info(html_content): - # Extract tab titles - button_pattern = r']*>\s*(.*?)\s*' - titles = re.findall(button_pattern, html_content, re.DOTALL) - - # Extract tab content - panel_pattern = r']*role="tabpanel"[^>]*>(.*?)' - contents = re.findall(panel_pattern, html_content, re.DOTALL) - - # Clean up the content (remove extra whitespace) - titles = [title.strip() for title in titles] - contents = [content.strip() for content in contents] - - return list(zip(titles, contents)) - -def html_to_md_tabs(html_content): - # Get tab information - tabs = extract_tab_info(html_content) - - # Generate markdown output - md_output = '::::{tab-set}\n\n' - - for title, content in tabs: - md_output += f":::{{tab-item}} {title}\n" # Fixed: Added curly braces - md_output += f"{content}\n" - md_output += ":::\n\n" - - md_output += "::::" - - return md_output - -def convert_file(file_path): - with open(file_path, 'r', encoding='utf-8') as file: - content = file.read() - - # Find tab sections - tab_pattern = r'
]*>.*?
\s*' - matches = re.findall(tab_pattern, content, re.DOTALL) - - if matches: - for match in matches: - md_tabs = html_to_md_tabs(match) - content = content.replace(match, md_tabs) - - with open(file_path, 'w', encoding='utf-8') as file: - file.write(content) - print(f"Converted HTML tabs in '{file_path}' to Markdown.") - -def main(): - parser = argparse.ArgumentParser(description='Convert HTML tabs to Markdown in .md files.') - parser.add_argument('-dir', type=str, required=True, help='Path to the directory containing Markdown files.') - args = parser.parse_args() - - # Walk through all .md files in the directory - for md_file in Path(args.dir).rglob('*.md'): - convert_file(md_file) - -if __name__ == "__main__": - main() diff --git a/docs/source/migration/guide/migration-scripts.md b/docs/source/migration/guide/migration-scripts.md deleted file mode 100644 index f56fac213..000000000 --- a/docs/source/migration/guide/migration-scripts.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Other migration scripts -navigation_title: Other scripts ---- - -:::{tip} -This page probably doesn't apply to you 😊 -::: - -## HTML to Markdown Tab Converter - -The tab converter script is used to convert HTML tabs into Markdown tabs within documentation files. The script scans through specified directories, finds all Markdown (`.md`) files, and replaces any HTML-based tab structures with their Markdown equivalents. - -**Note**: Running this script may or may not be necessary depending on the evolution of our migration tool. Use it as needed based on the current state of the documentation. - -### How to Run the Script - -To execute the script and convert HTML tabs to Markdown tabs, follow these steps: - -1. **Navigate to the Script Directory**: - - From the root of the repository, navigate to the tab converter script directory: - - ```sh - cd docs/source/migration/scripts/tab-converter - ``` - -2. **Run the Script**: - - Execute the script by pointing it to the directory containing the Markdown files you wish to process. Replace `/path/to/markdown/files` with the actual path to your Markdown files. - - ```sh - python3 tab_converter.py /path/to/markdown/files - ``` - - **Example**: - - ```sh - python3 tab_converter.py ../../../content/docs/ - ``` - - This command processes all `.md` files within the `content/docs/` directory relative to the script's location. - -### Important Notes - -- **Backup Your Files**: Before running the script, it's recommended to back up your Markdown files or ensure they are under version control (e.g., in a Git repository). This allows you to revert changes if necessary. -- **Verify Changes**: After running the script, review the modified files to ensure that the tabs have been converted correctly. \ No newline at end of file From 058df4bf173d51746ce92ce0fe90328d58e13c35 Mon Sep 17 00:00:00 2001 From: bmorelli25 Date: Mon, 13 Jan 2025 15:08:05 -0800 Subject: [PATCH 09/10] remove scripts --- docs/source/docset.yml | 1 - docs/source/migration/freeze/codeowner.md | 19 - docs/source/migration/freeze/gh-action.md | 4 + docs/source/migration/freeze/index.md | 2 +- .../scripts/attribute-converter/attr.py | 59 - .../attribute-converter/attributes.asciidoc | 579 ---- .../attribute-converter/attributes.yml | 494 --- .../freeze/scripts/codeowner-gen/codeowner.py | 114 - .../freeze/scripts/codeowner-gen/conf.yaml | 3022 ----------------- .../freeze/scripts/codeowner-gen/output.md | 576 ---- 10 files changed, 5 insertions(+), 4865 deletions(-) delete mode 100644 docs/source/migration/freeze/codeowner.md delete mode 100644 docs/source/migration/freeze/scripts/attribute-converter/attr.py delete mode 100644 docs/source/migration/freeze/scripts/attribute-converter/attributes.asciidoc delete mode 100644 docs/source/migration/freeze/scripts/attribute-converter/attributes.yml delete mode 100644 docs/source/migration/freeze/scripts/codeowner-gen/codeowner.py delete mode 100644 docs/source/migration/freeze/scripts/codeowner-gen/conf.yaml delete mode 100644 docs/source/migration/freeze/scripts/codeowner-gen/output.md diff --git a/docs/source/docset.yml b/docs/source/docset.yml index 66a8392e0..48819e782 100644 --- a/docs/source/docset.yml +++ b/docs/source/docset.yml @@ -34,7 +34,6 @@ toc: - folder: freeze children: - file: index.md - - file: codeowner.md - file: gh-action.md - file: syntax.md - file: ia.md diff --git a/docs/source/migration/freeze/codeowner.md b/docs/source/migration/freeze/codeowner.md deleted file mode 100644 index c4f7b20a5..000000000 --- a/docs/source/migration/freeze/codeowner.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Codeowner ---- - -This document lists the CODEOWNERS configuration used to enforce documentation freezes across Elastic repositories. During a documentation freeze, the `@docs-freeze-team` must approve any pull requests that modify documentation files (`.asciidoc`) before they can be merged. This prevents unintended documentation changes during crucial periods such as releases. - -To regenerate this list, run the following commands from the repository root: - -```sh -cd docs/source/migration/freeze/scripts/codeowner-gen -python3 codeowner.py -``` - -This will process `conf.yaml` and generate an updated `output.md` file containing the CODEOWNERS configuration for all repositories with documentation. The output is automatically included in this README. Note that the `conf.yaml` include in this repo should be replaced by a current version before running this script again. - -## Documentation source repositories - -:::{include} scripts/codeowner-gen/output.md -::: \ No newline at end of file diff --git a/docs/source/migration/freeze/gh-action.md b/docs/source/migration/freeze/gh-action.md index 7324fe43c..f1b4665d0 100644 --- a/docs/source/migration/freeze/gh-action.md +++ b/docs/source/migration/freeze/gh-action.md @@ -19,6 +19,10 @@ on: - synchronize - opened - reopened + branches: + - main + - master + - "9.0" jobs: comment-on-asciidoc-change: diff --git a/docs/source/migration/freeze/index.md b/docs/source/migration/freeze/index.md index f8ba70ad2..b9ecd423a 100644 --- a/docs/source/migration/freeze/index.md +++ b/docs/source/migration/freeze/index.md @@ -9,4 +9,4 @@ To make the transition to Elastic Docs v3 as smooth as possible, we’ve establi * Open an issue in [elastic/docs-content](https://github.com/elastic/docs-content/issues), including details about the documentation requirements, links to resources, and drafts of documentation in GDocs. * Post in [#docs](https://elastic.slack.com/archives/C0JF80CJZ) for emergency documentation requests. -During the documentation freeze, maintaining consistency and avoiding conflicts is key. To prevent documentation changes from merging during the documentation freeze, [CODEOWNERS](./codeowner.md) and a [GH Action](./gh-action.md) are being added to /docs directories for public-facing documentation in all relevant repositories. \ No newline at end of file +During the documentation freeze, maintaining consistency and avoiding conflicts is key. To prevent documentation changes from merging during the documentation freeze, a [GH Action](./gh-action.md) is being added to /docs directories for public-facing documentation in all relevant repositories. \ No newline at end of file diff --git a/docs/source/migration/freeze/scripts/attribute-converter/attr.py b/docs/source/migration/freeze/scripts/attribute-converter/attr.py deleted file mode 100644 index 205cbcc27..000000000 --- a/docs/source/migration/freeze/scripts/attribute-converter/attr.py +++ /dev/null @@ -1,59 +0,0 @@ -import re -import yaml - -def resolve_substitutions(subs, value): - """ - Resolves nested attributes within a value. - Replaces {VAR-NAME} with the corresponding value from subs. - If VAR-NAME is not found, replaces it with {{VAR-NAME}}. - """ - # Pattern to find all instances of {var-name} including those in URLs - pattern = re.compile(r'\{([\w-]+)\}') - - # Replace each variable in the text with its corresponding value - def replacement(match): - var_name = match.group(1) - if var_name in subs: - return subs[var_name] - else: - # Enclose unresolved variables in double curly braces - return f'{{{{{var_name}}}}}' - - # Apply substitution to the value - return pattern.sub(replacement, value) - -def parse_asciidoc(file_path): - """ - Parses the AsciiDoc file and extracts key-value pairs. - Handles lines in the format :key: value. - """ - subs = {} - pattern = re.compile(r'^:([\w-]+):\s+(.+)$') - - with open(file_path, 'r') as file: - lines = file.readlines() - - for line in lines: - match = pattern.match(line) - if match: - key = match.group(1).strip() - value = match.group(2).strip() - subs[key] = value - - # Resolve substitutions for all keys - resolved_subs = {key: resolve_substitutions(subs, value) for key, value in subs.items()} - return resolved_subs - -def write_yaml(subs, output_file): - """ - Writes the substitutions dictionary to a YAML file under the 'subs' key. - """ - with open(output_file, 'w') as file: - yaml.dump({'subs': subs}, file, default_flow_style=False, sort_keys=False, allow_unicode=True) - -if __name__ == "__main__": - input_file = 'attributes.asciidoc' - output_file = 'attributes.yml' - subs = parse_asciidoc(input_file) - write_yaml(subs, output_file) - print(f'Output written to {output_file}') diff --git a/docs/source/migration/freeze/scripts/attribute-converter/attributes.asciidoc b/docs/source/migration/freeze/scripts/attribute-converter/attributes.asciidoc deleted file mode 100644 index bf536118e..000000000 --- a/docs/source/migration/freeze/scripts/attribute-converter/attributes.asciidoc +++ /dev/null @@ -1,579 +0,0 @@ -:ref: https://www.elastic.co/guide/en/elasticsearch/reference/{branch} -:ref-bare: https://www.elastic.co/guide/en/elasticsearch/reference -:ref-8x: https://www.elastic.co/guide/en/elasticsearch/reference/8.1 -:ref-80: https://www.elastic.co/guide/en/elasticsearch/reference/8.0 -:ref-7x: https://www.elastic.co/guide/en/elasticsearch/reference/7.17 -:ref-70: https://www.elastic.co/guide/en/elasticsearch/reference/7.0 -:ref-60: https://www.elastic.co/guide/en/elasticsearch/reference/6.0 -:ref-64: https://www.elastic.co/guide/en/elasticsearch/reference/6.4 -:xpack-ref: https://www.elastic.co/guide/en/x-pack/6.2 -:logstash-ref: https://www.elastic.co/guide/en/logstash/{branch} -:kibana-ref: https://www.elastic.co/guide/en/kibana/{branch} -:kibana-ref-all: https://www.elastic.co/guide/en/kibana -:beats-ref-root: https://www.elastic.co/guide/en/beats -:beats-ref: https://www.elastic.co/guide/en/beats/libbeat/{branch} -:beats-ref-60: https://www.elastic.co/guide/en/beats/libbeat/6.0 -:beats-ref-63: https://www.elastic.co/guide/en/beats/libbeat/6.3 -:beats-devguide: https://www.elastic.co/guide/en/beats/devguide/{branch} -:auditbeat-ref: https://www.elastic.co/guide/en/beats/auditbeat/{branch} -:packetbeat-ref: https://www.elastic.co/guide/en/beats/packetbeat/{branch} -:metricbeat-ref: https://www.elastic.co/guide/en/beats/metricbeat/{branch} -:filebeat-ref: https://www.elastic.co/guide/en/beats/filebeat/{branch} -:functionbeat-ref: https://www.elastic.co/guide/en/beats/functionbeat/{branch} -:winlogbeat-ref: https://www.elastic.co/guide/en/beats/winlogbeat/{branch} -:heartbeat-ref: https://www.elastic.co/guide/en/beats/heartbeat/{branch} -:journalbeat-ref: https://www.elastic.co/guide/en/beats/journalbeat/{branch} -:ingest-guide: https://www.elastic.co/guide/en/ingest/{branch} -:fleet-guide: https://www.elastic.co/guide/en/fleet/{branch} -:apm-guide-ref: https://www.elastic.co/guide/en/apm/guide/{branch} -:apm-guide-7x: https://www.elastic.co/guide/en/apm/guide/7.17 -:apm-app-ref: https://www.elastic.co/guide/en/kibana/{branch} -:apm-agents-ref: https://www.elastic.co/guide/en/apm/agent -:apm-android-ref: https://www.elastic.co/guide/en/apm/agent/android/current -:apm-py-ref: https://www.elastic.co/guide/en/apm/agent/python/current -:apm-py-ref-3x: https://www.elastic.co/guide/en/apm/agent/python/3.x -:apm-node-ref-index: https://www.elastic.co/guide/en/apm/agent/nodejs -:apm-node-ref: https://www.elastic.co/guide/en/apm/agent/nodejs/current -:apm-node-ref-1x: https://www.elastic.co/guide/en/apm/agent/nodejs/1.x -:apm-rum-ref: https://www.elastic.co/guide/en/apm/agent/rum-js/current -:apm-ruby-ref: https://www.elastic.co/guide/en/apm/agent/ruby/current -:apm-java-ref: https://www.elastic.co/guide/en/apm/agent/java/current -:apm-go-ref: https://www.elastic.co/guide/en/apm/agent/go/current -:apm-dotnet-ref: https://www.elastic.co/guide/en/apm/agent/dotnet/current -:apm-php-ref: https://www.elastic.co/guide/en/apm/agent/php/current -:apm-ios-ref: https://www.elastic.co/guide/en/apm/agent/swift/current -:apm-lambda-ref: https://www.elastic.co/guide/en/apm/lambda/current -:apm-attacher-ref: https://www.elastic.co/guide/en/apm/attacher/current -:docker-logging-ref: https://www.elastic.co/guide/en/beats/loggingplugin/{branch} -:esf-ref: https://www.elastic.co/guide/en/esf/{esf_version} -:kinesis-firehose-ref: https://www.elastic.co/guide/en/kinesis/{kinesis_version} -/////// -Elastic-level pages -/////// -:estc-welcome-current: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current -:estc-welcome: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/{branch} -:estc-welcome-all: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions -:hadoop-ref: https://www.elastic.co/guide/en/elasticsearch/hadoop/{branch} -:stack-ref: https://www.elastic.co/guide/en/elastic-stack/{branch} -:stack-ref-67: https://www.elastic.co/guide/en/elastic-stack/6.7 -:stack-ref-68: https://www.elastic.co/guide/en/elastic-stack/6.8 -:stack-ref-70: https://www.elastic.co/guide/en/elastic-stack/7.0 -:stack-ref-80: https://www.elastic.co/guide/en/elastic-stack/8.0 -:stack-ov: https://www.elastic.co/guide/en/elastic-stack-overview/{branch} -:stack-gs: https://www.elastic.co/guide/en/elastic-stack-get-started/{branch} -:stack-gs-current: https://www.elastic.co/guide/en/elastic-stack-get-started/current -:javaclient: https://www.elastic.co/guide/en/elasticsearch/client/java-api/{branch} -:java-api-client: https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/{branch} -:java-rest: https://www.elastic.co/guide/en/elasticsearch/client/java-rest/{branch} -:jsclient: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/{branch} -:jsclient-current: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current -:es-ruby-client: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/{branch} -:es-dotnet-client: https://www.elastic.co/guide/en/elasticsearch/client/net-api/{branch} -:es-php-client: https://www.elastic.co/guide/en/elasticsearch/client/php-api/{branch} -:es-python-client: https://www.elastic.co/guide/en/elasticsearch/client/python-api/{branch} -:defguide: https://www.elastic.co/guide/en/elasticsearch/guide/2.x -:painless: https://www.elastic.co/guide/en/elasticsearch/painless/{branch} -:plugins: https://www.elastic.co/guide/en/elasticsearch/plugins/{branch} -:plugins-8x: https://www.elastic.co/guide/en/elasticsearch/plugins/8.1 -:plugins-7x: https://www.elastic.co/guide/en/elasticsearch/plugins/7.17 -:plugins-6x: https://www.elastic.co/guide/en/elasticsearch/plugins/6.8 -:glossary: https://www.elastic.co/guide/en/elastic-stack-glossary/current -:upgrade_guide: https://www.elastic.co/products/upgrade_guide -:blog-ref: https://www.elastic.co/blog/ -:curator-ref: https://www.elastic.co/guide/en/elasticsearch/client/curator/{branch} -:curator-ref-current: https://www.elastic.co/guide/en/elasticsearch/client/curator/current -:metrics-ref: https://www.elastic.co/guide/en/metrics/{branch} -:metrics-guide: https://www.elastic.co/guide/en/metrics/guide/{branch} -:logs-ref: https://www.elastic.co/guide/en/logs/{branch} -:logs-guide: https://www.elastic.co/guide/en/logs/guide/{branch} -:uptime-guide: https://www.elastic.co/guide/en/uptime/{branch} -:observability-guide: https://www.elastic.co/guide/en/observability/{branch} -:observability-guide-all: https://www.elastic.co/guide/en/observability -:siem-guide: https://www.elastic.co/guide/en/siem/guide/{branch} -:security-guide: https://www.elastic.co/guide/en/security/{branch} -:security-guide-all: https://www.elastic.co/guide/en/security -:endpoint-guide: https://www.elastic.co/guide/en/endpoint/{branch} -:sql-odbc: https://www.elastic.co/guide/en/elasticsearch/sql-odbc/{branch} -:ecs-ref: https://www.elastic.co/guide/en/ecs/{ecs_version} -:ecs-logging-ref: https://www.elastic.co/guide/en/ecs-logging/overview/{ecs-logging} -:ecs-logging-go-logrus-ref: https://www.elastic.co/guide/en/ecs-logging/go-logrus/{ecs-logging-go-logrus} -:ecs-logging-go-zap-ref: https://www.elastic.co/guide/en/ecs-logging/go-zap/{ecs-logging-go-zap} -:ecs-logging-go-zerolog-ref: https://www.elastic.co/guide/en/ecs-logging/go-zap/{ecs-logging-go-zerolog} -:ecs-logging-java-ref: https://www.elastic.co/guide/en/ecs-logging/java/{ecs-logging-java} -:ecs-logging-dotnet-ref: https://www.elastic.co/guide/en/ecs-logging/dotnet/{ecs-logging-dotnet} -:ecs-logging-nodejs-ref: https://www.elastic.co/guide/en/ecs-logging/nodejs/{ecs-logging-nodejs} -:ecs-logging-php-ref: https://www.elastic.co/guide/en/ecs-logging/php/{ecs-logging-php} -:ecs-logging-python-ref: https://www.elastic.co/guide/en/ecs-logging/python/{ecs-logging-python} -:ecs-logging-ruby-ref: https://www.elastic.co/guide/en/ecs-logging/ruby/{ecs-logging-ruby} -:ml-docs: https://www.elastic.co/guide/en/machine-learning/{branch} -:eland-docs: https://www.elastic.co/guide/en/elasticsearch/client/eland/current -:eql-ref: https://eql.readthedocs.io/en/latest/query-guide -:subscriptions: https://www.elastic.co/subscriptions -:extendtrial: https://www.elastic.co/trialextension -:wikipedia: https://en.wikipedia.org/wiki -:forum: https://discuss.elastic.co/ -:xpack-forum: https://discuss.elastic.co/c/50-x-pack -:security-forum: https://discuss.elastic.co/c/x-pack/shield -:watcher-forum: https://discuss.elastic.co/c/x-pack/watcher -:monitoring-forum: https://discuss.elastic.co/c/x-pack/marvel -:graph-forum: https://discuss.elastic.co/c/x-pack/graph -:apm-forum: https://discuss.elastic.co/c/apm -:enterprise-search-ref: https://www.elastic.co/guide/en/enterprise-search/{branch} -:app-search-ref: https://www.elastic.co/guide/en/app-search/{branch} -:workplace-search-ref: https://www.elastic.co/guide/en/workplace-search/{branch} -:enterprise-search-node-ref: https://www.elastic.co/guide/en/enterprise-search-clients/enterprise-search-node/{branch} -:enterprise-search-php-ref: https://www.elastic.co/guide/en/enterprise-search-clients/php/{branch} -:enterprise-search-python-ref: https://www.elastic.co/guide/en/enterprise-search-clients/python/{branch} -:enterprise-search-ruby-ref: https://www.elastic.co/guide/en/enterprise-search-clients/ruby/{branch} -:elastic-maps-service: https://maps.elastic.co -:integrations-docs: https://docs.elastic.co/en/integrations -:integrations-devguide: https://www.elastic.co/guide/en/integrations-developer/current -:time-units: {ref}/api-conventions.html#time-units -:byte-units: {ref}/api-conventions.html#byte-units - -////////// -APM agents -The if directives below are required for versions 6.3-7.4 of the legacy APM Get started book. -Without these if directives, the links below fail and break the build. -////////// - -ifdef::apm-py-branch[] -:apm-py-ref-v: https://www.elastic.co/guide/en/apm/agent/python/{apm-py-branch} -endif::[] - -ifdef::apm-node-branch[] -:apm-node-ref-v: https://www.elastic.co/guide/en/apm/agent/nodejs/{apm-node-branch} -endif::[] - -ifdef::apm-rum-branch[] -:apm-rum-ref-v: https://www.elastic.co/guide/en/apm/agent/rum-js/{apm-rum-branch} -endif::[] - -ifdef::apm-ruby-branch[] -:apm-ruby-ref-v: https://www.elastic.co/guide/en/apm/agent/ruby/{apm-ruby-branch} -endif::[] - -ifdef::apm-java-branch[] -:apm-java-ref-v: https://www.elastic.co/guide/en/apm/agent/java/{apm-java-branch} -endif::[] - -ifdef::apm-go-branch[] -:apm-go-ref-v: https://www.elastic.co/guide/en/apm/agent/go/{apm-go-branch} -endif::[] - -ifdef::apm-ios-branch[] -:apm-ios-ref-v: https://www.elastic.co/guide/en/apm/agent/swift/{apm-ios-branch} -endif::[] - -ifdef::apm-dotnet-branch[] -:apm-dotnet-ref-v: https://www.elastic.co/guide/en/apm/agent/dotnet/{apm-dotnet-branch} -endif::[] - -ifdef::apm-php-branch[] -:apm-php-ref-v: https://www.elastic.co/guide/en/apm/agent/php/{apm-php-branch} -endif::[] - -////////// -Elastic Cloud -////////// -:ecloud: Elastic Cloud -:esf: Elastic Serverless Forwarder -:ess: Elasticsearch Service -:ece: Elastic Cloud Enterprise -:eck: Elastic Cloud on Kubernetes -:serverless-full: Elastic Cloud Serverless -:serverless-short: Serverless -:es-serverless: Elasticsearch Serverless -:es3: {es-serverless} -:obs-serverless: Elastic Observability Serverless -:sec-serverless: Elastic Security Serverless -:serverless-docs: https://docs.elastic.co/serverless -:cloud: https://www.elastic.co/guide/en/cloud/current -:ess-utm-params: ?page=docs&placement=docs-body -:ess-baymax: {ess-utm-params} -:ess-trial: https://cloud.elastic.co/registration{ess-utm-params} -:ess-product: https://www.elastic.co/cloud/elasticsearch-service{ess-utm-params} -:ess-console: https://cloud.elastic.co{ess-utm-params} -:ess-console-name: {ess} Console -:ess-deployments: https://cloud.elastic.co/deployments{ess-utm-params} -:ece-ref: https://www.elastic.co/guide/en/cloud-enterprise/{ece-version-link} -:eck-ref: https://www.elastic.co/guide/en/cloud-on-k8s/current -:ess-leadin: You can run Elasticsearch on your own hardware or use our hosted Elasticsearch Service that is available on AWS, GCP, and Azure. {ess-trial}[Try the Elasticsearch Service for free]. -:ess-leadin-short: Our hosted Elasticsearch Service is available on AWS, GCP, and Azure, and you can {ess-trial}[try it for free]. -:ess-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link="{ess-trial}", title="Supported on {ess}"] -:ece-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud_ece.svg[link="{ess-trial}", title="Supported on {ece}"] -:cloud-only: This feature is designed for indirect use by {ess-trial}[{ess}], {ece-ref}[{ece}], and {eck-ref}[{eck}]. Direct use is not supported. -:ess-setting-change: {ess-icon} indicates a change to a supported {cloud}/ec-add-user-settings.html[user setting] for {ess}. -:ess-skip-section: If you use {ess}, skip this section. {ess} handles these changes for you. -:api-cloud: https://www.elastic.co/docs/api/doc/cloud -:api-ece: https://www.elastic.co/docs/api/doc/cloud-enterprise -:api-kibana-serverless: https://www.elastic.co/docs/api/doc/serverless -////////// -Elasticsearch -////////// - -:es-feature-flag: This feature is in development and not yet available for use. This documentation is provided for informational purposes only. - -////////// -Commonly referenced paths in commonly referenced repositories. -////////// -ifdef::elasticsearch-root[] -:es-ref-dir: {elasticsearch-root}/docs/reference -endif::elasticsearch-root[] -////////// -Kibana app and UI names -////////// - -:apm-app: APM app -:uptime-app: Uptime app -:synthetics-app: Synthetics app -:logs-app: Logs app -:metrics-app: Metrics app -:infrastructure-app: Infrastructure app -:siem-app: SIEM app -:security-app: Elastic Security app -:ml-app: Machine Learning -:dev-tools-app: Dev Tools -:ingest-manager-app: Ingest Manager -:stack-manage-app: Stack Management -:stack-monitor-app: Stack Monitoring -:alerts-ui: Alerts and Actions -:rules-ui: Rules -:rac-ui: Rules and Connectors -:connectors-ui: Connectors -:connectors-feature: Actions and Connectors -:stack-rules-feature: Stack Rules -:user-experience: User Experience -:ems: Elastic Maps Service -:ems-init: EMS -:hosted-ems: Elastic Maps Server -:ipm-app: Index Pattern Management -:ingest-pipelines: ingest pipelines -:ingest-pipelines-app: Ingest Pipelines -:ingest-pipelines-cap: Ingest pipelines -:ls-pipelines: Logstash pipelines -:ls-pipelines-app: Logstash Pipelines -:maint-windows: maintenance windows -:maint-windows-app: Maintenance Windows -:maint-windows-cap: Maintenance windows -:custom-roles-app: Custom Roles -:data-source: data view -:data-sources: data views -:data-source-caps: Data View -:data-sources-caps: Data Views -:data-source-cap: Data view -:data-sources-cap: Data views -:project-settings: Project settings -:manage-app: Management -:index-manage-app: Index Management -:data-views-app: Data Views -:rules-app: Rules -:saved-objects-app: Saved Objects -:tags-app: Tags -:api-keys-app: API keys -:transforms-app: Transforms -:connectors-app: Connectors -:files-app: Files -:reports-app: Reports -:maps-app: Maps -:alerts-app: Alerts -// Use data-source-cap instead of Data-source -// Use data-sources-cap instead of Data-sources -// Use data-sources-caps instead of Data-Sources - -////////// -Enterprise Search -////////// - -:crawler: Enterprise Search web crawler -:ents: Enterprise Search -:app-search-crawler: App Search web crawler - -////////// -Ingest terms -////////// - -:agent: Elastic Agent -:agents: Elastic Agents -:fleet: Fleet -:fleet-server: Fleet Server -:integrations-server: Integrations Server -:ingest-manager: Ingest Manager -:ingest-management: ingest management -:package-manager: Elastic Package Manager -:integrations: Integrations -:package-registry: Elastic Package Registry -:artifact-registry: Elastic Artifact Registry - -////////// -Common words and phrases -////////// -:aws: AWS -:stack: Elastic Stack -:xpack: X-Pack -:es: Elasticsearch -:kib: Kibana -:esms: {stack} Monitoring Service -:esms-init: ESMS -:ls: Logstash -:beats: Beats -:auditbeat: Auditbeat -:filebeat: Filebeat -:heartbeat: Heartbeat -:metricbeat: Metricbeat -:packetbeat: Packetbeat -:winlogbeat: Winlogbeat -:functionbeat: Functionbeat -:journalbeat: Journalbeat -:es-sql: {es} SQL -:esql: ES|QL -:elastic-agent: {agent} -:k8s: Kubernetes -:log-driver-long: Elastic Logging Plugin for Docker - -:security: X-Pack security -:security-features: security features -:operator-feature: operator privileges feature -:es-security-features: {es} {security-features} -:stack-security-features: {stack} {security-features} -:endpoint-sec: Endpoint Security -////////// -Do not use `endpoint-sec` in versions 8.3.0 and newer -Do not use `endpoint-cloud-sec` in versions 8.5.0 and newer -////////// -:endpoint-cloud-sec: Endpoint and Cloud Security -:elastic-defend: Elastic Defend -:elastic-sec: Elastic Security -:elastic-endpoint: Elastic Endpoint -:swimlane: Swimlane -:sn: ServiceNow -:sn-itsm: ServiceNow ITSM -:sn-itom: ServiceNow ITOM -:sn-sir: ServiceNow SecOps -:jira: Jira -:ibm-r: IBM Resilient -:webhook: Webhook -:webhook-cm: {webhook} - Case Management -:opsgenie: Opsgenie -:bedrock: Amazon Bedrock -:gemini: Google Gemini -:hive: TheHive -:monitoring: X-Pack monitoring -:monitor-features: monitoring features -:stack-monitor-features: {stack} {monitor-features} -:watcher: Watcher -:alert-features: alerting features -:reporting: X-Pack reporting -:report-features: reporting features -:graph: X-Pack graph -:graph-features: graph analytics features -:searchprofiler: Search Profiler -:xpackml: X-Pack machine learning -:ml: machine learning -:ml-cap: Machine learning -:ml-init: ML -:ml-features: machine learning features -:stack-ml-features: {stack} {ml-features} -:ccr: cross-cluster replication -:ccr-cap: Cross-cluster replication -:ccr-init: CCR -:ccs: cross-cluster search -:ccs-cap: Cross-cluster search -:ccs-init: CCS -:ilm: index lifecycle management -:ilm-cap: Index lifecycle management -:ilm-init: ILM -:dlm: data lifecycle management -:dlm-cap: Data lifecycle management -:dlm-init: DLM -:search-snap: searchable snapshot -:search-snaps: searchable snapshots -:search-snaps-cap: Searchable snapshots -:slm: snapshot lifecycle management -:slm-cap: Snapshot lifecycle management -:slm-init: SLM -:rollup-features: data rollup features -:ipm: index pattern management -:ipm-cap: Index pattern - -:rollup: rollup -:rollup-cap: Rollup -:rollups: rollups -:rollups-cap: Rollups -:rollup-job: {rollup} job -:rollup-jobs: {rollup} jobs -:rollup-jobs-cap: {rollup-cap} jobs -:dfeed: datafeed -:dfeeds: datafeeds -:dfeed-cap: Datafeed -:dfeeds-cap: Datafeeds -:ml-jobs: {ml} jobs -:ml-jobs-cap: {ml-cap} jobs -:anomaly-detect: anomaly detection -:anomaly-detect-cap: Anomaly detection -:anomaly-job: {anomaly-detect} job -:anomaly-jobs: {anomaly-detect} jobs -:anomaly-jobs-cap: {anomaly-detect-cap} jobs -:dataframe: data frame -:dataframes: data frames -:dataframe-cap: Data frame -:dataframes-cap: Data frames -:watcher-transform: payload transform -:watcher-transforms: payload transforms -:watcher-transform-cap: Payload transform -:watcher-transforms-cap: Payload transforms -:transform: transform -:transforms: transforms -:transform-cap: Transform -:transforms-cap: Transforms -:dataframe-transform: {transform} -:dataframe-transform-cap: {transform-cap} -:dataframe-transforms: {transforms} -:dataframe-transforms-cap: {transforms-cap} -:dfanalytics-cap: {dataframe-cap} analytics -:dfanalytics: {dataframe} analytics -:dataframe-analytics-config: {dfanalytics} config -:dfanalytics-job: {dfanalytics} job -:dfanalytics-jobs: {dfanalytics} jobs -:dfanalytics-jobs-cap: {dfanalytics-cap} jobs -:cdataframe: continuous {dataframe} -:cdataframes: continuous {dataframes} -:cdataframe-cap: Continuous {dataframe} -:cdataframes-cap: Continuous {dataframes} -:cdataframe-transform: continuous {transform} -:cdataframe-transforms: continuous {transforms} -:cdataframe-transforms-cap: Continuous {transforms} -:ctransform: continuous {transform} -:ctransform-cap: Continuous {transform} -:ctransforms: continuous {transforms} -:ctransforms-cap: Continuous {transforms} -:oldetection: outlier detection -:oldetection-cap: Outlier detection -:olscore: outlier score -:olscores: outlier scores -:fiscore: feature influence score -:evaluatedf-api: evaluate {dfanalytics} API -:evaluatedf-api-cap: Evaluate {dfanalytics} API -:binarysc: binary soft classification -:binarysc-cap: Binary soft classification -:regression: regression -:regression-cap: Regression -:reganalysis: regression analysis -:reganalysis-cap: Regression analysis -:depvar: dependent variable -:feature-var: feature variable -:feature-vars: feature variables -:feature-vars-cap: Feature variables -:classification: classification -:classification-cap: Classification -:classanalysis: classification analysis -:classanalysis-cap: Classification analysis -:infer-cap: Inference -:infer: inference -:lang-ident-cap: Language identification -:lang-ident: language identification -:data-viz: Data Visualizer -:file-data-viz: File Data Visualizer -:feat-imp: feature importance -:feat-imp-cap: Feature importance -:nlp: natural language processing -:nlp-cap: Natural language processing - -:apm-agent: APM agent -:apm-go-agent: Elastic APM Go agent -:apm-go-agents: Elastic APM Go agents -:apm-ios-agent: Elastic APM iOS agent -:apm-ios-agents: Elastic APM iOS agents -:apm-java-agent: Elastic APM Java agent -:apm-java-agents: Elastic APM Java agents -:apm-dotnet-agent: Elastic APM .NET agent -:apm-dotnet-agents: Elastic APM .NET agents -:apm-node-agent: Elastic APM Node.js agent -:apm-node-agents: Elastic APM Node.js agents -:apm-php-agent: Elastic APM PHP agent -:apm-php-agents: Elastic APM PHP agents -:apm-py-agent: Elastic APM Python agent -:apm-py-agents: Elastic APM Python agents -:apm-ruby-agent: Elastic APM Ruby agent -:apm-ruby-agents: Elastic APM Ruby agents -:apm-rum-agent: Elastic APM Real User Monitoring (RUM) JavaScript agent -:apm-rum-agents: Elastic APM RUM JavaScript agents -:apm-lambda-ext: Elastic APM AWS Lambda extension - -:project-monitors: project monitors -:project-monitors-cap: Project monitors -:private-location: Private Location -:private-locations: Private Locations - -:pwd: YOUR_PASSWORD - -:esh: ES-Hadoop - -:default-dist: default distribution -:oss-dist: OSS-only distribution -:observability: Observability - -:api-request-title: Request -:api-prereq-title: Prerequisites -:api-description-title: Description -:api-path-parms-title: Path parameters -:api-query-parms-title: Query parameters -:api-request-body-title: Request body -:api-response-codes-title: Response codes -:api-response-body-title: Response body -:api-example-title: Example -:api-examples-title: Examples -:api-definitions-title: Properties - -:multi-arg: †footnoteref:[multi-arg,This parameter accepts multiple arguments.] -:multi-arg-ref: †footnoteref:[multi-arg] - -////////// -Reusable images -////////// -:yes-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png[Yes,20,15] -:no-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png[No,20,15] - -////////// -Issue and pull request URLs -////////// -:es-repo: https://github.com/elastic/elasticsearch/ -:es-issue: {es-repo}issues/ -:es-pull: {es-repo}pull/ -:es-commit: {es-repo}commit/ -:kib-repo: https://github.com/elastic/kibana/ -:kib-issue: {kib-repo}issues/ -:kibana-issue: {kib-issue} -:kib-pull: {kib-repo}pull/ -:kibana-pull: {kib-pull} -:kib-commit: {kib-repo}commit/ -:ml-repo: https://github.com/elastic/ml-cpp/ -:ml-issue: {ml-repo}issues/ -:ml-pull: {ml-repo}pull/ -:ml-commit: {ml-repo}commit/ -:apm-repo: https://github.com/elastic/apm-server/ -:apm-issue: {apm-repo}issues/ -:apm-pull: {apm-repo}pull/ -:kibana-blob: {kib-repo}blob/{branch}/ -////////// -Legacy definitions -////////// -:apm-get-started-ref: https://www.elastic.co/guide/en/apm/get-started/{branch} -:apm-server-ref: https://www.elastic.co/guide/en/apm/server/{branch} -:apm-server-ref-v: https://www.elastic.co/guide/en/apm/server/{branch} -:apm-server-ref-m: https://www.elastic.co/guide/en/apm/server/master -:apm-server-ref-62: https://www.elastic.co/guide/en/apm/server/6.2 -:apm-server-ref-64: https://www.elastic.co/guide/en/apm/server/6.4 -:apm-server-ref-70: https://www.elastic.co/guide/en/apm/server/7.0 -:apm-overview-ref-v: https://www.elastic.co/guide/en/apm/get-started/{branch} -:apm-overview-ref-70: https://www.elastic.co/guide/en/apm/get-started/7.0 -:apm-overview-ref-m: https://www.elastic.co/guide/en/apm/get-started/master -:infra-guide: https://www.elastic.co/guide/en/infrastructure/guide/{branch} -:a-data-source: a data view - -//// -UI icons and logos from EUI -//// -:icon-bug: pass:[] -:icon-checkInCircleFilled: pass:[] -:icon-warningFilled: pass:[] diff --git a/docs/source/migration/freeze/scripts/attribute-converter/attributes.yml b/docs/source/migration/freeze/scripts/attribute-converter/attributes.yml deleted file mode 100644 index 0fcf37e61..000000000 --- a/docs/source/migration/freeze/scripts/attribute-converter/attributes.yml +++ /dev/null @@ -1,494 +0,0 @@ -subs: - ref: https://www.elastic.co/guide/en/elasticsearch/reference/current - ref-bare: https://www.elastic.co/guide/en/elasticsearch/reference - ref-8x: https://www.elastic.co/guide/en/elasticsearch/reference/8.1 - ref-80: https://www.elastic.co/guide/en/elasticsearch/reference/8.0 - ref-7x: https://www.elastic.co/guide/en/elasticsearch/reference/7.17 - ref-70: https://www.elastic.co/guide/en/elasticsearch/reference/7.0 - ref-60: https://www.elastic.co/guide/en/elasticsearch/reference/6.0 - ref-64: https://www.elastic.co/guide/en/elasticsearch/reference/6.4 - xpack-ref: https://www.elastic.co/guide/en/x-pack/6.2 - logstash-ref: https://www.elastic.co/guide/en/logstash/current - kibana-ref: https://www.elastic.co/guide/en/kibana/current - kibana-ref-all: https://www.elastic.co/guide/en/kibana - beats-ref-root: https://www.elastic.co/guide/en/beats - beats-ref: https://www.elastic.co/guide/en/beats/libbeat/current - beats-ref-60: https://www.elastic.co/guide/en/beats/libbeat/6.0 - beats-ref-63: https://www.elastic.co/guide/en/beats/libbeat/6.3 - beats-devguide: https://www.elastic.co/guide/en/beats/devguide/current - auditbeat-ref: https://www.elastic.co/guide/en/beats/auditbeat/current - packetbeat-ref: https://www.elastic.co/guide/en/beats/packetbeat/current - metricbeat-ref: https://www.elastic.co/guide/en/beats/metricbeat/current - filebeat-ref: https://www.elastic.co/guide/en/beats/filebeat/current - functionbeat-ref: https://www.elastic.co/guide/en/beats/functionbeat/current - winlogbeat-ref: https://www.elastic.co/guide/en/beats/winlogbeat/current - heartbeat-ref: https://www.elastic.co/guide/en/beats/heartbeat/current - journalbeat-ref: https://www.elastic.co/guide/en/beats/journalbeat/current - ingest-guide: https://www.elastic.co/guide/en/ingest/current - fleet-guide: https://www.elastic.co/guide/en/fleet/current - apm-guide-ref: https://www.elastic.co/guide/en/apm/guide/current - apm-guide-7x: https://www.elastic.co/guide/en/apm/guide/7.17 - apm-app-ref: https://www.elastic.co/guide/en/kibana/current - apm-agents-ref: https://www.elastic.co/guide/en/apm/agent - apm-android-ref: https://www.elastic.co/guide/en/apm/agent/android/current - apm-py-ref: https://www.elastic.co/guide/en/apm/agent/python/current - apm-py-ref-3x: https://www.elastic.co/guide/en/apm/agent/python/3.x - apm-node-ref-index: https://www.elastic.co/guide/en/apm/agent/nodejs - apm-node-ref: https://www.elastic.co/guide/en/apm/agent/nodejs/current - apm-node-ref-1x: https://www.elastic.co/guide/en/apm/agent/nodejs/1.x - apm-rum-ref: https://www.elastic.co/guide/en/apm/agent/rum-js/current - apm-ruby-ref: https://www.elastic.co/guide/en/apm/agent/ruby/current - apm-java-ref: https://www.elastic.co/guide/en/apm/agent/java/current - apm-go-ref: https://www.elastic.co/guide/en/apm/agent/go/current - apm-dotnet-ref: https://www.elastic.co/guide/en/apm/agent/dotnet/current - apm-php-ref: https://www.elastic.co/guide/en/apm/agent/php/current - apm-ios-ref: https://www.elastic.co/guide/en/apm/agent/swift/current - apm-lambda-ref: https://www.elastic.co/guide/en/apm/lambda/current - apm-attacher-ref: https://www.elastic.co/guide/en/apm/attacher/current - docker-logging-ref: https://www.elastic.co/guide/en/beats/loggingplugin/current - esf-ref: https://www.elastic.co/guide/en/esf/{{esf_version}} - kinesis-firehose-ref: https://www.elastic.co/guide/en/kinesis/{{kinesis_version}} - estc-welcome-current: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current - estc-welcome: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current - estc-welcome-all: https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions - hadoop-ref: https://www.elastic.co/guide/en/elasticsearch/hadoop/current - stack-ref: https://www.elastic.co/guide/en/elastic-stack/current - stack-ref-67: https://www.elastic.co/guide/en/elastic-stack/6.7 - stack-ref-68: https://www.elastic.co/guide/en/elastic-stack/6.8 - stack-ref-70: https://www.elastic.co/guide/en/elastic-stack/7.0 - stack-ref-80: https://www.elastic.co/guide/en/elastic-stack/8.0 - stack-ov: https://www.elastic.co/guide/en/elastic-stack-overview/current - stack-gs: https://www.elastic.co/guide/en/elastic-stack-get-started/current - stack-gs-current: https://www.elastic.co/guide/en/elastic-stack-get-started/current - javaclient: https://www.elastic.co/guide/en/elasticsearch/client/java-api/current - java-api-client: https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current - java-rest: https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current - jsclient: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current - jsclient-current: https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current - es-ruby-client: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current - es-dotnet-client: https://www.elastic.co/guide/en/elasticsearch/client/net-api/current - es-php-client: https://www.elastic.co/guide/en/elasticsearch/client/php-api/current - es-python-client: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current - defguide: https://www.elastic.co/guide/en/elasticsearch/guide/2.x - painless: https://www.elastic.co/guide/en/elasticsearch/painless/current - plugins: https://www.elastic.co/guide/en/elasticsearch/plugins/current - plugins-8x: https://www.elastic.co/guide/en/elasticsearch/plugins/8.1 - plugins-7x: https://www.elastic.co/guide/en/elasticsearch/plugins/7.17 - plugins-6x: https://www.elastic.co/guide/en/elasticsearch/plugins/6.8 - glossary: https://www.elastic.co/guide/en/elastic-stack-glossary/current - upgrade_guide: https://www.elastic.co/products/upgrade_guide - blog-ref: https://www.elastic.co/blog/ - curator-ref: https://www.elastic.co/guide/en/elasticsearch/client/curator/current - curator-ref-current: https://www.elastic.co/guide/en/elasticsearch/client/curator/current - metrics-ref: https://www.elastic.co/guide/en/metrics/current - metrics-guide: https://www.elastic.co/guide/en/metrics/guide/current - logs-ref: https://www.elastic.co/guide/en/logs/current - logs-guide: https://www.elastic.co/guide/en/logs/guide/current - uptime-guide: https://www.elastic.co/guide/en/uptime/current - observability-guide: https://www.elastic.co/guide/en/observability/current - observability-guide-all: https://www.elastic.co/guide/en/observability - siem-guide: https://www.elastic.co/guide/en/siem/guide/current - security-guide: https://www.elastic.co/guide/en/security/current - security-guide-all: https://www.elastic.co/guide/en/security - endpoint-guide: https://www.elastic.co/guide/en/endpoint/current - sql-odbc: https://www.elastic.co/guide/en/elasticsearch/sql-odbc/current - ecs-ref: https://www.elastic.co/guide/en/ecs/{{ecs_version}} - ecs-logging-ref: https://www.elastic.co/guide/en/ecs-logging/overview/{{ecs-logging}} - ecs-logging-go-logrus-ref: https://www.elastic.co/guide/en/ecs-logging/go-logrus/{{ecs-logging-go-logrus}} - ecs-logging-go-zap-ref: https://www.elastic.co/guide/en/ecs-logging/go-zap/{{ecs-logging-go-zap}} - ecs-logging-go-zerolog-ref: https://www.elastic.co/guide/en/ecs-logging/go-zap/{{ecs-logging-go-zerolog}} - ecs-logging-java-ref: https://www.elastic.co/guide/en/ecs-logging/java/{{ecs-logging-java}} - ecs-logging-dotnet-ref: https://www.elastic.co/guide/en/ecs-logging/dotnet/{{ecs-logging-dotnet}} - ecs-logging-nodejs-ref: https://www.elastic.co/guide/en/ecs-logging/nodejs/{{ecs-logging-nodejs}} - ecs-logging-php-ref: https://www.elastic.co/guide/en/ecs-logging/php/{{ecs-logging-php}} - ecs-logging-python-ref: https://www.elastic.co/guide/en/ecs-logging/python/{{ecs-logging-python}} - ecs-logging-ruby-ref: https://www.elastic.co/guide/en/ecs-logging/ruby/{{ecs-logging-ruby}} - ml-docs: https://www.elastic.co/guide/en/machine-learning/current - eland-docs: https://www.elastic.co/guide/en/elasticsearch/client/eland/current - eql-ref: https://eql.readthedocs.io/en/latest/query-guide - subscriptions: https://www.elastic.co/subscriptions - extendtrial: https://www.elastic.co/trialextension - wikipedia: https://en.wikipedia.org/wiki - forum: https://discuss.elastic.co/ - xpack-forum: https://discuss.elastic.co/c/50-x-pack - security-forum: https://discuss.elastic.co/c/x-pack/shield - watcher-forum: https://discuss.elastic.co/c/x-pack/watcher - monitoring-forum: https://discuss.elastic.co/c/x-pack/marvel - graph-forum: https://discuss.elastic.co/c/x-pack/graph - apm-forum: https://discuss.elastic.co/c/apm - enterprise-search-ref: https://www.elastic.co/guide/en/enterprise-search/current - app-search-ref: https://www.elastic.co/guide/en/app-search/current - workplace-search-ref: https://www.elastic.co/guide/en/workplace-search/current - enterprise-search-node-ref: https://www.elastic.co/guide/en/enterprise-search-clients/enterprise-search-node/current - enterprise-search-php-ref: https://www.elastic.co/guide/en/enterprise-search-clients/php/current - enterprise-search-python-ref: https://www.elastic.co/guide/en/enterprise-search-clients/python/current - enterprise-search-ruby-ref: https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current - elastic-maps-service: https://maps.elastic.co - integrations-docs: https://docs.elastic.co/en/integrations - integrations-devguide: https://www.elastic.co/guide/en/integrations-developer/current - time-units: https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#time-units - byte-units: https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units - apm-py-ref-v: https://www.elastic.co/guide/en/apm/agent/python/{{apm-py-branch}} - apm-node-ref-v: https://www.elastic.co/guide/en/apm/agent/nodejs/{{apm-node-branch}} - apm-rum-ref-v: https://www.elastic.co/guide/en/apm/agent/rum-js/{{apm-rum-branch}} - apm-ruby-ref-v: https://www.elastic.co/guide/en/apm/agent/ruby/{{apm-ruby-branch}} - apm-java-ref-v: https://www.elastic.co/guide/en/apm/agent/java/{{apm-java-branch}} - apm-go-ref-v: https://www.elastic.co/guide/en/apm/agent/go/{{apm-go-branch}} - apm-ios-ref-v: https://www.elastic.co/guide/en/apm/agent/swift/{{apm-ios-branch}} - apm-dotnet-ref-v: https://www.elastic.co/guide/en/apm/agent/dotnet/{{apm-dotnet-branch}} - apm-php-ref-v: https://www.elastic.co/guide/en/apm/agent/php/{{apm-php-branch}} - ecloud: Elastic Cloud - esf: Elastic Serverless Forwarder - ess: Elasticsearch Service - ece: Elastic Cloud Enterprise - eck: Elastic Cloud on Kubernetes - serverless-full: Elastic Cloud Serverless - serverless-short: Serverless - es-serverless: Elasticsearch Serverless - es3: Elasticsearch Serverless - obs-serverless: Elastic Observability Serverless - sec-serverless: Elastic Security Serverless - serverless-docs: https://docs.elastic.co/serverless - cloud: https://www.elastic.co/guide/en/cloud/current - ess-utm-params: ?page=docs&placement=docs-body - ess-baymax: ?page=docs&placement=docs-body - ess-trial: https://cloud.elastic.co/registration?page=docs&placement=docs-body - ess-product: https://www.elastic.co/cloud/elasticsearch-service?page=docs&placement=docs-body - ess-console: https://cloud.elastic.co?page=docs&placement=docs-body - ess-console-name: Elasticsearch Service Console - ess-deployments: https://cloud.elastic.co/deployments?page=docs&placement=docs-body - ece-ref: https://www.elastic.co/guide/en/cloud-enterprise/{{ece-version-link}} - eck-ref: https://www.elastic.co/guide/en/cloud-on-k8s/current - ess-leadin: You can run Elasticsearch on your own hardware or use our hosted Elasticsearch - Service that is available on AWS, GCP, and Azure. https://cloud.elastic.co/registration{ess-utm-params}[Try - the Elasticsearch Service for free]. - ess-leadin-short: Our hosted Elasticsearch Service is available on AWS, GCP, and - Azure, and you can https://cloud.elastic.co/registration{ess-utm-params}[try it - for free]. - ess-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link="https://cloud.elastic.co/registration{ess-utm-params}", - title="Supported on Elasticsearch Service"] - ece-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud_ece.svg[link="https://cloud.elastic.co/registration{ess-utm-params}", - title="Supported on Elastic Cloud Enterprise"] - cloud-only: This feature is designed for indirect use by https://cloud.elastic.co/registration{ess-utm-params}[Elasticsearch - Service], https://www.elastic.co/guide/en/cloud-enterprise/{ece-version-link}[Elastic - Cloud Enterprise], and https://www.elastic.co/guide/en/cloud-on-k8s/current[Elastic - Cloud on Kubernetes]. Direct use is not supported. - ess-setting-change: image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link="{ess-trial}", - title="Supported on {ess}"] indicates a change to a supported https://www.elastic.co/guide/en/cloud/current/ec-add-user-settings.html[user - setting] for Elasticsearch Service. - ess-skip-section: If you use Elasticsearch Service, skip this section. Elasticsearch - Service handles these changes for you. - api-cloud: https://www.elastic.co/docs/api/doc/cloud - api-ece: https://www.elastic.co/docs/api/doc/cloud-enterprise - api-kibana-serverless: https://www.elastic.co/docs/api/doc/serverless - es-feature-flag: This feature is in development and not yet available for use. This - documentation is provided for informational purposes only. - es-ref-dir: '{{elasticsearch-root}}/docs/reference' - apm-app: APM app - uptime-app: Uptime app - synthetics-app: Synthetics app - logs-app: Logs app - metrics-app: Metrics app - infrastructure-app: Infrastructure app - siem-app: SIEM app - security-app: Elastic Security app - ml-app: Machine Learning - dev-tools-app: Dev Tools - ingest-manager-app: Ingest Manager - stack-manage-app: Stack Management - stack-monitor-app: Stack Monitoring - alerts-ui: Alerts and Actions - rules-ui: Rules - rac-ui: Rules and Connectors - connectors-ui: Connectors - connectors-feature: Actions and Connectors - stack-rules-feature: Stack Rules - user-experience: User Experience - ems: Elastic Maps Service - ems-init: EMS - hosted-ems: Elastic Maps Server - ipm-app: Index Pattern Management - ingest-pipelines: ingest pipelines - ingest-pipelines-app: Ingest Pipelines - ingest-pipelines-cap: Ingest pipelines - ls-pipelines: Logstash pipelines - ls-pipelines-app: Logstash Pipelines - maint-windows: maintenance windows - maint-windows-app: Maintenance Windows - maint-windows-cap: Maintenance windows - custom-roles-app: Custom Roles - data-source: data view - data-sources: data views - data-source-caps: Data View - data-sources-caps: Data Views - data-source-cap: Data view - data-sources-cap: Data views - project-settings: Project settings - manage-app: Management - index-manage-app: Index Management - data-views-app: Data Views - rules-app: Rules - saved-objects-app: Saved Objects - tags-app: Tags - api-keys-app: API keys - transforms-app: Transforms - connectors-app: Connectors - files-app: Files - reports-app: Reports - maps-app: Maps - alerts-app: Alerts - crawler: Enterprise Search web crawler - ents: Enterprise Search - app-search-crawler: App Search web crawler - agent: Elastic Agent - agents: Elastic Agents - fleet: Fleet - fleet-server: Fleet Server - integrations-server: Integrations Server - ingest-manager: Ingest Manager - ingest-management: ingest management - package-manager: Elastic Package Manager - integrations: Integrations - package-registry: Elastic Package Registry - artifact-registry: Elastic Artifact Registry - aws: AWS - stack: Elastic Stack - xpack: X-Pack - es: Elasticsearch - kib: Kibana - esms: Elastic Stack Monitoring Service - esms-init: ESMS - ls: Logstash - beats: Beats - auditbeat: Auditbeat - filebeat: Filebeat - heartbeat: Heartbeat - metricbeat: Metricbeat - packetbeat: Packetbeat - winlogbeat: Winlogbeat - functionbeat: Functionbeat - journalbeat: Journalbeat - es-sql: Elasticsearch SQL - esql: ES|QL - elastic-agent: Elastic Agent - k8s: Kubernetes - log-driver-long: Elastic Logging Plugin for Docker - security: X-Pack security - security-features: security features - operator-feature: operator privileges feature - es-security-features: Elasticsearch security features - stack-security-features: Elastic Stack security features - endpoint-sec: Endpoint Security - endpoint-cloud-sec: Endpoint and Cloud Security - elastic-defend: Elastic Defend - elastic-sec: Elastic Security - elastic-endpoint: Elastic Endpoint - swimlane: Swimlane - sn: ServiceNow - sn-itsm: ServiceNow ITSM - sn-itom: ServiceNow ITOM - sn-sir: ServiceNow SecOps - jira: Jira - ibm-r: IBM Resilient - webhook: Webhook - webhook-cm: Webhook - Case Management - opsgenie: Opsgenie - bedrock: Amazon Bedrock - gemini: Google Gemini - hive: TheHive - monitoring: X-Pack monitoring - monitor-features: monitoring features - stack-monitor-features: Elastic Stack monitoring features - watcher: Watcher - alert-features: alerting features - reporting: X-Pack reporting - report-features: reporting features - graph: X-Pack graph - graph-features: graph analytics features - searchprofiler: Search Profiler - xpackml: X-Pack machine learning - ml: machine learning - ml-cap: Machine learning - ml-init: ML - ml-features: machine learning features - stack-ml-features: Elastic Stack machine learning features - ccr: cross-cluster replication - ccr-cap: Cross-cluster replication - ccr-init: CCR - ccs: cross-cluster search - ccs-cap: Cross-cluster search - ccs-init: CCS - ilm: index lifecycle management - ilm-cap: Index lifecycle management - ilm-init: ILM - dlm: data lifecycle management - dlm-cap: Data lifecycle management - dlm-init: DLM - search-snap: searchable snapshot - search-snaps: searchable snapshots - search-snaps-cap: Searchable snapshots - slm: snapshot lifecycle management - slm-cap: Snapshot lifecycle management - slm-init: SLM - rollup-features: data rollup features - ipm: index pattern management - ipm-cap: Index pattern - rollup: rollup - rollup-cap: Rollup - rollups: rollups - rollups-cap: Rollups - rollup-job: rollup job - rollup-jobs: rollup jobs - rollup-jobs-cap: Rollup jobs - dfeed: datafeed - dfeeds: datafeeds - dfeed-cap: Datafeed - dfeeds-cap: Datafeeds - ml-jobs: machine learning jobs - ml-jobs-cap: Machine learning jobs - anomaly-detect: anomaly detection - anomaly-detect-cap: Anomaly detection - anomaly-job: anomaly detection job - anomaly-jobs: anomaly detection jobs - anomaly-jobs-cap: Anomaly detection jobs - dataframe: data frame - dataframes: data frames - dataframe-cap: Data frame - dataframes-cap: Data frames - watcher-transform: payload transform - watcher-transforms: payload transforms - watcher-transform-cap: Payload transform - watcher-transforms-cap: Payload transforms - transform: transform - transforms: transforms - transform-cap: Transform - transforms-cap: Transforms - dataframe-transform: transform - dataframe-transform-cap: Transform - dataframe-transforms: transforms - dataframe-transforms-cap: Transforms - dfanalytics-cap: Data frame analytics - dfanalytics: data frame analytics - dataframe-analytics-config: '{dataframe} analytics config' - dfanalytics-job: '{dataframe} analytics job' - dfanalytics-jobs: '{dataframe} analytics jobs' - dfanalytics-jobs-cap: '{dataframe-cap} analytics jobs' - cdataframe: continuous data frame - cdataframes: continuous data frames - cdataframe-cap: Continuous data frame - cdataframes-cap: Continuous data frames - cdataframe-transform: continuous transform - cdataframe-transforms: continuous transforms - cdataframe-transforms-cap: Continuous transforms - ctransform: continuous transform - ctransform-cap: Continuous transform - ctransforms: continuous transforms - ctransforms-cap: Continuous transforms - oldetection: outlier detection - oldetection-cap: Outlier detection - olscore: outlier score - olscores: outlier scores - fiscore: feature influence score - evaluatedf-api: evaluate {dataframe} analytics API - evaluatedf-api-cap: Evaluate {dataframe} analytics API - binarysc: binary soft classification - binarysc-cap: Binary soft classification - regression: regression - regression-cap: Regression - reganalysis: regression analysis - reganalysis-cap: Regression analysis - depvar: dependent variable - feature-var: feature variable - feature-vars: feature variables - feature-vars-cap: Feature variables - classification: classification - classification-cap: Classification - classanalysis: classification analysis - classanalysis-cap: Classification analysis - infer-cap: Inference - infer: inference - lang-ident-cap: Language identification - lang-ident: language identification - data-viz: Data Visualizer - file-data-viz: File Data Visualizer - feat-imp: feature importance - feat-imp-cap: Feature importance - nlp: natural language processing - nlp-cap: Natural language processing - apm-agent: APM agent - apm-go-agent: Elastic APM Go agent - apm-go-agents: Elastic APM Go agents - apm-ios-agent: Elastic APM iOS agent - apm-ios-agents: Elastic APM iOS agents - apm-java-agent: Elastic APM Java agent - apm-java-agents: Elastic APM Java agents - apm-dotnet-agent: Elastic APM .NET agent - apm-dotnet-agents: Elastic APM .NET agents - apm-node-agent: Elastic APM Node.js agent - apm-node-agents: Elastic APM Node.js agents - apm-php-agent: Elastic APM PHP agent - apm-php-agents: Elastic APM PHP agents - apm-py-agent: Elastic APM Python agent - apm-py-agents: Elastic APM Python agents - apm-ruby-agent: Elastic APM Ruby agent - apm-ruby-agents: Elastic APM Ruby agents - apm-rum-agent: Elastic APM Real User Monitoring (RUM) JavaScript agent - apm-rum-agents: Elastic APM RUM JavaScript agents - apm-lambda-ext: Elastic APM AWS Lambda extension - project-monitors: project monitors - project-monitors-cap: Project monitors - private-location: Private Location - private-locations: Private Locations - pwd: YOUR_PASSWORD - esh: ES-Hadoop - default-dist: default distribution - oss-dist: OSS-only distribution - observability: Observability - api-request-title: Request - api-prereq-title: Prerequisites - api-description-title: Description - api-path-parms-title: Path parameters - api-query-parms-title: Query parameters - api-request-body-title: Request body - api-response-codes-title: Response codes - api-response-body-title: Response body - api-example-title: Example - api-examples-title: Examples - api-definitions-title: Properties - multi-arg: †footnoteref:[multi-arg,This parameter accepts multiple arguments.] - multi-arg-ref: †footnoteref:[multi-arg] - yes-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png[Yes,20,15] - no-icon: image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png[No,20,15] - es-repo: https://github.com/elastic/elasticsearch/ - es-issue: https://github.com/elastic/elasticsearch/issues/ - es-pull: https://github.com/elastic/elasticsearch/pull/ - es-commit: https://github.com/elastic/elasticsearch/commit/ - kib-repo: https://github.com/elastic/kibana/ - kib-issue: https://github.com/elastic/kibana/issues/ - kibana-issue: '{kib-repo}issues/' - kib-pull: https://github.com/elastic/kibana/pull/ - kibana-pull: '{kib-repo}pull/' - kib-commit: https://github.com/elastic/kibana/commit/ - ml-repo: https://github.com/elastic/ml-cpp/ - ml-issue: https://github.com/elastic/ml-cpp/issues/ - ml-pull: https://github.com/elastic/ml-cpp/pull/ - ml-commit: https://github.com/elastic/ml-cpp/commit/ - apm-repo: https://github.com/elastic/apm-server/ - apm-issue: https://github.com/elastic/apm-server/issues/ - apm-pull: https://github.com/elastic/apm-server/pull/ - kibana-blob: https://github.com/elastic/kibana/blob/current/ - apm-get-started-ref: https://www.elastic.co/guide/en/apm/get-started/current - apm-server-ref: https://www.elastic.co/guide/en/apm/server/current - apm-server-ref-v: https://www.elastic.co/guide/en/apm/server/current - apm-server-ref-m: https://www.elastic.co/guide/en/apm/server/master - apm-server-ref-62: https://www.elastic.co/guide/en/apm/server/6.2 - apm-server-ref-64: https://www.elastic.co/guide/en/apm/server/6.4 - apm-server-ref-70: https://www.elastic.co/guide/en/apm/server/7.0 - apm-overview-ref-v: https://www.elastic.co/guide/en/apm/get-started/current - apm-overview-ref-70: https://www.elastic.co/guide/en/apm/get-started/7.0 - apm-overview-ref-m: https://www.elastic.co/guide/en/apm/get-started/master - infra-guide: https://www.elastic.co/guide/en/infrastructure/guide/current - a-data-source: a data view - icon-bug: pass:[] - icon-checkInCircleFilled: pass:[] - icon-warningFilled: pass:[] diff --git a/docs/source/migration/freeze/scripts/codeowner-gen/codeowner.py b/docs/source/migration/freeze/scripts/codeowner-gen/codeowner.py deleted file mode 100644 index b45e845d9..000000000 --- a/docs/source/migration/freeze/scripts/codeowner-gen/codeowner.py +++ /dev/null @@ -1,114 +0,0 @@ -import yaml -from collections import defaultdict -import os - -def read_yaml(file_path): - """Reads and parses the YAML file.""" - with open(file_path, 'r', encoding='utf-8') as file: - return yaml.safe_load(file) - -def traverse_sections(sections, repo_paths): - """ - Recursively traverses nested sections to gather repository paths. - - Args: - sections (list): List of section dictionaries. - repo_paths (defaultdict): Dictionary mapping repo names to sets of paths. - """ - for section in sections: - # Gather sources in the current section - sources = section.get('sources', []) - for source in sources: - repo_name = source.get('repo') - path = source.get('path') - if repo_name and path: - # Remove trailing slashes and replace double slashes with single slashes - clean_path = path.rstrip('/').replace('//', '/') - # Format the path for CODEOWNERS - formatted_path = f"{clean_path}/*.asciidoc @elastic/docs-freeze-team" - repo_paths[repo_name].add(formatted_path) - - # If there are nested sections, traverse them recursively - nested_sections = section.get('sections', []) - if nested_sections: - traverse_sections(nested_sections, repo_paths) - -def gather_repo_paths(contents): - """ - Gathers all unique paths for each repository from the contents. - - Args: - contents (list): List of content dictionaries from YAML. - - Returns: - defaultdict: Dictionary mapping repo names to sets of formatted paths. - """ - repo_paths = defaultdict(set) - for content in contents: - sections = content.get('sections', []) - traverse_sections(sections, repo_paths) - return repo_paths - -def generate_markdown_output(repo_paths, repos_info): - """ - Generates Markdown output with repository headings and CODEOWNERS code blocks. - - Args: - repo_paths (dict): Dictionary mapping repo names to sets of paths. - repos_info (dict): Dictionary mapping repo names to their GitHub URLs. - - Returns: - str: Formatted Markdown content as a string. - """ - output = "" - for repo in sorted(repo_paths.keys()): - repo_url = repos_info.get(repo, '#') # Default to '#' if URL not found - if repo_url.endswith('.git'): - repo_url = repo_url[:-4] # Remove the '.git' suffix for proper URL - - # Create level three heading with repository link - output += f"### [{repo}]({repo_url})\n\n" - - # Start code block - output += "```\n" - - # Add each CODEOWNERS line within the code block - for path in sorted(repo_paths[repo]): - output += f"{path}\n" - - # End code block - output += "```\n\n" - - return output - -def main(): - # Define the path to the 'conf.yaml' file (assumes it's in the same directory) - script_dir = os.path.dirname(os.path.abspath(__file__)) - file_path = os.path.join(script_dir, 'conf.yaml') - - # Read and parse the YAML file - yaml_content = read_yaml(file_path) - - # Extract repository information - repos_info = yaml_content.get('repos', {}) - - # Extract contents - contents = yaml_content.get('contents', []) - - # Gather all repository paths - repo_paths = gather_repo_paths(contents) - - # Generate the Markdown content - markdown_output = generate_markdown_output(repo_paths, repos_info) - - # Define the output Markdown file path - output_path = os.path.join(script_dir, 'output.md') - - # Write the Markdown content to the file - with open(output_path, 'w', encoding='utf-8') as output_file: - output_file.write(markdown_output) - - print(f"Markdown content has been written to '{output_path}'") - -if __name__ == "__main__": - main() diff --git a/docs/source/migration/freeze/scripts/codeowner-gen/conf.yaml b/docs/source/migration/freeze/scripts/codeowner-gen/conf.yaml deleted file mode 100644 index ccf2a7865..000000000 --- a/docs/source/migration/freeze/scripts/codeowner-gen/conf.yaml +++ /dev/null @@ -1,3022 +0,0 @@ -repos: - apm-aws-lambda: https://github.com/elastic/apm-aws-lambda.git - apm-k8s-attacher: https://github.com/elastic/apm-k8s-attacher.git - apm-server: https://github.com/elastic/apm-server.git - apm-agent-android: https://github.com/elastic/apm-agent-android.git - apm-agent-nodejs: https://github.com/elastic/apm-agent-nodejs.git - apm-agent-python: https://github.com/elastic/apm-agent-python.git - apm-agent-ruby: https://github.com/elastic/apm-agent-ruby.git - apm-agent-rum-js: https://github.com/elastic/apm-agent-rum-js.git - apm-agent-go: https://github.com/elastic/apm-agent-go.git - apm-agent-java: https://github.com/elastic/apm-agent-java.git - apm-agent-dotnet: https://github.com/elastic/apm-agent-dotnet.git - apm-agent-php: https://github.com/elastic/apm-agent-php.git - apm-agent-ios: https://github.com/elastic/apm-agent-ios.git - azure-marketplace: https://github.com/elastic/azure-marketplace.git - beats: https://github.com/elastic/beats.git - clients-team: https://github.com/elastic/clients-team.git - cloud: https://github.com/elastic/cloud.git - cloud-assets: https://github.com/elastic/cloud-assets.git - cloud-on-k8s: https://github.com/elastic/cloud-on-k8s.git - curator: https://github.com/elastic/curator.git - docs-content: https://github.com/elastic/docs-content.git - ecctl: https://github.com/elastic/ecctl.git - ecs: https://github.com/elastic/ecs.git - ecs-dotnet: https://github.com/elastic/ecs-dotnet.git - ecs-logging: https://github.com/elastic/ecs-logging.git - ecs-logging-go-logrus: https://github.com/elastic/ecs-logging-go-logrus.git - ecs-logging-go-zap: https://github.com/elastic/ecs-logging-go-zap.git - ecs-logging-go-zerolog: https://github.com/elastic/ecs-logging-go-zerolog.git - ecs-logging-java: https://github.com/elastic/ecs-logging-java.git - ecs-logging-nodejs: https://github.com/elastic/ecs-logging-nodejs.git - ecs-logging-php: https://github.com/elastic/ecs-logging-php.git - ecs-logging-python: https://github.com/elastic/ecs-logging-python.git - ecs-logging-ruby: https://github.com/elastic/ecs-logging-ruby.git - eland: https://github.com/elastic/eland.git - elasticsearch-hadoop: https://github.com/elastic/elasticsearch-hadoop.git - elasticsearch-java: https://github.com/elastic/elasticsearch-java.git - elasticsearch-js: https://github.com/elastic/elasticsearch-js.git - elasticsearch-js-legacy: https://github.com/elastic/elasticsearch-js-legacy.git - elasticsearch-ruby: https://github.com/elastic/elasticsearch-ruby.git - elasticsearch-net: https://github.com/elastic/elasticsearch-net.git - elasticsearch-php: https://github.com/elastic/elasticsearch-php.git - elasticsearch-php-cn: https://github.com/elasticsearch-cn/elasticsearch-php.git - elasticsearch-py: https://github.com/elastic/elasticsearch-py.git - elasticsearch-perl: https://github.com/elastic/elasticsearch-perl.git - go-elasticsearch: https://github.com/elastic/go-elasticsearch.git - elasticsearch-rs: https://github.com/elastic/elasticsearch-rs.git - elasticsearch: https://github.com/elastic/elasticsearch.git - enterprise-search-pubs: https://github.com/elastic/enterprise-search-pubs.git - enterprise-search-js: https://github.com/elastic/enterprise-search-js.git - enterprise-search-php: https://github.com/elastic/enterprise-search-php.git - enterprise-search-python: https://github.com/elastic/enterprise-search-python.git - enterprise-search-ruby: https://github.com/elastic/enterprise-search-ruby.git - esf: https://github.com/elastic/elastic-serverless-forwarder.git - guide: https://github.com/elastic/elasticsearch-definitive-guide.git - guide-cn: https://github.com/elasticsearch-cn/elasticsearch-definitive-guide.git - ingest-docs: https://github.com/elastic/ingest-docs.git - integration-docs: https://github.com/elastic/integration-docs.git - kibana: https://github.com/elastic/kibana.git - kibana-cn: https://github.com/elasticsearch-cn/kibana.git - logstash: https://github.com/elastic/logstash.git - logstash-docs: https://github.com/elastic/logstash-docs.git - observability-docs: https://github.com/elastic/observability-docs.git - package-spec: https://github.com/elastic/package-spec.git - search-ui: https://github.com/elastic/search-ui.git - security-docs: https://github.com/elastic/security-docs.git - sense: https://github.com/elastic/sense.git - stack-docs: https://github.com/elastic/stack-docs.git - swiftype: https://github.com/elastic/swiftype-doc-placeholder.git - tech-content: https://github.com/elastic/tech-content.git - terraform-provider-ec: https://github.com/elastic/terraform-provider-ec.git - x-pack: https://github.com/elastic/x-pack.git - x-pack-elasticsearch: https://github.com/elastic/x-pack-elasticsearch.git - x-pack-kibana: https://github.com/elastic/x-pack-kibana.git - x-pack-logstash: https://github.com/elastic/x-pack-logstash.git - -contents_title: Elastic documentation - -# Each item should take the form: -# : & -# The keys don't really matter, but by convention the are the same as the variable. -variables: - stackcurrent: &stackcurrent 8.17 - stacklive: &stacklive [ 8.17, 7.17 ] - - cloudSaasCurrent: &cloudSaasCurrent ms-117 - - mapCloudEceToClientsTeam: &mapCloudEceToClientsTeam - ms-105: main - ms-92: main - ms-81: main - ms-78: main - ms-75: main - ms-72: main - ms-70: main - ms-69: main - ms-65: main - ms-62: main - ms-59: main - ms-57: main - ms-53: main - ms-49: main - ms-47: main - release-ms-41: main - 2.5: main - 2.4: main - 2.3: main - 2.2: main - 2.1: main - 2.0: main - 1.1: main - 1.0: main - - # Use this when you're building a book that uses a "main" branch, but it has a dependency on a repo with a "master" branch - mapMainToMaster: &mapMainToMaster - main: master - - # Use this when you're building a book that uses a "master" branch, but it has a dependency on a repo with a "main" branch - mapMasterToMain: &mapMasterToMain - master: main - - beatsSharedExclude: &beatsSharedExclude [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - beatsXpackLibbeatExclude: &beatsXpackLibbeatExclude [ 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - beatsProcessorExclude: &beatsProcessorExclude [ 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - beatsOutputExclude: &beatsOutputExclude [ 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - - -toc_extra: extra/docs_landing.html -contents: - - title: Search UI - sections: - - title: Search UI - prefix: en/search-ui - current: main - branches: [ main ] - live: [ main ] - index: docs/index.asciidoc - chunk: 3 - tags: Search UI/Guide - subject: Search UI - sources: - - - repo: search-ui - path: docs - - title: Integrations - sections: - - title: Integrations - prefix: en/integrations - current: main - branches: [ main ] - live: [ main ] - index: dist/index.asciidoc - chunk: 2 - private: 1 - tags: Integrations/Reference - subject: Integrations - sources: - - - repo: integration-docs - path: dist - - title: Serverless - sections: - - title: Serverless - prefix: en/serverless - current: main - branches: [ main ] - live: [ main ] - index: serverless/index.asciidoc - chunk: 5 - tags: Serverless/Guide - subject: Serverless - sources: - - - repo: docs-content - path: serverless - - - repo: observability-docs - path: docs/en/serverless - - - repo: security-docs - path: docs/serverless - - - title: Search - sections: - - title: Elasticsearch Guide - prefix: en/elasticsearch/reference - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - live: *stacklive - index: docs/reference/index.x.asciidoc - chunk: 1 - tags: Elasticsearch/Reference - subject: Elasticsearch - sources: - - - repo: elasticsearch - path: docs/reference - - - repo: x-pack-elasticsearch - prefix: elasticsearch-extra/x-pack-elasticsearch - path: docs/en - private: true - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: x-pack-elasticsearch - prefix: elasticsearch-extra/x-pack-elasticsearch - path: qa/sql - private: true - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: docs/Versions.asciidoc - exclude_branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: docs/src/test/cluster/config - exclude_branches: [ 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: plugins/examples - exclude_branches: [ 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: buildSrc/ - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: build-tools-internal/ - exclude_branches: [7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: docs/painless - exclude_branches: [ 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: x-pack/docs - private: true - # only exists from 6.2 to 8.9 - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: x-pack/qa/sql - # only exists from 6.3 to 6.5 - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: x-pack/plugin/esql/qa/testFixtures/src/main/resources - # only exists from 8.11 - exclude_branches: [ 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: x-pack/plugin/sql/qa - exclude_branches: [ 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - alternatives: { source_lang: console, alternative_lang: php } - repo: elasticsearch-php - path: docs/examples - exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - alternatives: { source_lang: console, alternative_lang: python } - repo: elasticsearch-py - path: docs/examples - exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - alternatives: { source_lang: console, alternative_lang: ruby } - repo: elasticsearch-ruby - path: docs/examples/guide - exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - alternatives: { source_lang: console, alternative_lang: go } - repo: go-elasticsearch - path: .doc/examples/doc/ - exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: docs - path: shared/attributes62.asciidoc - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - alternatives: { source_lang: console, alternative_lang: js } - repo: elasticsearch-js - path: docs/doc_examples - exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: server/src/main/resources/org/elasticsearch/common - exclude_branches: [ 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - title: Enterprise Search Guide - prefix: en/enterprise-search - index: enterprise-search-docs/index.asciidoc - private: 1 - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7 ] - live: *stacklive - chunk: 1 - tags: Enterprise Search/Guide - subject: Enterprise Search - sources: - - - repo: enterprise-search-pubs - path: enterprise-search-docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: Workplace Search Guide - prefix: en/workplace-search - index: workplace-search-docs/index.asciidoc - private: 1 - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6 ] - live: *stacklive - chunk: 1 - tags: Workplace Search/Guide - subject: Workplace Search - sources: - - - repo: enterprise-search-pubs - path: workplace-search-docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: App Search Guide - prefix: en/app-search - index: app-search-docs/index.asciidoc - private: 1 - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7 ] - live: *stacklive - chunk: 1 - tags: App Search/Guide - subject: App Search - sources: - - - repo: enterprise-search-pubs - path: app-search-docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: Enterprise Search Clients - base_dir: en/enterprise-search-clients - sections: - - title: App Search JavaScript client - prefix: app-search-javascript - private: 1 - single: 1 - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklive - index: client-docs/app-search-javascript/index.asciidoc - tags: App Search Clients/JavaScript - subject: App Search Clients - sources: - - - repo: enterprise-search-pubs - path: client-docs/app-search-javascript - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: App Search Node.js client - prefix: app-search-node - private: 1 - single: 1 - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklive - index: client-docs/app-search-node/index.asciidoc - tags: App Search Clients/Node.js - subject: App Search Clients - sources: - - - repo: enterprise-search-pubs - path: client-docs/app-search-node - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: Enterprise Search Node.js client - prefix: enterprise-search-node - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6 ] - live: [ *stackcurrent ] - index: packages/enterprise-search/docs/index.asciidoc - tags: Enterprise Search Clients/Node.js - subject: Enterprise Search Clients - sources: - - - repo: enterprise-search-js - path: packages/enterprise-search/docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: Enterprise Search PHP client - prefix: php - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklive - index: docs/guide/index.asciidoc - tags: Enterprise Search Clients/PHP - subject: Enterprise Search Clients - sources: - - - repo: enterprise-search-php - path: docs/guide/ - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: Enterprise Search Python client - prefix: python - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11 ] - live: *stacklive - index: docs/guide/index.asciidoc - tags: Enterprise Search Clients/Python - subject: Enterprise Search Clients - sources: - - - repo: enterprise-search-python - path: docs/guide/ - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: Enterprise Search Ruby client - prefix: ruby - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11 ] - live: *stacklive - index: docs/guide/index.asciidoc - tags: Enterprise Search Clients/Ruby - subject: Enterprise Search Clients - sources: - - - repo: enterprise-search-ruby - path: docs/guide/ - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: Workplace Search Node.js client - prefix: workplace-search-node - private: 1 - single: 1 - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklive - index: client-docs/workplace-search-node/index.asciidoc - tags: Workplace Search Clients/Node.js - subject: Workplace Search Clients - sources: - - - repo: enterprise-search-pubs - path: client-docs/workplace-search-node - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: "Observability: APM, Logs, Metrics, and Uptime" - sections: - - title: Observability - prefix: en/observability - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9 ] - live: *stacklive - index: docs/en/observability/index.asciidoc - chunk: 4 - tags: Observability/Guide - subject: Observability - sources: - - - repo: observability-docs - path: docs/en - - - repo: ingest-docs - path: docs/en - - - repo: apm-server - path: docs - exclude_branches: [ 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: apm-server - path: changelogs - exclude_branches: [ 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: apm-server - path: CHANGELOG.asciidoc - exclude_branches: [ 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: beats - path: libbeat/docs - exclude_branches: [ 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - title: Application Performance Monitoring (APM) - base_dir: en/apm - toc_extra: extra/apm_docs_landing.html - sections: - - title: APM Guide - prefix: guide - toc_extra: extra/apm_guide_landing.html - index: docs/en/apm-server/integrations-index.asciidoc - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklive - chunk: 2 - tags: APM Guide - subject: APM - sources: - - - repo: observability-docs - path: docs/en - exclude_branches: [ 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - map_branches: *mapMasterToMain - - - repo: apm-server - path: changelogs - exclude_branches: [ 6.0 ] - - - repo: apm-server - path: docs/data - - - repo: apm-server - path: docs/spec - - - repo: apm-server - path: CHANGELOG.asciidoc - - - repo: ingest-docs - path: docs/en - exclude_branches: [ 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - title: APM Agents - base_dir: agent - sections: - - title: APM Android Agent - prefix: android - current: 0.x - branches: [ {main: master}, 0.x ] - live: [ 0.x ] - index: docs/index.asciidoc - tags: APM Android Agent/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-agent-android - path: docs - - - repo: apm-agent-android - path: CHANGELOG.asciidoc - - title: APM Go Agent - prefix: go - current: 2.x - branches: [ {main: master}, 2.x, 1.x, 0.5 ] - live: [ 2.x, 1.x ] - index: docs/index.asciidoc - tags: APM Go Agent/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-agent-go - path: docs - - - repo: apm-agent-go - path: CHANGELOG.asciidoc - exclude_branches: [ 0.5 ] - - title: APM iOS Agent - prefix: swift - current: 1.x - branches: [ main, 1.x, 0.x ] - live: [ 1.x ] - index: docs/index.asciidoc - tags: APM iOS Agent/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-agent-ios - path: docs - - - repo: apm-agent-ios - path: CHANGELOG.asciidoc - - title: APM Java Agent - prefix: java - current: 1.x - branches: [ {main: master}, 1.x, 0.7, 0.6 ] - live: [ 1.x ] - index: docs/index.asciidoc - tags: APM Java Agent/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-agent-java - path: docs - - - repo: apm-agent-java - path: CHANGELOG.asciidoc - exclude_branches: [ 0.7, 0.6] - - - repo: apm-aws-lambda - path: docs - exclude_branches: [ 0.7, 0.6 ] - map_branches: - 1.x: main - - title: APM .NET Agent - prefix: dotnet - current: 1.x - branches: [ {main: master}, 1.x, 1.8 ] - live: [ 1.x ] - index: docs/index.asciidoc - tags: APM .NET Agent/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-agent-dotnet - path: docs - - - repo: apm-agent-dotnet - path: CHANGELOG.asciidoc - - title: APM Node.js Agent - prefix: nodejs - current: 4.x - branches: [ {main: master}, 4.x, 3.x, 2.x, 1.x ] - live: [ 4.x ] - index: docs/index.asciidoc - tags: APM Node.js Agent/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-agent-nodejs - path: docs - - - repo: apm-agent-nodejs - path: CHANGELOG.asciidoc - exclude_branches: [ 1.x, 0.x ] - - - repo: apm-aws-lambda - path: docs - exclude_branches: [ 2.x, 1.x, 0.x ] - map_branches: - 3.x: main - 4.x: main - - title: APM PHP Agent - prefix: php - current: 1.x - branches: [ {main: master}, 1.x ] - live: [ 1.x ] - index: docs/index.asciidoc - tags: APM PHP Agent/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-agent-php - path: docs - - - repo: apm-agent-php - path: CHANGELOG.asciidoc - - title: APM Python Agent - prefix: python - current: 6.x - branches: [ {main: master}, 6.x, 5.x, 4.x, 3.x, 2.x, 1.x ] - live: [ 6.x, 5.x ] - index: docs/index.asciidoc - tags: APM Python Agent/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-agent-python - path: docs - - - repo: apm-agent-python - path: CHANGELOG.asciidoc - exclude_branches: [ 4.x, 3.x, 2.x, 1.x ] - - - repo: apm-aws-lambda - path: docs - exclude_branches: [ 5.x, 4.x, 3.x, 2.x, 1.x ] - map_branches: - 6.x: main - - title: APM Ruby Agent - prefix: ruby - current: 4.x - branches: [ {main: master}, 4.x, 3.x, 2.x, 1.x ] - live: [ 4.x ] - index: docs/index.asciidoc - tags: APM Ruby Agent/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-agent-ruby - path: docs - - - repo: apm-agent-ruby - path: CHANGELOG.asciidoc - exclude_branches: [ 1.x, 0.x ] - - title: APM Real User Monitoring JavaScript Agent - prefix: rum-js - current: 5.x - branches: [ {main: master}, 5.x, 4.x, 3.x, 2.x, 1.x, 0.x ] - live: [ 5.x, 4.x] - index: docs/index.asciidoc - tags: APM Real User Monitoring JavaScript Agent/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-agent-rum-js - path: docs - - - repo: apm-agent-rum-js - path: CHANGELOG.asciidoc - exclude_branches: [ 3.x, 2.x, 1.x, 0.x ] - - title: APM AWS Lambda Extension - prefix: lambda - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/index.asciidoc - tags: APM AWS Lambda extension/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-aws-lambda - path: docs - - - repo: apm-aws-lambda - path: CHANGELOG.asciidoc - - title: APM Attacher - prefix: attacher - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/index.asciidoc - tags: APM Attacher/Reference - subject: APM - chunk: 1 - sources: - - - repo: apm-k8s-attacher - path: docs - - title: ECS logging - base_dir: en/ecs-logging - sections: - - title: ECS Logging Overview - prefix: overview - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/index.asciidoc - chunk: 1 - tags: ECS-logging/Guide - subject: ECS Logging Overview - sources: - - - repo: ecs-logging - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - title: ECS Logging Go (Logrus) Reference - prefix: go-logrus - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/index.asciidoc - chunk: 1 - tags: ECS-logging/go-logrus/Guide - subject: ECS Logging Go (Logrus) Reference - sources: - - - repo: ecs-logging-go-logrus - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: ecs-logging - path: docs - - title: ECS Logging Go (Zap) Reference - prefix: go-zap - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/index.asciidoc - chunk: 1 - tags: ECS-logging/go-zap/Guide - subject: ECS Logging Go (Zap) Reference - sources: - - - repo: ecs-logging-go-zap - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: ecs-logging - path: docs - - title: ECS Logging Go (zerolog) Reference - prefix: go-zerolog - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/index.asciidoc - chunk: 1 - tags: ECS-logging/go-zerolog/Guide - subject: ECS Logging Go (zerolog) Reference - sources: - - - repo: ecs-logging-go-zerolog - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: ecs-logging - path: docs - - title: ECS Logging Java Reference - prefix: java - current: 1.x - branches: [ {main: master}, 1.x, 0.x ] - live: [ 1.x ] - index: docs/index.asciidoc - chunk: 1 - tags: ECS-logging/java/Guide - subject: ECS Logging Java Reference - sources: - - - repo: ecs-logging-java - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: ecs-logging - path: docs - map_branches: - 1.x: main - 0.x: main - - title: ECS Logging .NET Reference - prefix: dotnet - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/index.asciidoc - chunk: 1 - tags: ECS-logging/.NET/Guide - subject: ECS Logging .NET Reference - sources: - - - repo: ecs-dotnet - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: ecs-logging - path: docs - - title: ECS Logging Node.js Reference - prefix: nodejs - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/index.asciidoc - chunk: 1 - tags: ECS-logging/nodejs/Guide - subject: ECS Logging Node.js Reference - sources: - - - repo: ecs-logging-nodejs - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: ecs-logging - path: docs - - title: ECS Logging Ruby Reference - prefix: ruby - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/index.asciidoc - chunk: 1 - tags: ECS-logging/ruby/Guide - subject: ECS Logging Ruby Reference - sources: - - - repo: ecs-logging-ruby - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: ecs-logging - path: docs - - title: ECS Logging PHP Reference - prefix: php - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/index.asciidoc - chunk: 1 - tags: ECS-logging/php/Guide - subject: ECS Logging PHP Reference - sources: - - - repo: ecs-logging-php - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: ecs-logging - path: docs - - title: ECS Logging Python Reference - prefix: python - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/index.asciidoc - chunk: 1 - tags: ECS-logging/python/Guide - subject: ECS Logging Python Reference - sources: - - - repo: ecs-logging-python - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: ecs-logging - path: docs - - title: Security - sections: - - title: Elastic Security - prefix: en/security - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8 ] - live: *stacklive - index: docs/index.asciidoc - chunk: 1 - tags: Security/Guide - subject: Security - sources: - - - repo: security-docs - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: stack-docs - path: docs/en - - title: Elastic Stack - sections: - - title: "Starting with the Elasticsearch Platform and its Solutions" - prefix: en/starting-with-the-elasticsearch-platform-and-its-solutions - current: *stackcurrent - index: welcome-to-elastic/index.asciidoc - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 7.17 ] - live: [ *stackcurrent ] - chunk: 1 - tags: Elastic/Starting with the Elasticsearch Platform and its Solutions - subject: Starting with the Elasticsearch Platform and its Solutions - sources: - - - repo: tech-content - path: welcome-to-elastic - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: Curator Index Management - prefix: en/elasticsearch/client/curator - current: 8.0 - branches: [ 8.0, 7.0, 6.0, 5.8, 5.7, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.3, 4.2, 4.1, 4.0, 3.5, 3.4, 3.3 ] - index: docs/asciidoc/index.asciidoc - tags: Clients/Curator - subject: Clients - sources: - - - repo: curator - path: docs/asciidoc - - title: Elastic Common Schema (ECS) Reference - prefix: en/ecs - # Please do not update current to 8.17 - current: 8.16 - branches: [ {main: master}, 8.16, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 1.12, 1.11, 1.10, 1.9, 1.8, 1.7, 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0 ] - live: [ 8.16, 1.12 ] - index: docs/index.asciidoc - chunk: 2 - tags: Elastic Common Schema (ECS)/Reference - subject: Elastic Common Schema (ECS) - sources: - - - repo: ecs - path: docs/ - - title: Elasticsearch Clients - base_dir: en/elasticsearch/client - toc_extra: extra/client_docs_landing.html - sections: - - title: Java Client - prefix: java-api-client - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklive - index: docs/index.asciidoc - chunk: 1 - tags: Clients/Java - subject: Clients - sources: - - - repo: elasticsearch-java - path: docs/ - - - repo: elasticsearch-java - path: java-client/src/test/java/co/elastic/clients/documentation - - - repo: elasticsearch - path: docs/java-rest/ - - - repo: elasticsearch - path: client - - title: JavaScript Client - prefix: javascript-api - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 6.x, 5.x ] - live: *stacklive - index: docs/index.asciidoc - chunk: 1 - tags: Clients/JavaScript - subject: Clients - sources: - - - repo: elasticsearch-js - path: docs/ - - title: Ruby Client - prefix: ruby-api - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklive - index: docs/index.asciidoc - chunk: 1 - tags: Clients/Ruby - subject: Clients - sources: - - - repo: elasticsearch-ruby - path: docs/ - - title: Go Client - prefix: go-api - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklive - index: .doc/index.asciidoc - chunk: 1 - tags: Clients/Go - subject: Clients - sources: - - - repo: go-elasticsearch - path: .doc/ - - title: .NET Clients - prefix: net-api - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 6.x, 5.x, 2.x, 1.x ] - live: *stacklive - index: docs/index.asciidoc - tags: Clients/.Net - subject: Clients - chunk: 1 - sources: - - - repo: elasticsearch-net - path: docs/ - - - repo: elasticsearch-net - path: tests/Tests/Documentation - - title: PHP Client - prefix: php-api - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.x, 6.x, 5.x, 2.x, 1.x, 0.4 ] - live: *stacklive - index: docs/index.asciidoc - chunk: 1 - tags: Clients/PHP - subject: Clients - sources: - - - repo: elasticsearch-php - path: docs/ - - - repo: docs - path: shared/attributes.asciidoc - - title: Perl Client - prefix: perl-api - current: master - branches: [ master, 8.x, 7.x ] - live: [ master, 8.x, 7.x ] - index: docs/index.asciidoc - chunk: 1 - tags: Clients/Perl - subject: Clients - sources: - - - repo: elasticsearch-perl - path: docs/ - - title: Python Client - prefix: python-api - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklive - index: docs/guide/index.asciidoc - chunk: 1 - tags: Clients/Python - subject: Clients - sources: - - - repo: elasticsearch-py - path: docs/guide/ - - title: eland - prefix: eland - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/guide/index.asciidoc - chunk: 1 - tags: Clients/eland - subject: Clients - sources: - - - repo: eland - path: docs/guide - - title: Rust Client - prefix: rust-api - current: main - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] - live: [ main, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] - index: docs/index.asciidoc - chunk: 1 - tags: Clients/Rust - subject: Clients - sources: - - - repo: elasticsearch-rs - path: docs/ - - title: Java REST Client (deprecated) - prefix: java-rest - current: 7.17 - branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - live: [ 7.17, 6.8 ] - index: docs/java-rest/index.asciidoc - tags: Clients/JavaREST - subject: Clients - chunk: 1 - sources: - - - repo: elasticsearch - path: docs/java-rest - - - repo: elasticsearch - path: docs/Versions.asciidoc - - - repo: elasticsearch - path: client - exclude_branches: [ 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - title: Java Transport Client (deprecated) - prefix: java-api - current: 7.17 - branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - live: [7.17, 6.8] - index: docs/java-api/index.asciidoc - tags: Clients/Java - subject: Clients - chunk: 1 - sources: - - - repo: elasticsearch - path: docs/java-api - - - repo: elasticsearch - path: docs/Versions.asciidoc - exclude_branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: client/rest-high-level/src/test/java/org/elasticsearch/client - exclude_branches: [ 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - - repo: elasticsearch - path: server/src/internalClusterTest/java/org/elasticsearch/client/documentation - exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: server/src/test/java/org/elasticsearch/client/documentation - exclude_branches: [ 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: modules/reindex/src/internalClusterTest/java/org/elasticsearch/client/documentation - exclude_branches: [ 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: modules/reindex/src/test/java/org/elasticsearch/client/documentation - exclude_branches: [ 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - title: Community Contributed Clients - prefix: community - branches: [{main: master}] - current: main - index: docs/community-clients/index.asciidoc - single: 1 - tags: Clients/Community - subject: Clients - sources: - - - repo: elasticsearch - path: docs/community-clients - - title: Elasticsearch for Apache Hadoop and Spark - prefix: en/elasticsearch/hadoop - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0 ] - live: *stacklive - index: docs/src/reference/asciidoc/index.adoc - tags: Elasticsearch/Apache Hadoop - subject: Elasticsearch - sources: - - - repo: elasticsearch-hadoop - path: docs/src/reference/asciidoc - - title: Elasticsearch Relevance Engine (ESRE) - prefix: en/esre - index: esre-docs/index.asciidoc - private: 1 - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8 ] - live: [ 8.10 ] - chunk: 1 - tags: ESRE/Guide - subject: ESRE - sources: - - - repo: enterprise-search-pubs - path: esre-docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - title: Glossary - prefix: en/elastic-stack-glossary - current: main - index: docs/en/glossary/index.asciidoc - branches: [ {main: master} ] - tags: Elastic Stack/Glossary - subject: Elastic Stack - sources: - - - repo: stack-docs - path: docs/en - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - title: Installation and Upgrade Guide - prefix: en/elastic-stack - current: *stackcurrent - index: docs/en/install-upgrade/index.asciidoc - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - live: *stacklive - chunk: 1 - tags: Elastic Stack/Installation and Upgrade - subject: Elastic Stack - sources: - - - repo: stack-docs - path: docs/en - - - repo: apm-server - path: changelogs - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.5, 8.4, 8.3, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: apm-server - path: docs/ - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: beats - path: libbeat/docs - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: elasticsearch - path: docs/ - - - repo: elasticsearch-hadoop - path: docs/src/reference/asciidoc - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: security-docs - path: docs/ - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: kibana - path: docs/ - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: logstash - path: docs/ - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: observability-docs - path: docs/en/observability - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - map_branches: *mapMainToMaster - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: docs - path: shared/attributes62.asciidoc - exclude_branches: [ 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - title: Kibana Guide - prefix: en/kibana - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] - live: *stacklive - index: docs/index.x.asciidoc - chunk: 1 - tags: Kibana/Reference - subject: Kibana - toc_extra: extra/kibana_landing.html - sources: - - - repo: kibana - path: docs/ - - - repo: x-pack-kibana - prefix: kibana-extra/x-pack-kibana - path: docs/en - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: [ 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] - - - repo: docs - path: shared/attributes62.asciidoc - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] - - - repo: docs - path: shared/legacy-attrs.asciidoc - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 3.0 ] - - - repo: kibana - # git-archive requires `:(glob)` for ** to match no directory (in order to include `examples/README.asciidoc`) - path: ":(glob)examples/**/*.asciidoc" - exclude_branches: [ 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] - - - repo: kibana - path: ":(glob)src/**/*.asciidoc" - exclude_branches: [ 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] - - - repo: kibana - path: ":(glob)x-pack/**/*.asciidoc" - exclude_branches: [ 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] - - title: Machine Learning - prefix: en/machine-learning - current: *stackcurrent - index: docs/en/stack/ml/index.asciidoc - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3 ] - live: *stacklive - chunk: 1 - tags: Elastic Stack/Machine Learning - subject: Machine Learning - sources: - - - repo: stack-docs - path: docs/en/stack - - - repo: elasticsearch - path: docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: docs - path: shared/settings.asciidoc - - title: Painless Scripting Language - prefix: en/elasticsearch/painless - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5] - live: *stacklive - index: docs/painless/index.asciidoc - chunk: 1 - tags: Elasticsearch/Painless - subject: Elasticsearch - sources: - - - repo: elasticsearch - path: docs/painless - - - repo: elasticsearch - path: docs/Versions.asciidoc - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - title: Plugins and Integrations - prefix: en/elasticsearch/plugins - repo: elasticsearch - current: *stackcurrent - index: docs/plugins/index.asciidoc - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7 ] - live: *stacklive - chunk: 2 - tags: Elasticsearch/Plugins - subject: Elasticsearch - sources: - - - repo: elasticsearch - path: docs/plugins - - - repo: elasticsearch - path: docs/Versions.asciidoc - exclude_branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: buildSrc/src/main/resources/ - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: build-tools-internal/src/main/resources/ - exclude_branches: [7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: elasticsearch - path: build-tools/src/main/resources/ - exclude_branches: [ 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - title: Reference Architectures - prefix: en/reference-architectures - current: main - index: docs/en/reference-architectures/index.asciidoc - branches: [ {main: master} ] - tags: Reference Architectures - subject: Reference Architectures - sources: - - - repo: stack-docs - path: docs/en - - - repo: docs - path: shared/attributes.asciidoc - - title: "Ingest: Add your data" - sections: - - title: Elastic Ingest Reference Architectures - prefix: en/ingest - current: *stackcurrent - index: docs/en/ingest-arch/index.asciidoc - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9 ] - live: [ *stackcurrent ] - chunk: 1 - tags: Ingest/Reference - subject: Ingest - sources: - - - repo: ingest-docs - path: docs/en - - - repo: docs - path: shared/attributes.asciidoc - - title: Fleet and Elastic Agent Guide - prefix: en/fleet - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8 ] - live: *stacklive - index: docs/en/ingest-management/index.asciidoc - chunk: 2 - tags: Fleet/Guide/Elastic Agent - subject: Fleet and Elastic Agent - sources: - - - repo: ingest-docs - path: docs/en - - - repo: observability-docs - path: docs/en - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - # Required only for versions 7.12-7.15 - repo: apm-server - path: docs - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - title: Logstash Reference - prefix: en/logstash - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.5 ] - live: *stacklive - index: docs/index.x.asciidoc - chunk: 1 - tags: Logstash/Reference - subject: Logstash - respect_edit_url_overrides: true - sources: - - - repo: logstash - path: docs/ - - - repo: x-pack-logstash - prefix: logstash-extra/x-pack-logstash - path: docs/en - private: true - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.5 ] - - - repo: logstash-docs - path: docs/ - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: [ 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.5 ] - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.5 ] - - - repo: docs - path: shared/attributes62.asciidoc - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.5 ] - - - repo: docs - path: shared/legacy-attrs.asciidoc - exclude_branches: [ main, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0] - - title: Logstash Versioned Plugin Reference - prefix: en/logstash-versioned-plugins - current: versioned_plugin_docs - branches: [ versioned_plugin_docs ] - index: docs/versioned-plugins/index.asciidoc - private: 1 - chunk: 1 - noindex: 1 - tags: Logstash/Plugin Reference - subject: Logstash - sources: - - - repo: logstash-docs - path: docs/versioned-plugins - - - repo: docs - path: shared/attributes.asciidoc - - title: Elastic Logging Plugin for Docker - prefix: en/beats/loggingplugin - current: *stackcurrent - index: x-pack/dockerlogbeat/docs/index.asciidoc - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6 ] - chunk: 1 - tags: Elastic Logging Plugin/Reference - respect_edit_url_overrides: true - subject: Elastic Logging Plugin - sources: - - - repo: beats - path: x-pack/dockerlogbeat/docs - - - repo: beats - path: libbeat/docs - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - title: Elastic Serverless Forwarder Guide - prefix: en/esf - index: docs/en/index.asciidoc - current: main - branches: [ {main: master} ] - live: [ main ] - chunk: 2 - tags: Cloud Native Ingest/Reference - subject: cloud native ingest - sources: - - - repo: esf - path: docs/en - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - title: Integrations Developer Guide - prefix: en/integrations-developer - current: main - branches: [ {main: master} ] - live: [ main ] - index: docs/en/integrations/index.asciidoc - chunk: 1 - tags: Integrations/Developer - subject: Integrations - sources: - - - repo: observability-docs - path: docs/en - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: package-spec - path: versions - - - repo: package-spec - path: spec - - title: Auditbeat Reference - prefix: en/beats/auditbeat - index: auditbeat/docs/index.asciidoc - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0 ] - live: *stacklive - chunk: 1 - tags: Auditbeat/Reference - respect_edit_url_overrides: true - subject: Auditbeat - sources: - - - repo: beats - path: auditbeat - - - repo: beats - path: auditbeat/docs - - - repo: beats - path: x-pack/auditbeat - exclude_branches: [ 6.5, 6.4, 6.3, 6.2, 6.1, 6.0 ] - - - repo: beats - path: auditbeat/module - - - repo: beats - path: auditbeat/scripts - - - repo: beats - path: CHANGELOG.asciidoc - - - repo: beats - path: libbeat/docs - - - repo: beats - path: libbeat/processors/*/docs/* - exclude_branches: *beatsProcessorExclude - - - repo: beats - path: x-pack/libbeat/processors/*/docs/* - exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - - - repo: beats - path: x-pack/auditbeat/processors/*/docs/* - exclude_branches: [ 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - - - repo: beats - path: libbeat/outputs/*/docs/* - exclude_branches: *beatsOutputExclude - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: *beatsSharedExclude - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: *beatsSharedExclude - - title: Beats Developer Guide - prefix: en/beats/devguide - index: docs/devguide/index.asciidoc - current: main - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0 ] - live: *stacklive - chunk: 1 - tags: Devguide/Reference - subject: Beats - respect_edit_url_overrides: true - sources: - - - repo: beats - path: docs - - - repo: beats - path: libbeat/docs - - - repo: beats - path: metricbeat/module - - - repo: beats - path: metricbeat/scripts - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: *beatsSharedExclude - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: *beatsSharedExclude - - title: Beats Platform Reference - prefix: en/beats/libbeat - index: libbeat/docs/index.asciidoc - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1] - live: *stacklive - chunk: 1 - tags: Libbeat/Reference - subject: libbeat - respect_edit_url_overrides: true - sources: - - - repo: beats - path: libbeat/docs - - - repo: beats - path: CHANGELOG.asciidoc - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: *beatsSharedExclude - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: *beatsSharedExclude - - title: Filebeat Reference - prefix: en/beats/filebeat - index: filebeat/docs/index.asciidoc - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1] - live: *stacklive - chunk: 1 - tags: Filebeat/Reference - respect_edit_url_overrides: true - subject: Filebeat - sources: - - - repo: beats - path: filebeat - - - repo: beats - path: filebeat/docs - - - repo: beats - path: x-pack/filebeat/docs - exclude_branches: [ 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - - - repo: beats - path: x-pack/libbeat/docs - exclude_branches: *beatsXpackLibbeatExclude - - - repo: beats - path: CHANGELOG.asciidoc - - - repo: beats - path: libbeat/docs - - - repo: beats - path: libbeat/processors/*/docs/* - exclude_branches: *beatsProcessorExclude - - - repo: beats - path: x-pack/filebeat/processors/*/docs/* - exclude_branches: *beatsProcessorExclude - - - repo: beats - path: x-pack/libbeat/processors/*/docs/* - exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - - - repo: beats - path: libbeat/outputs/*/docs/* - exclude_branches: *beatsOutputExclude - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: *beatsSharedExclude - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: *beatsSharedExclude - - title: Heartbeat Reference - prefix: en/beats/heartbeat - current: *stackcurrent - index: heartbeat/docs/index.asciidoc - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2 ] - live: *stacklive - chunk: 1 - tags: Heartbeat/Reference - respect_edit_url_overrides: true - subject: Heartbeat - sources: - - - repo: beats - path: heartbeat - - - repo: beats - path: heartbeat/docs - - - repo: beats - path: CHANGELOG.asciidoc - - - repo: beats - path: libbeat/docs - - - repo: beats - path: x-pack/libbeat/docs - exclude_branches: *beatsXpackLibbeatExclude - - - repo: beats - path: libbeat/processors/*/docs/* - exclude_branches: *beatsProcessorExclude - - - repo: beats - path: x-pack/libbeat/processors/*/docs/* - exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - - - repo: beats - path: libbeat/outputs/*/docs/* - exclude_branches: *beatsOutputExclude - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: *beatsSharedExclude - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: *beatsSharedExclude - - title: Metricbeat Reference - prefix: en/beats/metricbeat - index: metricbeat/docs/index.asciidoc - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - live: *stacklive - chunk: 1 - tags: Metricbeat/Reference - respect_edit_url_overrides: true - subject: Metricbeat - sources: - - - repo: beats - path: metricbeat - - - repo: beats - path: metricbeat/docs - - - repo: beats - path: metricbeat/module - - - repo: beats - path: x-pack/libbeat/docs - exclude_branches: *beatsXpackLibbeatExclude - - - repo: beats - path: x-pack/metricbeat/module - exclude_branches: [ 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - repo: beats - path: metricbeat/scripts - - - repo: beats - path: CHANGELOG.asciidoc - - - repo: beats - path: libbeat/docs - - - repo: beats - path: libbeat/processors/*/docs/* - exclude_branches: *beatsProcessorExclude - - - repo: beats - path: x-pack/libbeat/processors/*/docs/* - exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - - - repo: beats - path: libbeat/outputs/*/docs/* - exclude_branches: *beatsOutputExclude - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: *beatsSharedExclude - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: *beatsSharedExclude - - title: Packetbeat Reference - prefix: en/beats/packetbeat - index: packetbeat/docs/index.asciidoc - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1] - live: *stacklive - chunk: 1 - tags: Packetbeat/Reference - respect_edit_url_overrides: true - subject: Packetbeat - sources: - - - repo: beats - path: packetbeat - - - repo: beats - path: packetbeat/docs - - - repo: beats - path: CHANGELOG.asciidoc - - - repo: beats - path: libbeat/docs - - - repo: beats - path: libbeat/processors/*/docs/* - exclude_branches: *beatsProcessorExclude - - - repo: beats - path: x-pack/libbeat/processors/*/docs/* - exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - - - repo: beats - path: libbeat/outputs/*/docs/* - exclude_branches: *beatsOutputExclude - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: *beatsSharedExclude - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: *beatsSharedExclude - - title: Winlogbeat Reference - prefix: en/beats/winlogbeat - index: winlogbeat/docs/index.asciidoc - current: *stackcurrent - branches: [ {main: master}, 8.x, 8.17, 8.16, 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1 ] - live: *stacklive - chunk: 1 - tags: Winlogbeat/Reference - respect_edit_url_overrides: true - subject: Winlogbeat - sources: - - - repo: beats - path: winlogbeat - - - repo: beats - path: winlogbeat/docs - - - repo: beats - path: CHANGELOG.asciidoc - - - repo: beats - path: libbeat/docs - - - repo: beats - path: libbeat/processors/*/docs/* - exclude_branches: *beatsProcessorExclude - - - repo: beats - path: x-pack/libbeat/processors/*/docs/* - exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - - - repo: beats - path: libbeat/outputs/*/docs/* - exclude_branches: *beatsOutputExclude - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: *beatsSharedExclude - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: *beatsSharedExclude - - - title: "Cloud: Provision, Manage, and Monitor the Elastic Stack" - sections: - - title: Elastic Cloud, Hosted Elastic Stack - prefix: en/cloud - tags: Cloud/Reference - subject: Elastic Cloud - current: *cloudSaasCurrent - branches: [ { *cloudSaasCurrent : latest} ] - index: docs/saas/index.asciidoc - chunk: 1 - private: 1 - sources: - - - repo: cloud - path: docs/saas - - - repo: cloud - path: docs/shared - - title: Elasticsearch Add-On for Heroku - Hosted Elasticsearch and Kibana for Heroku Users - prefix: en/cloud-heroku - tags: Cloud-Heroku/Reference - subject: Elasticsearch Add-On for Heroku - current: *cloudSaasCurrent - branches: [ { *cloudSaasCurrent : latest} ] - index: docs/heroku/index.asciidoc - chunk: 1 - noindex: 1 - private: 1 - sources: - - - repo: cloud - path: docs/saas - - - repo: cloud - path: docs/shared - - - repo: cloud - path: docs/heroku - - title: Elastic Cloud Enterprise - Elastic Cloud on your Infrastructure - prefix: en/cloud-enterprise - tags: CloudEnterprise/Reference - subject: ECE - current: ms-105 - live: - - ms-105 - - ms-92 - - ms-81 - - ms-78 - - ms-75 - - ms-72 - - ms-70 - - ms-69 - branches: - - ms-105: 3.7 - - ms-92: 3.6 - - ms-81: 3.5 - - ms-78: 3.4 - - ms-75: 3.3 - - ms-72: 3.2 - - ms-70: 3.1 - - ms-69: 3.0 - - ms-65: 2.13 - - ms-62: 2.12 - - ms-59: 2.11 - - ms-57: 2.10 - - ms-53: 2.9 - - ms-49: 2.8 - - ms-47: 2.7 - - release-ms-41: 2.6 - - 2.5 - - 2.4 - - 2.3 - - 2.2 - - 2.1 - - 2.0 - - 1.1 - - 1.0 - index: docs/cloud-enterprise/index.asciidoc - chunk: 2 - private: 1 - sources: - - - repo: cloud - # Grab the entire docs/ directory to get `ece-version.asciidoc` - path: docs - - - repo: cloud - path: docs/shared - exclude_branches: [ 1.0 ] - - - repo: docs - path: shared/versions/ece/{version}.asciidoc - - - repo: cloud-assets - path: docs - map_branches: - ms-105: master - ms-92: master - ms-81: master - ms-78: master - ms-75: master - ms-72: master - ms-70: master - ms-69: master - ms-65: master - ms-62: master - ms-59: master - ms-57: master - ms-53: master - ms-49: master - ms-47: master - release-ms-41: master - 2.5: master - 2.4: master - 2.3: master - 2.2: master - 2.1: master - 2.0: master - 1.1: master - 1.0: master - - - alternatives: { source_lang: console, alternative_lang: php } - repo: clients-team - path: docs/examples/elastic-cloud/php - map_branches: *mapCloudEceToClientsTeam - - - alternatives: { source_lang: console, alternative_lang: go } - repo: clients-team - path: docs/examples/elastic-cloud/go - map_branches: *mapCloudEceToClientsTeam - - - alternatives: { source_lang: console, alternative_lang: ruby } - repo: clients-team - path: docs/examples/elastic-cloud/ruby - map_branches: *mapCloudEceToClientsTeam - - - alternatives: { source_lang: console, alternative_lang: java } - repo: clients-team - path: docs/examples/elastic-cloud/java - map_branches: *mapCloudEceToClientsTeam - - - alternatives: { source_lang: console, alternative_lang: javascript } - repo: clients-team - path: docs/examples/elastic-cloud/javascript - map_branches: *mapCloudEceToClientsTeam - - - alternatives: { source_lang: console, alternative_lang: python } - repo: clients-team - path: docs/examples/elastic-cloud/python - map_branches: *mapCloudEceToClientsTeam - - - alternatives: { source_lang: console, alternative_lang: csharp } - repo: clients-team - path: docs/examples/elastic-cloud/csharp - map_branches: *mapCloudEceToClientsTeam - - title: Elastic Cloud on Kubernetes - prefix: en/cloud-on-k8s - tags: Kubernetes/Reference - subject: ECK - current: 2.16 - branches: [ {main: master}, 2.16, 2.15, 2.14, 2.13, 2.12, 2.11, 2.10, 2.9, 2.8, 2.7, 2.6, 2.5, 2.4, 2.3, 2.2, 2.1, 2.0, 1.9, 1.8, 1.7, 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0, 1.0-beta, 0.9, 0.8 ] - index: docs/index.asciidoc - chunk: 1 - sources: - - - repo: cloud-on-k8s - path: docs/ - - - repo: docs - path: shared/versions/stack/current.asciidoc - exclude_branches: [ 0.9, 0.8 ] - - - repo: docs - path: shared/attributes.asciidoc - - title: Elastic Cloud Control - The Command-Line Interface for Elasticsearch Service and ECE - prefix: en/ecctl - tags: CloudControl/Reference - subject: ECCTL - current: 1.14 - branches: [ master, 1.14, 1.13, 1.12, 1.11, 1.10, 1.9, 1.8, 1.7, 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0 ] - index: docs/index.asciidoc - chunk: 1 - sources: - - - repo: ecctl - path: docs/ - - title: Elastic Cloud Terraform Provider - prefix: en/tpec - tags: CloudTerraform/Reference - subject: TPEC - current: master - branches: [ master ] - index: docs-elastic/index.asciidoc - single: 1 - chunk: 1 - sources: - - - repo: terraform-provider-ec - path: docs-elastic/ - - - title: Legacy Documentation - sections: - - title: Elastic Stack and Google Cloud's Anthos - noindex: 1 - prefix: en/elastic-stack-gke - current: main - index: docs/en/gke-on-prem/index.asciidoc - branches: [ {main: master} ] - private: 1 - chunk: 1 - tags: Elastic Stack/Google - subject: Elastic Stack - sources: - - - repo: stack-docs - path: docs/en/gke-on-prem - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - title: Elasticsearch - The Definitive Guide - noindex: 1 - prefix: en/elasticsearch/guide - current: 2.x - branches: [ master, 2.x, 1.x ] - index: book.asciidoc - chunk: 1 - private: 1 - tags: Legacy/Elasticsearch/Definitive Guide - subject: Elasticsearch - suppress_migration_warnings: true - sources: - - - repo: guide - path: / - - - repo: docs - path: shared/legacy-attrs.asciidoc - exclude_branches: [ master, 2.x] - - - title: Elasticsearch Resiliency Status - noindex: 1 - prefix: en/elasticsearch/resiliency - toc: 1 - branches: [{main: master}] - current: main - index: docs/resiliency/index.asciidoc - single: 1 - tags: Elasticsearch/Resiliency Status - subject: Elasticsearch - sources: - - - repo: elasticsearch - path: docs/resiliency - - - repo: elasticsearch - path: docs/Versions.asciidoc - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - repo: docs - path: shared/attributes.asciidoc - exclude_branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - title: Elasticsearch.js for 5.6-7.6 - noindex: 1 - prefix: en/elasticsearch/client/elasticsearch-js - current: 16.x - branches: [ 16.x ] - index: docs/index.asciidoc - chunk: 1 - private: 1 - tags: Legacy/Clients/Elasticsearch-js - subject: Clients - sources: - - - repo: elasticsearch-js-legacy - path: docs - - - title: Functionbeat Reference - noindex: 1 - prefix: en/beats/functionbeat - current: 8.15 - index: x-pack/functionbeat/docs/index.asciidoc - branches: [ 8.15, 8.14, 8.13, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5 ] - chunk: 1 - tags: Functionbeat/Reference - respect_edit_url_overrides: true - subject: Functionbeat - sources: - - - repo: beats - path: x-pack/functionbeat - - - repo: beats - path: x-pack/functionbeat/docs - - - repo: beats - path: CHANGELOG.asciidoc - - - repo: beats - path: libbeat/docs - - - repo: beats - path: libbeat/processors/*/docs/* - exclude_branches: *beatsProcessorExclude - - - repo: beats - path: x-pack/libbeat/processors/*/docs/* - exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - - - repo: beats - path: libbeat/outputs/*/docs/* - exclude_branches: *beatsOutputExclude - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: beats - path: x-pack/libbeat/docs - exclude_branches: *beatsXpackLibbeatExclude - - - repo: beats - path: filebeat/docs - exclude_branches: [ 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2 ] - - - title: Getting Started - noindex: 1 - prefix: en/elastic-stack-get-started - current: 8.2 - index: docs/en/getting-started/index.asciidoc - branches: [ 8.2, 8.1, 8.0, 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3 ] - chunk: 1 - tags: Elastic Stack/Getting started - subject: Elastic Stack - sources: - - - repo: stack-docs - path: docs/en - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: elasticsearch - path: docs/ - exclude_branches: [ 7.17, 7.16, 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3 ] - - - title: Graph Reference for 2.x - noindex: 1 - prefix: en/graph - repo: x-pack - chunk: 1 - private: 1 - tags: Legacy/Graph/Reference - subject: Graph - current: 2.4 - index: docs/public/graph/index.asciidoc - branches: [ 2.4, 2.3 ] - sources: - - - repo: x-pack - path: docs/public/graph - - - repo: docs - path: shared/legacy-attrs.asciidoc - - - title: Groovy API - noindex: 1 - prefix: en/elasticsearch/client/groovy-api - current: 2.4 - branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - index: docs/groovy-api/index.asciidoc - private: 1 - tags: Legacy/Clients/Groovy - subject: Clients - sources: - - - repo: elasticsearch - path: docs/groovy-api - - - repo: elasticsearch - path: docs/Versions.asciidoc - exclude_branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - - - title: Infrastructure Monitoring Guide for 6.5-7.4 - noindex: 1 - prefix: en/infrastructure/guide - current: 7.4 - branches: [ 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5 ] - index: docs/en/infraops/index.asciidoc - chunk: 1 - private: 1 - tags: Infrastructure/Guide - subject: Infrastructure - sources: - - - repo: stack-docs - path: docs/en - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - title: Journalbeat Reference for 6.5-7.15 - noindex: 1 - prefix: en/beats/journalbeat - current: 7.15 - index: journalbeat/docs/index.asciidoc - branches: [ 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5 ] - chunk: 1 - tags: Journalbeat/Reference - respect_edit_url_overrides: true - subject: Journalbeat - sources: - - - repo: beats - path: journalbeat - - - repo: beats - path: journalbeat/docs - - - repo: beats - path: CHANGELOG.asciidoc - - - repo: beats - path: libbeat/docs - - - repo: beats - path: libbeat/processors/*/docs/* - exclude_branches: *beatsProcessorExclude - - - repo: beats - path: x-pack/libbeat/processors/*/docs/* - exclude_branches: [ 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 1.3, 1.2, 1.1, 1.0.1 ] - - - repo: beats - path: libbeat/outputs/*/docs/* - exclude_branches: *beatsOutputExclude - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - title: Legacy APM Overview - noindex: 1 - prefix: get-started - index: docs/guide/index.asciidoc - current: 7.15 - branches: [ 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0 ] - chunk: 1 - tags: APM Server/Reference - subject: APM - sources: - - - repo: apm-server - path: docs/guide - - - repo: apm-server - path: docs - - - title: Legacy APM Server Reference - noindex: 1 - prefix: server - index: docs/index.asciidoc - current: 7.15 - branches: [ 7.15, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3, 6.2, 6.1, 6.0 ] - chunk: 1 - tags: APM Server/Reference - subject: APM - sources: - - - repo: apm-server - path: changelogs - exclude_branches: [ 6.0 ] - - - repo: apm-server - path: docs - - - repo: apm-server - path: CHANGELOG.asciidoc - - - title: Logs Monitoring Guide for 7.5-7.9 - noindex: 1 - prefix: en/logs/guide - current: 7.9 - branches: [ 7.9, 7.8, 7.7, 7.6, 7.5 ] - index: docs/en/logs/index.asciidoc - chunk: 1 - private: 1 - tags: Logs/Guide - subject: Logs - sources: - - - repo: observability-docs - path: docs/en - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - title: Marvel Reference for 2.x and 1.x - noindex: 1 - prefix: en/marvel - chunk: 1 - private: 1 - tags: Legacy/Marvel/Reference - subject: Marvel - current: 2.4 - index: docs/public/marvel/index.asciidoc - branches: [ 2.4, 2.3, 2.2, 2.1, 2.0, {marvel-1.3: 1.3}] - sources: - - - repo: x-pack - path: docs/public/marvel - - - repo: docs - path: shared/legacy-attrs.asciidoc - exclude_branches: [marvel-1.3] - - - title: Metrics Monitoring Guide for 7.5-7.9 - noindex: 1 - prefix: en/metrics/guide - current: 7.9 - branches: [ 7.9, 7.8, 7.7, 7.6, 7.5 ] - index: docs/en/metrics/index.asciidoc - chunk: 1 - private: 1 - tags: Metrics/Guide - subject: Metrics - sources: - - - repo: observability-docs - path: docs/en - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - title: Reporting Reference for 2.x - noindex: 1 - prefix: en/reporting - chunk: 1 - private: 1 - tags: Legacy/Reporting/Reference - subject: Reporting - current: 2.4 - index: docs/public/reporting/index.asciidoc - branches: [ 2.4 ] - sources: - - - repo: x-pack - path: docs/public/reporting - - - title: Sense Editor for 4.x - noindex: 1 - prefix: en/sense - current: master - branches: [ master ] - index: docs/index.asciidoc - private: 1 - tags: Legacy/Elasticsearch/Sense-Editor - subject: Sense - sources: - - - repo: sense - path: docs - - - title: Shield Reference for 2.x and 1.x - noindex: 1 - prefix: en/shield - chunk: 1 - private: 1 - tags: Legacy/Shield/Reference - subject: Shield - current: 2.4 - index: docs/public/shield/index.asciidoc - branches: [2.4, 2.3, 2.2, 2.1, 2.0, {shield-1.3: 1.3}, {shield-1.2: 1.2}, {shield-1.1: 1.1}, {shield-1.0: 1.0}] - sources: - - - repo: x-pack - path: docs/public/shield - - - repo: docs - path: shared/legacy-attrs.asciidoc - exclude_branches: [shield-1.2, shield-1.1 , shield-1.0] - - - title: SIEM Guide - noindex: 1 - prefix: en/siem/guide - current: 7.8 - branches: [ 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2 ] - index: docs/en/siem/index.asciidoc - chunk: 1 - tags: SIEM/Guide - subject: SIEM - sources: - - - repo: stack-docs - path: docs/en - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - title: Site Search Reference - noindex: 1 - prefix: en/swiftype/sitesearch - index: docs/sitesearch/index.asciidoc - private: 1 - current: master - branches: [ master ] - single: 1 - tags: Site Search/Reference - subject: Swiftype - sources: - - - repo: swiftype - path: docs - - - title: Topbeat Reference - noindex: 1 - prefix: en/beats/topbeat - index: topbeat/docs/index.asciidoc - current: 1.3 - branches: [ 1.3, 1.2, 1.1, 1.0.1 ] - chunk: 1 - tags: Legacy/Topbeat/Reference - respect_edit_url_overrides: true - subject: Topbeat - sources: - - - repo: beats - path: topbeat/docs - - - repo: beats - path: CHANGELOG.asciidoc - - - repo: beats - path: libbeat/docs - - - title: Uptime Monitoring Guide for 7.2-7.9 - noindex: 1 - prefix: en/uptime - current: 7.9 - branches: [ 7.9, 7.8, 7.7, 7.6, 7.5, 7.4, 7.3, 7.2 ] - index: docs/en/uptime/index.asciidoc - chunk: 1 - private: 1 - tags: Uptime/Guide - subject: Uptime - sources: - - - repo: observability-docs - path: docs/en - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - title: Stack Overview - noindex: 1 - prefix: en/elastic-stack-overview - current: 7.4 - index: docs/en/stack/index.asciidoc - branches: [ 7.4, 7.3, 7.2, 7.1, 7.0, 6.8, 6.7, 6.6, 6.5, 6.4, 6.3 ] - chunk: 1 - tags: Legacy/Elastic Stack/Overview - subject: Elastic Stack - sources: - - - repo: stack-docs - path: docs/en/stack - - - repo: docs - path: shared/versions/stack/{version}.asciidoc - - - repo: docs - path: shared/attributes.asciidoc - - - repo: docs - path: shared/settings.asciidoc - - - title: Watcher Reference for 2.x and 1.x - noindex: 1 - prefix: en/watcher - chunk: 1 - private: 1 - tags: Legacy/Watcher/Reference - subject: Watcher - current: 2.4 - index: docs/public/watcher/index.asciidoc - branches: [2.4, 2.3, 2.2, 2.1, 2.0, {watcher-1.0: 1.0}] - sources: - - - repo: x-pack - path: docs/public/watcher - - - repo: docs - path: shared/legacy-attrs.asciidoc - - - title: X-Pack Reference for 6.0-6.2 and 5.x - noindex: 1 - prefix: en/x-pack - chunk: 1 - private: 1 - tags: Legacy/XPack/Reference - current: 6.2 - subject: X-Pack - index: docs/en/index.asciidoc - branches: [ 6.2, 6.1, 6.0, 5.6, 5.5, 5.4, 5.3, 5.2, 5.1, 5.0 ] - sources: - - - repo: x-pack - path: docs/en - - - repo: x-pack-kibana - prefix: kibana-extra/x-pack-kibana - path: docs/en - exclude_branches: [ master, 6.7, 6.5, 6.4, 6.3, 5.3, 5.2, 5.1, 5.0] - - - repo: x-pack-elasticsearch - prefix: elasticsearch-extra/x-pack-elasticsearch - path: docs/en - exclude_branches: [ master, 6.7, 6.5, 6.4, 6.3, 5.3, 5.2, 5.1, 5.0] - - - repo: docs - path: shared/attributes62.asciidoc - exclude_branches: [ 5.4, 5.3, 5.2, 5.1, 5.0 ] - - - title: 简体中文 - base_dir: cn - lang: zh_cn - sections: - - title: 《Elasticsearch 权威指南》中文版 - noindex: 1 - prefix: elasticsearch/guide - index: book.asciidoc - current: cn - branches: [ {cn: 2.x} ] - chunk: 1 - private: 1 - lang: zh_cn - tags: Elasticsearch/Definitive Guide - subject: Elasticsearch - suppress_migration_warnings: true - sources: - - - repo: guide-cn - path: / - - title: PHP API - noindex: 1 - prefix: elasticsearch/php - index: index.asciidoc - current: cn - branches: [ {cn: 6.0} ] - lang: zh_cn - tags: Elasticsearch/PHP - subject: Elasticsearch - sources: - - - repo: elasticsearch-php-cn - path: / - - title: Kibana 用户手册 - noindex: 1 - prefix: kibana - index: docs/index.asciidoc - current: cn - branches: [ {cn: 6.0} ] - lang: zh_cn - chunk: 1 - private: 1 - tags: Kibana/Reference - subject: Kibana - sources: - - - repo: kibana-cn - path: /docs - - title: 日本語 - base_dir: jp - lang: ja - sections: - - title: Elasticsearchリファレンス - noindex: 1 - prefix: elasticsearch/reference - index: docs/jp/reference/gs-index.asciidoc - current: 5.4 - branches: [ 5.4, 5.3 ] - chunk: 1 - private: 1 - lang: ja - tags: Elasticsearch/Reference - subject: Elasticsearch - sources: - - - repo: elasticsearch - path: /docs/jp/reference - - - repo: elasticsearch - path: /docs - - title: Logstashリファレンス - noindex: 1 - prefix: logstash - index: docs/jp/gs-index.asciidoc - current: 5.4 - branches: [ 5.4, 5.3 ] - chunk: 1 - private: 1 - lang: ja - tags: Logstash/Reference - subject: Logstash - sources: - - - repo: logstash - path: /docs/jp - - title: Kibanaユーザーガイド - noindex: 1 - prefix: kibana - index: docs/jp/gs-index.asciidoc - current: 5.4 - branches: [ 5.4, 5.3 ] - chunk: 1 - private: 1 - lang: ja - tags: Kibana/Reference - subject: Kibana - sources: - - - repo: kibana - path: /docs/jp - - title: X-Packリファレンス - noindex: 1 - prefix: x-pack - index: docs/jp/gs-index.asciidoc - current: 5.4 - branches: [ 5.4 ] - chunk: 1 - private: 1 - lang: ja - tags: X-Pack/Reference - subject: X-Pack - sources: - - - repo: x-pack - path: /docs/jp - - - repo: x-pack-kibana - path: docs/jp - prefix: kibana-extra/x-pack-kibana - - - repo: x-pack-elasticsearch - path: /docs/jp - prefix: elasticsearch-extra/x-pack-elasticsearch - - title: 한국어 - base_dir: kr - lang: ko - sections: - - title: Elasticsearch 참조 - noindex: 1 - prefix: elasticsearch/reference - index: docs/kr/reference/gs-index.asciidoc - current: 5.4 - branches: [ 5.4, 5.3 ] - chunk: 1 - private: 1 - lang: ko - tags: Elasticsearch/Reference - subject: Elasticsearch - sources: - - - repo: elasticsearch - path: /docs/kr/reference - - - repo: elasticsearch - path: /docs - - title: Logstash 참조 - noindex: 1 - prefix: logstash - index: docs/kr/gs-index.asciidoc - current: 5.4 - branches: [ 5.4, 5.3 ] - chunk: 1 - private: 1 - lang: ko - tags: Logstash/Reference - subject: Logstash - sources: - - - repo: logstash - path: /docs/kr - - title: Kibana 사용자 가이드 - noindex: 1 - prefix: kibana - index: docs/kr/gs-index.asciidoc - current: 5.4 - branches: [ 5.4, 5.3 ] - chunk: 1 - private: 1 - lang: ko - tags: Kibana/Reference - subject: Kibana - sources: - - - repo: kibana - path: /docs/kr - - title: X-Pack 참조 - noindex: 1 - prefix: x-pack - index: docs/kr/gs-index.asciidoc - current: 5.4 - branches: [ 5.4 ] - chunk: 1 - private: 1 - lang: ko - tags: X-Pack/Reference - subject: X-Pack - sources: - - - repo: x-pack - path: /docs/kr - - - repo: x-pack-kibana - path: /docs/kr - prefix: kibana-extra/x-pack-kibana - - - repo: x-pack-elasticsearch - path: /docs/kr - prefix: elasticsearch-extra/x-pack-elasticsearch - -redirects: - - - prefix: en/ - redirect: /guide - - - prefix: en/elasticsearch - redirect: /guide - - - prefix: cn/elasticsearch - redirect: /cn diff --git a/docs/source/migration/freeze/scripts/codeowner-gen/output.md b/docs/source/migration/freeze/scripts/codeowner-gen/output.md deleted file mode 100644 index cc6740685..000000000 --- a/docs/source/migration/freeze/scripts/codeowner-gen/output.md +++ /dev/null @@ -1,576 +0,0 @@ -### [apm-agent-android](https://github.com/elastic/apm-agent-android) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-agent-dotnet](https://github.com/elastic/apm-agent-dotnet) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-agent-go](https://github.com/elastic/apm-agent-go) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-agent-ios](https://github.com/elastic/apm-agent-ios) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-agent-java](https://github.com/elastic/apm-agent-java) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-agent-nodejs](https://github.com/elastic/apm-agent-nodejs) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-agent-php](https://github.com/elastic/apm-agent-php) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-agent-python](https://github.com/elastic/apm-agent-python) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-agent-ruby](https://github.com/elastic/apm-agent-ruby) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-agent-rum-js](https://github.com/elastic/apm-agent-rum-js) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-aws-lambda](https://github.com/elastic/apm-aws-lambda) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-k8s-attacher](https://github.com/elastic/apm-k8s-attacher) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [apm-server](https://github.com/elastic/apm-server) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -changelogs/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -docs/data/*.asciidoc @elastic/docs-freeze-team -docs/guide/*.asciidoc @elastic/docs-freeze-team -docs/spec/*.asciidoc @elastic/docs-freeze-team -``` - -### [beats](https://github.com/elastic/beats) - -``` -CHANGELOG.asciidoc/*.asciidoc @elastic/docs-freeze-team -auditbeat/*.asciidoc @elastic/docs-freeze-team -auditbeat/docs/*.asciidoc @elastic/docs-freeze-team -auditbeat/module/*.asciidoc @elastic/docs-freeze-team -auditbeat/scripts/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -filebeat/*.asciidoc @elastic/docs-freeze-team -filebeat/docs/*.asciidoc @elastic/docs-freeze-team -heartbeat/*.asciidoc @elastic/docs-freeze-team -heartbeat/docs/*.asciidoc @elastic/docs-freeze-team -journalbeat/*.asciidoc @elastic/docs-freeze-team -journalbeat/docs/*.asciidoc @elastic/docs-freeze-team -libbeat/docs/*.asciidoc @elastic/docs-freeze-team -libbeat/outputs/*/docs/*/*.asciidoc @elastic/docs-freeze-team -libbeat/processors/*/docs/*/*.asciidoc @elastic/docs-freeze-team -metricbeat/*.asciidoc @elastic/docs-freeze-team -metricbeat/docs/*.asciidoc @elastic/docs-freeze-team -metricbeat/module/*.asciidoc @elastic/docs-freeze-team -metricbeat/scripts/*.asciidoc @elastic/docs-freeze-team -packetbeat/*.asciidoc @elastic/docs-freeze-team -packetbeat/docs/*.asciidoc @elastic/docs-freeze-team -topbeat/docs/*.asciidoc @elastic/docs-freeze-team -winlogbeat/*.asciidoc @elastic/docs-freeze-team -winlogbeat/docs/*.asciidoc @elastic/docs-freeze-team -x-pack/auditbeat/*.asciidoc @elastic/docs-freeze-team -x-pack/auditbeat/processors/*/docs/*/*.asciidoc @elastic/docs-freeze-team -x-pack/dockerlogbeat/docs/*.asciidoc @elastic/docs-freeze-team -x-pack/filebeat/docs/*.asciidoc @elastic/docs-freeze-team -x-pack/filebeat/processors/*/docs/*/*.asciidoc @elastic/docs-freeze-team -x-pack/functionbeat/*.asciidoc @elastic/docs-freeze-team -x-pack/functionbeat/docs/*.asciidoc @elastic/docs-freeze-team -x-pack/libbeat/docs/*.asciidoc @elastic/docs-freeze-team -x-pack/libbeat/processors/*/docs/*/*.asciidoc @elastic/docs-freeze-team -x-pack/metricbeat/module/*.asciidoc @elastic/docs-freeze-team -``` - -### [clients-team](https://github.com/elastic/clients-team) - -``` -docs/examples/elastic-cloud/csharp/*.asciidoc @elastic/docs-freeze-team -docs/examples/elastic-cloud/go/*.asciidoc @elastic/docs-freeze-team -docs/examples/elastic-cloud/java/*.asciidoc @elastic/docs-freeze-team -docs/examples/elastic-cloud/javascript/*.asciidoc @elastic/docs-freeze-team -docs/examples/elastic-cloud/php/*.asciidoc @elastic/docs-freeze-team -docs/examples/elastic-cloud/python/*.asciidoc @elastic/docs-freeze-team -docs/examples/elastic-cloud/ruby/*.asciidoc @elastic/docs-freeze-team -``` - -### [cloud](https://github.com/elastic/cloud) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -docs/heroku/*.asciidoc @elastic/docs-freeze-team -docs/saas/*.asciidoc @elastic/docs-freeze-team -docs/shared/*.asciidoc @elastic/docs-freeze-team -``` - -### [cloud-assets](https://github.com/elastic/cloud-assets) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [cloud-on-k8s](https://github.com/elastic/cloud-on-k8s) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [curator](https://github.com/elastic/curator) - -``` -docs/asciidoc/*.asciidoc @elastic/docs-freeze-team -``` - -### [docs](#) - -``` -shared/attributes.asciidoc/*.asciidoc @elastic/docs-freeze-team -shared/attributes62.asciidoc/*.asciidoc @elastic/docs-freeze-team -shared/legacy-attrs.asciidoc/*.asciidoc @elastic/docs-freeze-team -shared/settings.asciidoc/*.asciidoc @elastic/docs-freeze-team -shared/versions/ece/{version}.asciidoc/*.asciidoc @elastic/docs-freeze-team -shared/versions/stack/current.asciidoc/*.asciidoc @elastic/docs-freeze-team -shared/versions/stack/{version}.asciidoc/*.asciidoc @elastic/docs-freeze-team -``` - -### [docs-content](https://github.com/elastic/docs-content) - -``` -serverless/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecctl](https://github.com/elastic/ecctl) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecs](https://github.com/elastic/ecs) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecs-dotnet](https://github.com/elastic/ecs-dotnet) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecs-logging](https://github.com/elastic/ecs-logging) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecs-logging-go-logrus](https://github.com/elastic/ecs-logging-go-logrus) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecs-logging-go-zap](https://github.com/elastic/ecs-logging-go-zap) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecs-logging-go-zerolog](https://github.com/elastic/ecs-logging-go-zerolog) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecs-logging-java](https://github.com/elastic/ecs-logging-java) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecs-logging-nodejs](https://github.com/elastic/ecs-logging-nodejs) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecs-logging-php](https://github.com/elastic/ecs-logging-php) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecs-logging-python](https://github.com/elastic/ecs-logging-python) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [ecs-logging-ruby](https://github.com/elastic/ecs-logging-ruby) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [eland](https://github.com/elastic/eland) - -``` -docs/guide/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch](https://github.com/elastic/elasticsearch) - -``` -/docs/*.asciidoc @elastic/docs-freeze-team -/docs/jp/reference/*.asciidoc @elastic/docs-freeze-team -/docs/kr/reference/*.asciidoc @elastic/docs-freeze-team -build-tools-internal/*.asciidoc @elastic/docs-freeze-team -build-tools-internal/src/main/resources/*.asciidoc @elastic/docs-freeze-team -build-tools/src/main/resources/*.asciidoc @elastic/docs-freeze-team -buildSrc/*.asciidoc @elastic/docs-freeze-team -buildSrc/src/main/resources/*.asciidoc @elastic/docs-freeze-team -client/*.asciidoc @elastic/docs-freeze-team -client/rest-high-level/src/test/java/org/elasticsearch/client/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -docs/Versions.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/community-clients/*.asciidoc @elastic/docs-freeze-team -docs/groovy-api/*.asciidoc @elastic/docs-freeze-team -docs/java-api/*.asciidoc @elastic/docs-freeze-team -docs/java-rest/*.asciidoc @elastic/docs-freeze-team -docs/painless/*.asciidoc @elastic/docs-freeze-team -docs/plugins/*.asciidoc @elastic/docs-freeze-team -docs/reference/*.asciidoc @elastic/docs-freeze-team -docs/resiliency/*.asciidoc @elastic/docs-freeze-team -docs/src/test/cluster/config/*.asciidoc @elastic/docs-freeze-team -modules/reindex/src/internalClusterTest/java/org/elasticsearch/client/documentation/*.asciidoc @elastic/docs-freeze-team -modules/reindex/src/test/java/org/elasticsearch/client/documentation/*.asciidoc @elastic/docs-freeze-team -plugins/examples/*.asciidoc @elastic/docs-freeze-team -server/src/internalClusterTest/java/org/elasticsearch/client/documentation/*.asciidoc @elastic/docs-freeze-team -server/src/main/resources/org/elasticsearch/common/*.asciidoc @elastic/docs-freeze-team -server/src/test/java/org/elasticsearch/client/documentation/*.asciidoc @elastic/docs-freeze-team -x-pack/docs/*.asciidoc @elastic/docs-freeze-team -x-pack/plugin/esql/qa/testFixtures/src/main/resources/*.asciidoc @elastic/docs-freeze-team -x-pack/plugin/sql/qa/*.asciidoc @elastic/docs-freeze-team -x-pack/qa/sql/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch-hadoop](https://github.com/elastic/elasticsearch-hadoop) - -``` -docs/src/reference/asciidoc/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch-java](https://github.com/elastic/elasticsearch-java) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -java-client/src/test/java/co/elastic/clients/documentation/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch-js](https://github.com/elastic/elasticsearch-js) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -docs/doc_examples/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch-js-legacy](https://github.com/elastic/elasticsearch-js-legacy) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch-net](https://github.com/elastic/elasticsearch-net) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -tests/Tests/Documentation/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch-perl](https://github.com/elastic/elasticsearch-perl) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch-php](https://github.com/elastic/elasticsearch-php) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -docs/examples/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch-php-cn](https://github.com/elasticsearch-cn/elasticsearch-php) - -``` -/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch-py](https://github.com/elastic/elasticsearch-py) - -``` -docs/examples/*.asciidoc @elastic/docs-freeze-team -docs/guide/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch-rs](https://github.com/elastic/elasticsearch-rs) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [elasticsearch-ruby](https://github.com/elastic/elasticsearch-ruby) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -docs/examples/guide/*.asciidoc @elastic/docs-freeze-team -``` - -### [enterprise-search-js](https://github.com/elastic/enterprise-search-js) - -``` -packages/enterprise-search/docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [enterprise-search-php](https://github.com/elastic/enterprise-search-php) - -``` -docs/guide/*.asciidoc @elastic/docs-freeze-team -``` - -### [enterprise-search-pubs](https://github.com/elastic/enterprise-search-pubs) - -``` -app-search-docs/*.asciidoc @elastic/docs-freeze-team -client-docs/app-search-javascript/*.asciidoc @elastic/docs-freeze-team -client-docs/app-search-node/*.asciidoc @elastic/docs-freeze-team -client-docs/workplace-search-node/*.asciidoc @elastic/docs-freeze-team -enterprise-search-docs/*.asciidoc @elastic/docs-freeze-team -esre-docs/*.asciidoc @elastic/docs-freeze-team -workplace-search-docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [enterprise-search-python](https://github.com/elastic/enterprise-search-python) - -``` -docs/guide/*.asciidoc @elastic/docs-freeze-team -``` - -### [enterprise-search-ruby](https://github.com/elastic/enterprise-search-ruby) - -``` -docs/guide/*.asciidoc @elastic/docs-freeze-team -``` - -### [esf](https://github.com/elastic/elastic-serverless-forwarder) - -``` -docs/en/*.asciidoc @elastic/docs-freeze-team -``` - -### [go-elasticsearch](https://github.com/elastic/go-elasticsearch) - -``` -.doc/*.asciidoc @elastic/docs-freeze-team -.doc/examples/doc/*.asciidoc @elastic/docs-freeze-team -``` - -### [guide](https://github.com/elastic/elasticsearch-definitive-guide) - -``` -/*.asciidoc @elastic/docs-freeze-team -``` - -### [guide-cn](https://github.com/elasticsearch-cn/elasticsearch-definitive-guide) - -``` -/*.asciidoc @elastic/docs-freeze-team -``` - -### [ingest-docs](https://github.com/elastic/ingest-docs) - -``` -docs/en/*.asciidoc @elastic/docs-freeze-team -``` - -### [integration-docs](https://github.com/elastic/integration-docs) - -``` -dist/*.asciidoc @elastic/docs-freeze-team -``` - -### [kibana](https://github.com/elastic/kibana) - -``` -/docs/jp/*.asciidoc @elastic/docs-freeze-team -/docs/kr/*.asciidoc @elastic/docs-freeze-team -:(glob)examples/**/*.asciidoc/*.asciidoc @elastic/docs-freeze-team -:(glob)src/**/*.asciidoc/*.asciidoc @elastic/docs-freeze-team -:(glob)x-pack/**/*.asciidoc/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [kibana-cn](https://github.com/elasticsearch-cn/kibana) - -``` -/docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [logstash](https://github.com/elastic/logstash) - -``` -/docs/jp/*.asciidoc @elastic/docs-freeze-team -/docs/kr/*.asciidoc @elastic/docs-freeze-team -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [logstash-docs](https://github.com/elastic/logstash-docs) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -docs/versioned-plugins/*.asciidoc @elastic/docs-freeze-team -``` - -### [observability-docs](https://github.com/elastic/observability-docs) - -``` -docs/en/*.asciidoc @elastic/docs-freeze-team -docs/en/observability/*.asciidoc @elastic/docs-freeze-team -docs/en/serverless/*.asciidoc @elastic/docs-freeze-team -``` - -### [package-spec](https://github.com/elastic/package-spec) - -``` -spec/*.asciidoc @elastic/docs-freeze-team -versions/*.asciidoc @elastic/docs-freeze-team -``` - -### [search-ui](https://github.com/elastic/search-ui) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [security-docs](https://github.com/elastic/security-docs) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -docs/serverless/*.asciidoc @elastic/docs-freeze-team -``` - -### [sense](https://github.com/elastic/sense) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [stack-docs](https://github.com/elastic/stack-docs) - -``` -docs/en/*.asciidoc @elastic/docs-freeze-team -docs/en/gke-on-prem/*.asciidoc @elastic/docs-freeze-team -docs/en/stack/*.asciidoc @elastic/docs-freeze-team -``` - -### [swiftype](https://github.com/elastic/swiftype-doc-placeholder) - -``` -docs/*.asciidoc @elastic/docs-freeze-team -``` - -### [tech-content](https://github.com/elastic/tech-content) - -``` -welcome-to-elastic/*.asciidoc @elastic/docs-freeze-team -``` - -### [terraform-provider-ec](https://github.com/elastic/terraform-provider-ec) - -``` -docs-elastic/*.asciidoc @elastic/docs-freeze-team -``` - -### [x-pack](https://github.com/elastic/x-pack) - -``` -/docs/jp/*.asciidoc @elastic/docs-freeze-team -/docs/kr/*.asciidoc @elastic/docs-freeze-team -docs/en/*.asciidoc @elastic/docs-freeze-team -docs/public/graph/*.asciidoc @elastic/docs-freeze-team -docs/public/marvel/*.asciidoc @elastic/docs-freeze-team -docs/public/reporting/*.asciidoc @elastic/docs-freeze-team -docs/public/shield/*.asciidoc @elastic/docs-freeze-team -docs/public/watcher/*.asciidoc @elastic/docs-freeze-team -``` - -### [x-pack-elasticsearch](https://github.com/elastic/x-pack-elasticsearch) - -``` -/docs/jp/*.asciidoc @elastic/docs-freeze-team -/docs/kr/*.asciidoc @elastic/docs-freeze-team -docs/en/*.asciidoc @elastic/docs-freeze-team -qa/sql/*.asciidoc @elastic/docs-freeze-team -``` - -### [x-pack-kibana](https://github.com/elastic/x-pack-kibana) - -``` -/docs/kr/*.asciidoc @elastic/docs-freeze-team -docs/en/*.asciidoc @elastic/docs-freeze-team -docs/jp/*.asciidoc @elastic/docs-freeze-team -``` - -### [x-pack-logstash](https://github.com/elastic/x-pack-logstash) - -``` -docs/en/*.asciidoc @elastic/docs-freeze-team -``` From f0e5a3123e56056fab14559f64f0255f48f9f46e Mon Sep 17 00:00:00 2001 From: bmorelli25 Date: Mon, 13 Jan 2025 15:09:57 -0800 Subject: [PATCH 10/10] remove duplication --- docs/source/index.md | 139 +------------------------------------------ 1 file changed, 1 insertion(+), 138 deletions(-) diff --git a/docs/source/index.md b/docs/source/index.md index 40f903ccb..99d5201c0 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -4,147 +4,10 @@ title: Welcome to Elastic Docs v3 Elastic Docs V3 is our next-generation documentation platform designed to improve the experience of learning, using, and contributing to Elastic products. Built on a foundation of modern authoring tools and scalable infrastructure, V3 offers faster builds, streamlined versioning, and enhanced navigation to guide users through Elastic’s complex ecosystem. -**What do you want to do today?** +## What do you want to do today? * [Contribute to Elastic documentation](./contribute/index.md) * [Learn about migration to Elastic Docs V3](./migration/index.md) * [Configure content sets in V3](./configure/index.md) * [Learn about V3 syntax](./syntax/index.md) * [Contribute to V3 (developer guide)](./development/index.md) - -## About this repo - -This repository is host to: - -* *`docs-builder`* command line tool to generate single doc-sets (13mb native code, no dependencies) -* *`docs-assembler`* command line tool to assemble all the doc sets. (IN PROGRESS) -* `elastic/docs-builder@main` Github Action to build and validate a repositories documentation -* *`docs-generator`* command line tool to deterministically generate a docset and incremental updates to generated content - -## Command line interface - -```bash -$ docs-builder --help -Usage: [command] [options...] [-h|--help] [--version] - -Converts a source markdown folder or file to an output folder - -Options: - -p|--path Defaults to the`{pwd}/docs` folder (Default: null) - -o|--output Defaults to `.artifacts/html` (Default: null) - --path-prefix Specifies the path prefix for urls (Default: null) - --force Force a full rebuild of the destination folder (Default: null) - -Commands: - generate Converts a source markdown folder or file to an output folder - serve Continuously serve a documentation folder at http://localhost:5000. - File systems changes will be reflected without having to restart the server. -``` - -In the near term native code will be published by CI for the following platforms - -| OS | Architectures | -|----------|---------------| -| Windows | x64, Arm64 | -| Linux | x64, Arm64 | -| macOS | x64, Arm64 | - -And we'll invest time in making sure these are easily obtainable (`brew`, `winget`, `apt`) - -For now you can run the tool locally through `docker run` - -```bash -docker run -v "./.git:/app/.git" -v "./docs:/app/docs" -v "./.artifacts:/app/.artifacts" \ - ghcr.io/elastic/docs-builder:edge -``` - -This ensures `.git`/`docs` and `.artifacts` (the default output directory) are mounted. - -The tool will default to incremental compilation. -Only the changed files on subsequent runs will be compiled unless you pass `--force` -to force a new compilation. - -```bash -docker run -v "./.git:/app/.git" -v "./docs:/app/docs" -v "./.artifacts:/app/.artifacts" \ - ghcr.io/elastic/docs-builder:edge --force -``` - -#### Live mode - -Through the `serve` command you can continuously and partially compile your documentation. - -```bash -docker run -v "./.git:/app/.git" -v "./docs:/app/docs" -v "./.artifacts:/app/.artifacts" \ - -p 8080:8080 ghcr.io/elastic/docs-builder:edge serve -``` - -Each page is compiled on demand as you browse http://localhost:8080 and is never cached so changes to files and -navigation will always be reflected upon refresh. - -Note the docker image is `linux-x86` and will be somewhat slower to invoke on OSX due to virtualization. - - -## Github Action - -The `docs-builder` tool is available as github action. - -Since it runs from a precompiled distroless image `~25mb` it's able to execute snappy. (no need to wait for building the tool itself) - - -```yaml -jobs: - docs: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - - name: Build documentation - uses: elastic/docs-builder@main -``` - - - -### GitHub Pages - -To set up the tool to publish to GitHub pages use the following configuration. -**NOTE**: In the near feature we'll make this a dedicated single step GitHub action - -```yaml -environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} -steps: - - uses: actions/checkout@v4 - - - name: Publish Github - uses: elastic/docs-builder/actions/publish@main - id: deployment -``` - -Make sure your repository settings are set up to deploy from GitHub actions see: - -https://github.com/elastic/{your-repository}/settings/pages - ---- -![_static/img/github-pages.png](_static/img/github-pages.png) - ---- - -## Run without docker - -You can use the .NET CLI to publish a self-contained `docs-builder` native code -binary. (On my M2 Pro mac the binary is currently 16mb) - -Install [.NET 9.0](https://dotnet.microsoft.com/en-us/download/dotnet/9.0), then run: - -```bash -dotnet publish "src/docs-builder/docs-builder.csproj" -``` - -The resulting binary `./.artifacts/publish/docs-builder/release/docs-builder` will run on machines without .NET installed. - -# Performance - -To test performance it's best to build the binary and run outside of docker: - -For reference here's the `markitpy-doc` docset (50k markdown files) currently takes `14s` vs `several minutes` compared to -existing surveyed tools