From 7ca9bcbfc000cbaa52de0bb5463d6daa535ab0a4 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 22 Sep 2022 09:37:04 -0700 Subject: [PATCH 01/21] Output only main --- conf.yaml | 349 ++++++++++++++++++---------- shared/attributes.asciidoc | 4 +- shared/versions/stack/7.10.asciidoc | 18 +- shared/versions/stack/7.11.asciidoc | 18 +- shared/versions/stack/7.12.asciidoc | 16 +- shared/versions/stack/7.13.asciidoc | 16 +- shared/versions/stack/7.14.asciidoc | 16 +- shared/versions/stack/7.15.asciidoc | 16 +- shared/versions/stack/7.16.asciidoc | 16 +- shared/versions/stack/7.17.asciidoc | 16 +- shared/versions/stack/7.9.asciidoc | 2 +- shared/versions/stack/7.x.asciidoc | 16 +- shared/versions/stack/8.0.asciidoc | 16 +- shared/versions/stack/8.1.asciidoc | 16 +- shared/versions/stack/8.2.asciidoc | 16 +- shared/versions/stack/8.3.asciidoc | 16 +- shared/versions/stack/8.4.asciidoc | 16 +- shared/versions/stack/8.5.asciidoc | 16 +- shared/versions/stack/main.asciidoc | 58 ++++- 19 files changed, 407 insertions(+), 250 deletions(-) mode change 120000 => 100644 shared/versions/stack/main.asciidoc diff --git a/conf.yaml b/conf.yaml index 28d234c4687be..dd0a2e050539c 100644 --- a/conf.yaml +++ b/conf.yaml @@ -76,10 +76,7 @@ contents_title: Welcome to Elastic Docs # The keys don't really matter, but by convention the are the same as the variable. variables: stackcurrent: &stackcurrent 8.7 - stacklive: &stacklive [ master, 8.7, 8.6, 7.17 ] - - stacklivemain: &stacklivemain [ main, 8.7, 8.6, 7.17 ] - + stacklive: &stacklive [ main, 8.7, 8.6, 7.17 ] cloudSaasCurrent: &cloudSaasCurrent ms-88 mapCloudEceToClientsTeam: &mapCloudEceToClientsTeam @@ -106,11 +103,11 @@ variables: 1.1: master 1.0: master - # 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 + # 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 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 + # 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 mapMasterToMain: &mapMasterToMain master: main @@ -147,8 +144,8 @@ contents: prefix: en/elastic-stack current: *stackcurrent index: docs/en/install-upgrade/index.asciidoc - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -191,20 +188,22 @@ contents: 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 + map_branches: *mapMasterToMain - 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 ] + map_branches: *mapMasterToMain - repo: docs path: shared/attributes62.asciidoc exclude_branches: [ main, 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 ] + map_branches: *mapMasterToMain - title: Glossary prefix: en/elastic-stack-glossary current: main index: docs/en/glossary/index.asciidoc - branches: [ {main: master} ] + branches: [ main ] tags: Elastic Stack/Glossary subject: Elastic Stack sources: @@ -214,15 +213,17 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMasterToMain - title: Machine Learning prefix: en/machine-learning current: *stackcurrent index: docs/en/stack/ml/index.asciidoc - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -236,16 +237,19 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMasterToMain - repo: docs path: shared/settings.asciidoc + map_branches: *mapMasterToMain - title: Elastic Common Schema (ECS) Reference prefix: en/ecs current: 8.7 - branches: [ {main: master}, 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 ] + branches: [ main, 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: [ main, 8.7, 8.6, 8.5, 8.4, 8.3, 1.12 ] index: docs/index.asciidoc chunk: 2 @@ -259,7 +263,7 @@ contents: prefix: en/elastic-stack-deploy current: 7.11 index: docs/index.asciidoc - branches: [ master, 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.7, 6.6, 6.5, 6.4, 6.3 ] + branches: [ {master: main}, 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.7, 6.6, 6.5, 6.4, 6.3 ] chunk: 1 noindex: 1 tags: Elastic Stack/Azure @@ -268,14 +272,15 @@ contents: - repo: azure-marketplace path: docs + map_branches: *mapMainToMaster - title: "Elasticsearch: Store, Search, and Analyze" sections: - title: Elasticsearch Guide prefix: en/elasticsearch/reference current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -358,14 +363,17 @@ contents: 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 ] + 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, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + map_branches: *mapMainToMaster - repo: docs path: shared/attributes62.asciidoc exclude_branches: [ main, 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 ] + map_branches: *mapMainToMaster - alternatives: { source_lang: console, alternative_lang: js } repo: elasticsearch-js @@ -378,7 +386,7 @@ contents: - title: Elasticsearch Resiliency Status prefix: en/elasticsearch/resiliency toc: 1 - branches: [{main: master}] + branches: [ main ] current: main index: docs/resiliency/index.asciidoc single: 1 @@ -395,15 +403,17 @@ contents: 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 ] + 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, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + map_branches: *mapMainToMaster - title: Painless Scripting Language prefix: en/elasticsearch/painless current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -419,17 +429,19 @@ contents: 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 ] + 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, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + map_branches: *mapMainToMaster - title: Plugins and Integrations prefix: en/elasticsearch/plugins repo: elasticsearch current: *stackcurrent index: docs/plugins/index.asciidoc - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -457,18 +469,20 @@ contents: 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 ] + 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, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + map_branches: *mapMainToMaster - title: Elasticsearch Clients base_dir: en/elasticsearch/client sections: - title: Java Client prefix: java-api-client current: *stackcurrent - branches: [ {main: master}, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklivemain + branches: [ main, 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 @@ -489,8 +503,8 @@ contents: - title: JavaScript Client prefix: javascript-api current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -502,8 +516,8 @@ contents: - title: Ruby Client prefix: ruby-api current: *stackcurrent - branches: [ {main: master}, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklivemain + branches: [ main, 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 @@ -515,8 +529,8 @@ contents: - title: Go Client prefix: go-api current: *stackcurrent - branches: [ {main: master}, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklivemain + branches: [ main, 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 @@ -528,7 +542,7 @@ contents: - title: .NET Clients prefix: net-api current: 8.0 - branches: [ {main: master}, 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 ] + branches: [ main, 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: [ main, 8.0, 7.17, 7.16, 6.x, 5.x, 2.x, 1.x ] index: docs/index.asciidoc tags: Clients/.Net @@ -544,8 +558,8 @@ contents: - title: PHP Client prefix: php-api current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -557,10 +571,11 @@ contents: - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - title: Perl Client prefix: perl-api current: master - branches: [ master, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] + branches: [ {master: main}, 8.6, 8.6, 8.4, 8.3, 8.2, 8.1, 8.0 ] live: [ master, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] index: docs/index.asciidoc chunk: 1 @@ -570,11 +585,12 @@ contents: - repo: elasticsearch-perl path: docs/ + map_branches: *mapMainToMaster - title: Python Client prefix: python-api current: *stackcurrent - branches: [ {main: master}, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklivemain + branches: [ main, 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 @@ -586,7 +602,7 @@ contents: - title: eland prefix: eland current: main - branches: [ {main: master} ] + branches: [ main ] live: [ main ] index: docs/guide/index.asciidoc chunk: 1 @@ -598,9 +614,9 @@ contents: path: docs/guide - title: Rust Client prefix: rust-api - current: main - branches: [ {main: master}, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] - live: [ main, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] + current: master + branches: [ main, 8.6, 8.6, 8.4, 8.3, 8.2, 8.1, 8.0 ] + live: [ main, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] index: docs/index.asciidoc chunk: 1 tags: Clients/Rust @@ -609,6 +625,7 @@ contents: - repo: elasticsearch-rs path: docs/ + map_branches: *mapMainToMaster - title: Java REST Client (deprecated) prefix: java-rest current: 7.17 @@ -633,10 +650,12 @@ contents: 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 ] + 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, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + map_branches: *mapMainToMaster - title: Java Transport Client (deprecated) prefix: java-api current: 7.17 @@ -679,14 +698,16 @@ contents: 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 ] + 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, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] + map_branches: *mapMainToMaster - title: Community Contributed Clients prefix: community - branches: [{main: master}] + branches: [ main ] current: main index: docs/community-clients/index.asciidoc single: 1 @@ -699,8 +720,8 @@ contents: - title: Elasticsearch for Apache Hadoop and Spark prefix: en/elasticsearch/hadoop current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -864,7 +885,7 @@ contents: tags: Kubernetes/Reference subject: ECK current: 2.7 - branches: [ {main: master}, 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 ] + branches: [ main, 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: @@ -875,27 +896,30 @@ contents: repo: docs path: shared/versions/stack/current.asciidoc exclude_branches: [ 0.9, 0.8 ] + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - title: Elastic Cloud Control - The Command-Line Interface for Elasticsearch Service and ECE prefix: en/ecctl tags: CloudControl/Reference subject: ECCTL current: 1.9 - branches: [ master, 1.9, 1.8, 1.7, 1.6, 1.5, 1.4, 1.3, 1.2, 1.1, 1.0 ] + branches: [ {master: main}, 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/ + map_branches: *mapMainToMaster - title: Elastic Cloud Terraform Provider prefix: en/tpec tags: CloudTerraform/Reference subject: TPEC current: 0.2 - branches: [ master, 0.2, 0.1 ] + branches: [ {master: main}, 0.2, 0.1 ] index: docs-elastic/index.asciidoc single: 1 chunk: 1 @@ -903,14 +927,15 @@ contents: - repo: terraform-provider-ec path: docs-elastic/ + map_branches: *mapMainToMaster - title: "Kibana: Explore, Visualize, and Share" sections: - title: Kibana Guide prefix: en/kibana current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -929,18 +954,22 @@ contents: 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 ] + 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, 4.6, 4.5, 4.4, 4.3, 4.2, 4.1, 4.0, 3.0 ] + map_branches: *mapMainToMaster - repo: docs path: shared/attributes62.asciidoc exclude_branches: [ main, 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 ] + map_branches: *mapMainToMaster - repo: docs path: shared/legacy-attrs.asciidoc exclude_branches: [ main, 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 ] + map_branches: *mapMainToMaster - repo: kibana # git-archive requires `:(glob)` for ** to match no directory (in order to include `examples/README.asciidoc`) @@ -962,8 +991,8 @@ contents: index: enterprise-search-docs/index.asciidoc private: 1 current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -974,13 +1003,14 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - title: Workplace Search Guide prefix: en/workplace-search index: workplace-search-docs/index.asciidoc private: 1 current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -991,13 +1021,14 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - title: App Search Guide prefix: en/app-search index: app-search-docs/index.asciidoc private: 1 current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -1008,12 +1039,13 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - title: Site Search Reference prefix: en/swiftype/sitesearch index: docs/sitesearch/index.asciidoc private: 1 current: master - branches: [ master ] + branches: [ {master: main} ] single: 1 tags: Site Search/Reference subject: Swiftype @@ -1021,6 +1053,7 @@ contents: - repo: swiftype path: docs + map_branches: *mapMainToMaster - title: Enterprise Search Clients base_dir: en/enterprise-search-clients sections: @@ -1029,8 +1062,8 @@ contents: private: 1 single: 1 current: *stackcurrent - branches: [ {main: master}, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklivemain + branches: [ main, 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 @@ -1041,13 +1074,14 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - title: App Search Node.js client prefix: app-search-node private: 1 single: 1 current: *stackcurrent - branches: [ {main: master}, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklivemain + branches: [ main, 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 @@ -1058,10 +1092,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - title: Enterprise Search Node.js client prefix: enterprise-search-node current: *stackcurrent - branches: [ {main: master}, 8.7, 8.6 ] + branches: [ main, 8.7, 8.6 ] live: [ main, 8.6 ] index: packages/enterprise-search/docs/index.asciidoc tags: Enterprise Search Clients/Node.js @@ -1073,11 +1108,12 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - title: Enterprise Search PHP client prefix: php current: *stackcurrent - branches: [ {main: master}, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklivemain + branches: [ main, 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 @@ -1085,14 +1121,16 @@ contents: - repo: enterprise-search-php path: docs/guide/ + map_branches: *mapMainToMaster - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - title: Enterprise Search Python client prefix: python current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -1103,11 +1141,12 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - title: Enterprise Search Ruby client prefix: ruby current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -1118,13 +1157,14 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - title: Workplace Search Node.js client prefix: workplace-search-node private: 1 single: 1 current: *stackcurrent - branches: [ {main: master}, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklivemain + branches: [ main, 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 @@ -1135,13 +1175,14 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - title: "Observability: APM, Logs, Metrics, and Uptime" sections: - title: Observability prefix: en/observability current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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: 2 tags: Observability/Guide @@ -1164,9 +1205,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: kibana path: docs @@ -1178,8 +1221,8 @@ contents: prefix: guide index: docs/integrations-index.asciidoc current: *stackcurrent - branches: [ {main: master}, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] - live: *stacklivemain + branches: [ main, 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 @@ -1198,7 +1241,6 @@ contents: 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 - title: APM Agents base_dir: agent sections: @@ -1221,7 +1263,7 @@ contents: - title: APM Go Agent prefix: go current: 2.x - branches: [ {main: master}, 2.x, 1.x, 0.5 ] + branches: [ main, 2.x, 1.x, 0.5 ] live: [ main, 2.x, 1.x ] index: docs/index.asciidoc tags: APM Go Agent/Reference @@ -1254,7 +1296,7 @@ contents: - title: APM Java Agent prefix: java current: 1.x - branches: [ {main: master}, 1.x, 0.7, 0.6 ] + branches: [ main, 1.x, 0.7, 0.6 ] live: [ main, 1.x ] index: docs/index.asciidoc tags: APM Java Agent/Reference @@ -1277,7 +1319,7 @@ contents: - title: APM .NET Agent prefix: dotnet current: 1.x - branches: [ {main: master}, 1.x, 1.8 ] + branches: [ main, 1.x, 1.8 ] live: [ main, 1.x ] index: docs/index.asciidoc tags: APM .NET Agent/Reference @@ -1293,7 +1335,7 @@ contents: - title: APM Node.js Agent prefix: nodejs current: 3.x - branches: [ {main: master}, 3.x, 2.x, 1.x, 0.x ] + branches: [ main, 3.x, 2.x, 1.x, 0.x ] live: [ main, 3.x ] index: docs/index.asciidoc tags: APM Node.js Agent/Reference @@ -1316,7 +1358,7 @@ contents: - title: APM PHP Agent prefix: php current: 1.x - branches: [ {main: master}, 1.x ] + branches: [ main, 1.x ] live: [ main, 1.x ] index: docs/index.asciidoc tags: APM PHP Agent/Reference @@ -1332,7 +1374,7 @@ contents: - title: APM Python Agent prefix: python current: 6.x - branches: [ {main: master}, 6.x, 5.x, 4.x, 3.x, 2.x, 1.x ] + branches: [ main, 6.x, 5.x, 4.x, 3.x, 2.x, 1.x ] live: [ main, 6.x, 5.x ] index: docs/index.asciidoc tags: APM Python Agent/Reference @@ -1355,7 +1397,7 @@ contents: - title: APM Ruby Agent prefix: ruby current: 4.x - branches: [ {main: master}, 4.x, 3.x, 2.x, 1.x ] + branches: [ main, 4.x, 3.x, 2.x, 1.x ] live: [ main, 4.x ] index: docs/index.asciidoc tags: APM Ruby Agent/Reference @@ -1372,7 +1414,7 @@ contents: - 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 ] + branches: [ main, 5.x, 4.x, 3.x, 2.x, 1.x, 0.x ] live: [ main, 5.x, 4.x] index: docs/index.asciidoc tags: APM Real User Monitoring JavaScript Agent/Reference @@ -1459,7 +1501,7 @@ contents: - title: ECS Logging Overview prefix: overview current: main - branches: [ {main: master} ] + branches: [ main ] live: [ main ] index: docs/index.asciidoc chunk: 1 @@ -1472,13 +1514,15 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - title: ECS Logging Go (Logrus) Reference prefix: go-logrus current: main - branches: [ {main: master} ] + branches: [ main ] live: [ main ] index: docs/index.asciidoc chunk: 1 @@ -1491,16 +1535,18 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: ecs-logging path: docs - title: ECS Logging Go (Zap) Reference prefix: go-zap current: main - branches: [ {main: master} ] + branches: [ main ] live: [ main ] index: docs/index.asciidoc chunk: 1 @@ -1513,9 +1559,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: ecs-logging path: docs @@ -1523,7 +1571,7 @@ contents: - title: ECS Logging Java Reference prefix: java current: 1.x - branches: [ {main: master}, 1.x, 0.x ] + branches: [ main, 1.x, 0.x ] live: [ main, 1.x ] index: docs/index.asciidoc chunk: 1 @@ -1536,9 +1584,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: ecs-logging path: docs @@ -1548,7 +1598,7 @@ contents: - title: ECS Logging .NET Reference prefix: dotnet current: main - branches: [ {main: master} ] + branches: [ main ] live: [ main ] index: docs/index.asciidoc chunk: 1 @@ -1561,16 +1611,18 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: ecs-logging path: docs - title: ECS Logging Node.js Reference prefix: nodejs current: main - branches: [ {main: master} ] + branches: [ main ] live: [ main ] index: docs/index.asciidoc chunk: 1 @@ -1583,16 +1635,18 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: ecs-logging path: docs - title: ECS Logging Ruby Reference prefix: ruby current: main - branches: [ {main: master} ] + branches: [ main ] live: [ main ] index: docs/index.asciidoc chunk: 1 @@ -1605,16 +1659,18 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: ecs-logging path: docs - title: ECS Logging PHP Reference prefix: php current: main - branches: [ {main: master} ] + branches: [ main ] live: [ main ] index: docs/index.asciidoc chunk: 1 @@ -1627,16 +1683,18 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: ecs-logging path: docs - title: ECS Logging Python Reference prefix: python current: main - branches: [ {main: master} ] + branches: [ main ] live: [ main ] index: docs/index.asciidoc chunk: 1 @@ -1649,9 +1707,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: ecs-logging path: docs @@ -1661,8 +1721,8 @@ contents: - title: Elastic Security prefix: en/security current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -1674,9 +1734,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: stack-docs path: docs/en @@ -1700,9 +1762,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - title: "Logstash: Collect, Enrich, and Transport" @@ -1710,8 +1774,8 @@ contents: - title: Logstash Reference prefix: en/logstash current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -1734,18 +1798,22 @@ contents: 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 ] + 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, 2.4, 2.3, 2.2, 2.1, 2.0, 1.5 ] + map_branches: *mapMainToMaster - repo: docs path: shared/attributes62.asciidoc exclude_branches: [ main, 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 ] + map_branches: *mapMainToMaster - repo: docs path: shared/legacy-attrs.asciidoc exclude_branches: [ main, 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] + map_branches: *mapMainToMaster - title: Logstash Versioned Plugin Reference prefix: en/logstash-versioned-plugins current: versioned_plugin_docs @@ -1763,14 +1831,15 @@ contents: - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - title: "Fleet: Install and Manage Elastic Agents" sections: - title: Fleet and Elastic Agent Guide prefix: en/fleet current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -1785,9 +1854,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: apm-server path: docs @@ -1796,7 +1867,7 @@ contents: - title: Integrations Developer Guide prefix: en/integrations-developer current: main - branches: [ {main: master} ] + branches: [ main ] live: [ main ] index: docs/en/integrations/index.asciidoc chunk: 1 @@ -1809,9 +1880,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: package-spec path: versions @@ -1825,8 +1898,8 @@ contents: prefix: en/beats/libbeat index: libbeat/docs/index.asciidoc current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -1842,16 +1915,18 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - title: Auditbeat Reference prefix: en/beats/auditbeat index: auditbeat/docs/index.asciidoc current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -1895,16 +1970,18 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - title: Filebeat Reference prefix: en/beats/filebeat index: filebeat/docs/index.asciidoc current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -1950,16 +2027,18 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - title: Functionbeat Reference prefix: en/beats/functionbeat current: *stackcurrent index: x-pack/functionbeat/docs/index.asciidoc - branches: [ {main: master}, 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 ] - live: *stacklivemain + branches: [ main, 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 ] + live: *stacklive chunk: 1 tags: Functionbeat/Reference respect_edit_url_overrides: true @@ -1992,9 +2071,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - repo: beats path: x-pack/libbeat/docs @@ -2007,8 +2088,8 @@ contents: prefix: en/beats/heartbeat current: *stackcurrent index: heartbeat/docs/index.asciidoc - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -2046,16 +2127,18 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - title: Metricbeat Reference prefix: en/beats/metricbeat index: metricbeat/docs/index.asciidoc current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -2103,16 +2186,18 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - title: Packetbeat Reference prefix: en/beats/packetbeat index: packetbeat/docs/index.asciidoc current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -2146,16 +2231,18 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - title: Winlogbeat Reference prefix: en/beats/winlogbeat index: winlogbeat/docs/index.asciidoc current: *stackcurrent - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -2189,16 +2276,18 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - title: Beats Developer Guide prefix: en/beats/devguide index: docs/devguide/index.asciidoc current: main - branches: [ {main: master}, 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: *stacklivemain + branches: [ main, 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 @@ -2220,15 +2309,17 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude + map_branches: *mapMainToMaster - title: Elastic Logging Plugin for Docker prefix: en/beats/loggingplugin current: *stackcurrent index: x-pack/dockerlogbeat/docs/index.asciidoc - branches: [ {main: master}, 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 ] + branches: [ main, 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 @@ -2243,9 +2334,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - title: Docs in Your Native Tongue sections: @@ -2455,14 +2548,16 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - title: Logstash and Kubernetes prefix: en/logstash-kubernetes current: main index: docsk8s/index.asciidoc - branches: [ {main: master} ] + branches: [ main ] noindex: 1 chunk: 1 tags: Logstash/Kubernetes @@ -2478,7 +2573,7 @@ contents: prefix: en/ingest current: main index: docs/en/ingest-arch/index.asciidoc - branches: [ {main: master} ] + branches: [ main ] noindex: 1 chunk: 1 tags: Ingest/Reference @@ -2490,7 +2585,7 @@ contents: - repo: docs path: shared/attributes.asciidoc - + map_branches: *mapMainToMaster - title: Legacy Documentation sections: - title: Getting Started @@ -2513,6 +2608,7 @@ contents: - repo: docs path: shared/attributes.asciidoc + - repo: elasticsearch path: docs/ @@ -2522,7 +2618,7 @@ contents: prefix: en/elastic-stack-gke current: main index: docs/en/gke-on-prem/index.asciidoc - branches: [ {main: master} ] + branches: [ main ] private: 1 noindex: 1 chunk: 1 @@ -2535,9 +2631,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc + map_branches: *mapMainToMaster - title: Journalbeat Reference for 6.5-7.15 prefix: en/beats/journalbeat current: 7.15 @@ -2694,12 +2792,12 @@ contents: 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] + exclude_branches: [ 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] + exclude_branches: [ 5.3, 5.2, 5.1, 5.0] - repo: docs path: shared/attributes62.asciidoc @@ -2707,7 +2805,7 @@ contents: - title: Elasticsearch - The Definitive Guide prefix: en/elasticsearch/guide current: 2.x - branches: [ master, 2.x, 1.x ] + branches: [ {master: main}, 2.x, 1.x ] index: book.asciidoc chunk: 1 noindex: 1 @@ -2719,14 +2817,16 @@ contents: - repo: guide path: / + map_branches: *mapMainToMaster - repo: docs path: shared/legacy-attrs.asciidoc - exclude_branches: [ master, 2.x] + exclude_branches: [ main, 2.x] + map_branches: *mapMainToMaster - title: Sense Editor for 4.x prefix: en/sense current: master - branches: [ master ] + branches: [ {master: main} ] index: docs/index.asciidoc noindex: 1 private: 1 @@ -2736,6 +2836,7 @@ contents: - repo: sense path: docs + map_branches: *mapMainToMaster - title: Marvel Reference for 2.x and 1.x prefix: en/marvel chunk: 1 diff --git a/shared/attributes.asciidoc b/shared/attributes.asciidoc index 583b46834929b..145c7704d0db8 100644 --- a/shared/attributes.asciidoc +++ b/shared/attributes.asciidoc @@ -470,11 +470,11 @@ 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-m: https://www.elastic.co/guide/en/apm/server/main :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 +:apm-overview-ref-m: https://www.elastic.co/guide/en/apm/get-started/main :infra-guide: https://www.elastic.co/guide/en/infrastructure/guide/{branch} diff --git a/shared/versions/stack/7.10.asciidoc b/shared/versions/stack/7.10.asciidoc index 4fe8e61a6d495..15b134c9f5e42 100644 --- a/shared/versions/stack/7.10.asciidoc +++ b/shared/versions/stack/7.10.asciidoc @@ -31,7 +31,7 @@ APM Agent versions :apm-java-branch: 1.x :apm-rum-branch: 5.x :apm-node-branch: 3.x -:apm-php-branch: master +:apm-php-branch: main :apm-py-branch: 5.x :apm-ruby-branch: 3.x :apm-dotnet-branch: 1.x @@ -39,12 +39,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/7.11.asciidoc b/shared/versions/stack/7.11.asciidoc index 1ec92d4825c88..585273924c6e1 100644 --- a/shared/versions/stack/7.11.asciidoc +++ b/shared/versions/stack/7.11.asciidoc @@ -36,7 +36,7 @@ APM Agent versions :apm-java-branch: 1.x :apm-rum-branch: 5.x :apm-node-branch: 3.x -:apm-php-branch: master +:apm-php-branch: main :apm-py-branch: 5.x :apm-ruby-branch: 3.x :apm-dotnet-branch: 1.x @@ -44,12 +44,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/7.12.asciidoc b/shared/versions/stack/7.12.asciidoc index be96b4dafc67a..477ffb4482a85 100644 --- a/shared/versions/stack/7.12.asciidoc +++ b/shared/versions/stack/7.12.asciidoc @@ -44,12 +44,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/7.13.asciidoc b/shared/versions/stack/7.13.asciidoc index e49f1f1f5c2f5..2546b0049dba7 100644 --- a/shared/versions/stack/7.13.asciidoc +++ b/shared/versions/stack/7.13.asciidoc @@ -45,12 +45,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/7.14.asciidoc b/shared/versions/stack/7.14.asciidoc index e35febfc1eabc..8c1ce90f6fb80 100644 --- a/shared/versions/stack/7.14.asciidoc +++ b/shared/versions/stack/7.14.asciidoc @@ -45,12 +45,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/7.15.asciidoc b/shared/versions/stack/7.15.asciidoc index 84c5b17733aa9..20b91f6a10590 100644 --- a/shared/versions/stack/7.15.asciidoc +++ b/shared/versions/stack/7.15.asciidoc @@ -45,12 +45,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/7.16.asciidoc b/shared/versions/stack/7.16.asciidoc index cda059d2a8b88..0de43c6537880 100644 --- a/shared/versions/stack/7.16.asciidoc +++ b/shared/versions/stack/7.16.asciidoc @@ -45,12 +45,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/7.17.asciidoc b/shared/versions/stack/7.17.asciidoc index b0d13ae1315ff..fe7a98ef8a115 100644 --- a/shared/versions/stack/7.17.asciidoc +++ b/shared/versions/stack/7.17.asciidoc @@ -45,12 +45,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/7.9.asciidoc b/shared/versions/stack/7.9.asciidoc index 6687d47c95d5e..b0d6288a6e812 100644 --- a/shared/versions/stack/7.9.asciidoc +++ b/shared/versions/stack/7.9.asciidoc @@ -27,7 +27,7 @@ APM Agent versions :apm-java-branch: 1.x :apm-rum-branch: 5.x :apm-node-branch: 3.x -:apm-php-branch: master +:apm-php-branch: main :apm-py-branch: 5.x :apm-ruby-branch: 3.x :apm-dotnet-branch: 1.x diff --git a/shared/versions/stack/7.x.asciidoc b/shared/versions/stack/7.x.asciidoc index 11a51080fd15f..0702075d77440 100644 --- a/shared/versions/stack/7.x.asciidoc +++ b/shared/versions/stack/7.x.asciidoc @@ -45,12 +45,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/8.0.asciidoc b/shared/versions/stack/8.0.asciidoc index 377575147ddbb..67e563b54ce00 100644 --- a/shared/versions/stack/8.0.asciidoc +++ b/shared/versions/stack/8.0.asciidoc @@ -46,12 +46,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/8.1.asciidoc b/shared/versions/stack/8.1.asciidoc index 2e30fd466eb39..054ec027f83f4 100644 --- a/shared/versions/stack/8.1.asciidoc +++ b/shared/versions/stack/8.1.asciidoc @@ -46,12 +46,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/8.2.asciidoc b/shared/versions/stack/8.2.asciidoc index 03f421df12c27..0131d1aea0c0a 100644 --- a/shared/versions/stack/8.2.asciidoc +++ b/shared/versions/stack/8.2.asciidoc @@ -46,12 +46,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/8.3.asciidoc b/shared/versions/stack/8.3.asciidoc index 8b36b10ba59f8..5af464597a7d2 100644 --- a/shared/versions/stack/8.3.asciidoc +++ b/shared/versions/stack/8.3.asciidoc @@ -46,12 +46,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/8.4.asciidoc b/shared/versions/stack/8.4.asciidoc index 8a1f00e2c47ee..32111f15e4df1 100644 --- a/shared/versions/stack/8.4.asciidoc +++ b/shared/versions/stack/8.4.asciidoc @@ -46,12 +46,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/8.5.asciidoc b/shared/versions/stack/8.5.asciidoc index c2f0a5373fd59..aabe90b2fb602 100644 --- a/shared/versions/stack/8.5.asciidoc +++ b/shared/versions/stack/8.5.asciidoc @@ -47,12 +47,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/main.asciidoc b/shared/versions/stack/main.asciidoc deleted file mode 120000 index c630c89521fe5..0000000000000 --- a/shared/versions/stack/main.asciidoc +++ /dev/null @@ -1 +0,0 @@ -master.asciidoc \ No newline at end of file diff --git a/shared/versions/stack/main.asciidoc b/shared/versions/stack/main.asciidoc new file mode 100644 index 0000000000000..0b57ca23b5236 --- /dev/null +++ b/shared/versions/stack/main.asciidoc @@ -0,0 +1,57 @@ +:version: 8.5.0 +//// +bare_version never includes -alpha or -beta +//// +:bare_version: 8.5.0 +:logstash_version: 8.5.0 +:elasticsearch_version: 8.5.0 +:kibana_version: 8.5.0 +:apm_server_version: 8.5.0 +:branch: main +:minor-version: 8.5 +:major-version: 8.x +:prev-major-version: 7.x +:prev-major-last: 7.17 +:major-version-only: 8 +:ecs_version: 8.5 + +////////// +release-state can be: released | prerelease | unreleased +////////// +:release-state: unreleased + +////////// +is-current-version can be: true | false +////////// +:is-current-version: false + +////////// +hide-xpack-tags defaults to "false" (they are shown unless set to "true") +////////// +:hide-xpack-tags: true + +//// +APM Agent versions +//// +:apm-go-branch: 2.x +:apm-ios-branch: 0.x +:apm-java-branch: 1.x +:apm-rum-branch: 5.x +:apm-node-branch: 3.x +:apm-php-branch: 1.x +:apm-py-branch: 6.x +:apm-ruby-branch: 4.x +:apm-dotnet-branch: 1.12 + +//// +ECS Logging +//// +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main +:ecs-logging-java: 1.x +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main From 9875dd0c05c939e5be14dee0ebf4631a28c18e4f Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 4 Oct 2022 16:33:24 -0700 Subject: [PATCH 02/21] Fix branch mapping --- conf.yaml | 154 ++++++++++++++++++++++++++---------------------------- 1 file changed, 73 insertions(+), 81 deletions(-) diff --git a/conf.yaml b/conf.yaml index dd0a2e050539c..ea887f50f0c17 100644 --- a/conf.yaml +++ b/conf.yaml @@ -125,7 +125,7 @@ contents: prefix: en/welcome-to-elastic current: *stackcurrent index: welcome-to-elastic/index.asciidoc - branches: [ {main: master}, 8.7, 8.6, 8.5, 8.4, 7.17 ] + branches: [ main, 8.7, 8.6, 8.5, 8.4, 7.17 ] live: [ 8.7 ] chunk: 1 tags: Elastic/Welcome @@ -137,6 +137,7 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc + map_branches: *mapMasterToMain - title: Elastic Stack sections: @@ -363,17 +364,17 @@ contents: 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes62.asciidoc exclude_branches: [ main, 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - alternatives: { source_lang: console, alternative_lang: js } repo: elasticsearch-js @@ -403,12 +404,12 @@ contents: 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Painless Scripting Language prefix: en/elasticsearch/painless current: *stackcurrent @@ -429,12 +430,12 @@ contents: 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Plugins and Integrations prefix: en/elasticsearch/plugins repo: elasticsearch @@ -469,12 +470,12 @@ contents: 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Elasticsearch Clients base_dir: en/elasticsearch/client sections: @@ -650,12 +651,10 @@ contents: 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 ] - 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, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - map_branches: *mapMainToMaster - title: Java Transport Client (deprecated) prefix: java-api current: 7.17 @@ -698,12 +697,10 @@ contents: 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 ] - 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, 2.4, 2.3, 2.2, 2.1, 2.0, 1.7, 1.6, 1.5, 1.4, 1.3, 0.90 ] - map_branches: *mapMainToMaster - title: Community Contributed Clients prefix: community @@ -954,12 +951,12 @@ contents: 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes62.asciidoc @@ -1003,7 +1000,7 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Workplace Search Guide prefix: en/workplace-search index: workplace-search-docs/index.asciidoc @@ -1021,7 +1018,7 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: App Search Guide prefix: en/app-search index: app-search-docs/index.asciidoc @@ -1039,7 +1036,7 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Site Search Reference prefix: en/swiftype/sitesearch index: docs/sitesearch/index.asciidoc @@ -1074,7 +1071,7 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: App Search Node.js client prefix: app-search-node private: 1 @@ -1092,7 +1089,7 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Enterprise Search Node.js client prefix: enterprise-search-node current: *stackcurrent @@ -1108,7 +1105,7 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Enterprise Search PHP client prefix: php current: *stackcurrent @@ -1125,7 +1122,6 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster - title: Enterprise Search Python client prefix: python current: *stackcurrent @@ -1141,7 +1137,7 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Enterprise Search Ruby client prefix: ruby current: *stackcurrent @@ -1157,7 +1153,7 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Workplace Search Node.js client prefix: workplace-search-node private: 1 @@ -1175,7 +1171,7 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: "Observability: APM, Logs, Metrics, and Uptime" sections: - title: Observability @@ -1205,7 +1201,7 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc @@ -1514,11 +1510,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: ECS Logging Go (Logrus) Reference prefix: go-logrus current: main @@ -1535,11 +1531,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: ecs-logging path: docs @@ -1559,11 +1555,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: ecs-logging path: docs @@ -1584,11 +1580,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: ecs-logging path: docs @@ -1611,11 +1607,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: ecs-logging path: docs @@ -1635,11 +1631,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: ecs-logging path: docs @@ -1659,11 +1655,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: ecs-logging path: docs @@ -1683,11 +1679,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: ecs-logging path: docs @@ -1707,11 +1703,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: ecs-logging path: docs @@ -1734,11 +1730,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: stack-docs path: docs/en @@ -1762,13 +1758,9 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster - - - title: "Logstash: Collect, Enrich, and Transport" sections: - title: Logstash Reference @@ -1798,12 +1790,12 @@ contents: 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - 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 ] - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes62.asciidoc @@ -1854,11 +1846,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: apm-server path: docs @@ -1880,11 +1872,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: package-spec path: versions @@ -1915,12 +1907,12 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Auditbeat Reference prefix: en/beats/auditbeat index: auditbeat/docs/index.asciidoc @@ -1970,12 +1962,12 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Filebeat Reference prefix: en/beats/filebeat index: filebeat/docs/index.asciidoc @@ -2027,12 +2019,12 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Functionbeat Reference prefix: en/beats/functionbeat current: *stackcurrent @@ -2071,11 +2063,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: beats path: x-pack/libbeat/docs @@ -2127,12 +2119,12 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Metricbeat Reference prefix: en/beats/metricbeat index: metricbeat/docs/index.asciidoc @@ -2186,12 +2178,12 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Packetbeat Reference prefix: en/beats/packetbeat index: packetbeat/docs/index.asciidoc @@ -2231,12 +2223,12 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Winlogbeat Reference prefix: en/beats/winlogbeat index: winlogbeat/docs/index.asciidoc @@ -2276,12 +2268,12 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Beats Developer Guide prefix: en/beats/devguide index: docs/devguide/index.asciidoc @@ -2309,12 +2301,12 @@ contents: repo: docs path: shared/versions/stack/{version}.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc exclude_branches: *beatsSharedExclude - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Elastic Logging Plugin for Docker prefix: en/beats/loggingplugin current: *stackcurrent @@ -2334,11 +2326,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Docs in Your Native Tongue sections: @@ -2548,11 +2540,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Logstash and Kubernetes prefix: en/logstash-kubernetes current: main @@ -2631,11 +2623,11 @@ contents: - repo: docs path: shared/versions/stack/{version}.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Journalbeat Reference for 6.5-7.15 prefix: en/beats/journalbeat current: 7.15 From 2836d34a9535a13e6ce1cdad0a4800b4446b9e5c Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 12 Oct 2022 08:23:41 -0700 Subject: [PATCH 03/21] Fix mapping for enterprise-search-php --- conf.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/conf.yaml b/conf.yaml index ea887f50f0c17..46a660ad472eb 100644 --- a/conf.yaml +++ b/conf.yaml @@ -1118,7 +1118,6 @@ contents: - repo: enterprise-search-php path: docs/guide/ - map_branches: *mapMainToMaster - repo: docs path: shared/versions/stack/{version}.asciidoc From c165a5a832de458ca0b4d46492bb3450c1525c5c Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 28 Nov 2022 10:07:12 -0800 Subject: [PATCH 04/21] Refresh main.asciidoc --- shared/versions/stack/main.asciidoc | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/shared/versions/stack/main.asciidoc b/shared/versions/stack/main.asciidoc index 0b57ca23b5236..bccbfdd0b47b8 100644 --- a/shared/versions/stack/main.asciidoc +++ b/shared/versions/stack/main.asciidoc @@ -1,19 +1,19 @@ -:version: 8.5.0 +:version: 8.7.0 //// bare_version never includes -alpha or -beta //// -:bare_version: 8.5.0 -:logstash_version: 8.5.0 -:elasticsearch_version: 8.5.0 -:kibana_version: 8.5.0 -:apm_server_version: 8.5.0 +:bare_version: 8.7.0 +:logstash_version: 8.7.0 +:elasticsearch_version: 8.7.0 +:kibana_version: 8.7.0 +:apm_server_version: 8.7.0 :branch: main -:minor-version: 8.5 +:minor-version: 8.7 :major-version: 8.x :prev-major-version: 7.x :prev-major-last: 7.17 :major-version-only: 8 -:ecs_version: 8.5 +:ecs_version: 8.6 ////////// release-state can be: released | prerelease | unreleased @@ -33,6 +33,7 @@ hide-xpack-tags defaults to "false" (they are shown unless set to "true") //// APM Agent versions //// +:apm-android-branch: main :apm-go-branch: 2.x :apm-ios-branch: 0.x :apm-java-branch: 1.x @@ -41,7 +42,7 @@ APM Agent versions :apm-php-branch: 1.x :apm-py-branch: 6.x :apm-ruby-branch: 4.x -:apm-dotnet-branch: 1.12 +:apm-dotnet-branch: 1.x //// ECS Logging From c31de11e71c5bb449377c15931d4adb6a7e0cf57 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 28 Nov 2022 12:00:53 -0800 Subject: [PATCH 05/21] Fix branches for elasticsearch PHP client --- conf.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf.yaml b/conf.yaml index 46a660ad472eb..ce7ff3176ab56 100644 --- a/conf.yaml +++ b/conf.yaml @@ -572,7 +572,7 @@ contents: - repo: docs path: shared/attributes.asciidoc - map_branches: *mapMainToMaster + map_branches: *mapMasterToMain - title: Perl Client prefix: perl-api current: master From fe3ecb30b0b3b1d6273082fcb70fdc62c2f78200 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 9 Feb 2023 11:11:32 +0100 Subject: [PATCH 06/21] Apply suggestions from code review --- conf.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf.yaml b/conf.yaml index ce7ff3176ab56..406eddb19b566 100644 --- a/conf.yaml +++ b/conf.yaml @@ -576,7 +576,7 @@ contents: - title: Perl Client prefix: perl-api current: master - branches: [ {master: main}, 8.6, 8.6, 8.4, 8.3, 8.2, 8.1, 8.0 ] + branches: [ {master: main}, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] live: [ master, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] index: docs/index.asciidoc chunk: 1 From e614ee75d31a338f327169bc3ef963a73df9524f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Tue, 21 Mar 2023 10:53:29 +0100 Subject: [PATCH 07/21] Apply suggestions from code review --- conf.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/conf.yaml b/conf.yaml index 406eddb19b566..63ccb40a49921 100644 --- a/conf.yaml +++ b/conf.yaml @@ -626,7 +626,6 @@ contents: - repo: elasticsearch-rs path: docs/ - map_branches: *mapMainToMaster - title: Java REST Client (deprecated) prefix: java-rest current: 7.17 From 38bd90616bb47b114d797995c756734431112ae3 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 3 Apr 2023 12:24:58 -0700 Subject: [PATCH 08/21] Update conf.yaml --- conf.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf.yaml b/conf.yaml index 63ccb40a49921..282c5eeb9c388 100644 --- a/conf.yaml +++ b/conf.yaml @@ -126,7 +126,7 @@ contents: current: *stackcurrent index: welcome-to-elastic/index.asciidoc branches: [ main, 8.7, 8.6, 8.5, 8.4, 7.17 ] - live: [ 8.7 ] + live: *stacklive chunk: 1 tags: Elastic/Welcome subject: Welcome to Elastic From d2b677ab6478e4d8f1a35567e2e12f837205aa72 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 3 Apr 2023 14:04:31 -0700 Subject: [PATCH 09/21] Test warnings --- .../all_books_broken_link_detection_spec.rb | 59 +++++++++++++++---- lib/ES/LinkCheck.pm | 38 +++++++++--- 2 files changed, 79 insertions(+), 18 deletions(-) diff --git a/integtest/spec/all_books_broken_link_detection_spec.rb b/integtest/spec/all_books_broken_link_detection_spec.rb index b21c6c5bf9e44..b2551c60e049a 100644 --- a/integtest/spec/all_books_broken_link_detection_spec.rb +++ b/integtest/spec/all_books_broken_link_detection_spec.rb @@ -21,10 +21,18 @@ include_context 'there is a broken link in the docs', 'https://www.elastic.co/guide/foo', check_links end + shared_context 'there is a broken absolute link to master' do |check_links| + include_context 'there is a broken link in the docs', + 'https://www.elastic.co/guide/foo', check_links + end shared_context 'there is a broken relative link in the docs' do |check_links| include_context 'there is a broken link in the docs', 'link:/guide/foo[]', check_links end + shared_context 'there is a broken relative link to master' do |check_links| + include_context 'there is a broken link in the docs', + 'link:/guide/foo[]', check_links + end shared_context 'there is a kibana link' do |check_links, url, expect_failure| convert_before do |src, dest| # Kibana is special and we check links in it with a little magic @@ -82,6 +90,18 @@ expect(outputs[0]).to include('Skipped Checking links') end end + describe 'when there is a broken absolute link to master' do + include_context 'there is a broken absolute link to master', false + it 'logs that it skipped link checking' do + expect(outputs[0]).to include('Skipped Checking links') + end + end + describe 'when there is a broken relative link to master' do + include_context 'there is a broken relative link to master', false + it 'logs that it skipped link checking' do + expect(outputs[0]).to include('Skipped Checking links') + end + end describe 'when there is a broken link in kibana' do include_context 'there is a broken link in kibana', false it 'logs that it skipped link checking' do @@ -106,6 +126,17 @@ LOG end end + shared_examples 'there are links to master in the docs' do + it 'logs there are master links' do + expect(outputs[-1]).to include('Bad master links:') + end + it 'logs the bad link' do + expect(outputs[-1]).to include(indent(<<~LOG.strip, ' ')) + /tmp/docsbuild/target_repo/html/test/current/chapter.html contains broken master links to: + - foo + LOG + end + end shared_examples 'there are broken links in kibana' do |url| it 'logs there are bad cross document links' do expect(outputs[-1]).to include('Bad cross-document links:') @@ -137,6 +168,14 @@ include_context 'there is a broken relative link in the docs', true include_examples 'there are broken links in the docs' end + describe 'when there is a broken absolute link to master' do + include_context 'there is a broken absolute link to master', true + include_examples 'there are links to master in the docs' + end + describe 'when there is a broken relative link to master' do + include_context 'there is a broken relative link to master', true + include_examples 'there are broken links in the docs' + end describe 'when there is a broken link in kibana' do include_context 'there is a broken link in kibana', true include_examples 'there are broken links in kibana', 'foo' @@ -150,25 +189,25 @@ include_context 'there is a kibana link', true, '${ELASTICSEARCH_DOCS}missing-page.html', true include_examples 'there are broken links in kibana', - 'en/elasticsearch/reference/master/missing-page.html' + 'en/elasticsearch/reference/current/missing-page.html' end describe 'when there is a broken Kibana guide link' do include_context 'there is a kibana link', true, '${KIBANA_DOCS}not-a-kibana-page.html', true include_examples 'there are broken links in kibana', - 'en/kibana/master/not-a-kibana-page.html' + 'en/kibana/current/not-a-kibana-page.html' end describe 'when there is a broken ES Plugin link' do include_context 'there is a kibana link', true, '${PLUGIN_DOCS}not-valid-plugin.html', true include_examples 'there are broken links in kibana', - 'en/elasticsearch/plugins/master/not-valid-plugin.html' + 'en/elasticsearch/plugins/current/not-valid-plugin.html' end describe 'when there is a broken Fleet link' do include_context 'there is a kibana link', true, '${FLEET_DOCS}not-a-fleet-page.html', true include_examples 'there are broken links in kibana', - 'en/fleet/master/not-a-fleet-page.html' + 'en/fleet/current/not-a-fleet-page.html' end describe 'when there is a broken APM link' do include_context 'there is a kibana link', true, @@ -180,37 +219,37 @@ include_context 'there is a kibana link', true, '${STACK_DOCS}not-a-stack-page.html', true include_examples 'there are broken links in kibana', - 'en/elastic-stack/master/not-a-stack-page.html' + 'en/elastic-stack/current/not-a-stack-page.html' end describe 'when there is a broken Security link' do include_context 'there is a kibana link', true, '${SECURITY_SOLUTION_DOCS}not-a-security-page.html', true include_examples 'there are broken links in kibana', - 'en/security/master/not-a-security-page.html' + 'en/security/current/not-a-security-page.html' end describe 'when there is a broken Stack Getting Started link' do include_context 'there is a kibana link', true, '${STACK_GETTING_STARTED}not-a-page.html', true include_examples 'there are broken links in kibana', - 'en/elastic-stack-get-started/master/not-a-page.html' + 'en/elastic-stack-get-started/current/not-a-page.html' end describe 'when there is a broken App Search link' do include_context 'there is a kibana link', true, '${APP_SEARCH_DOCS}not-a-search-page.html', true include_examples 'there are broken links in kibana', - 'en/app-search/master/not-a-search-page.html' + 'en/app-search/current/not-a-search-page.html' end describe 'when there is a broken Enterprise Search link' do include_context 'there is a kibana link', true, '${ENTERPRISE_SEARCH_DOCS}not-a-search-page.html', true include_examples 'there are broken links in kibana', - 'en/enterprise-search/master/not-a-search-page.html' + 'en/enterprise-search/current/not-a-search-page.html' end describe 'when there is a broken Workplace Search link' do include_context 'there is a kibana link', true, '${WORKPLACE_SEARCH_DOCS}not-a-search-page.html', true include_examples 'there are broken links in kibana', - 'en/workplace-search/master/not-a-search-page.html' + 'en/workplace-search/current/not-a-search-page.html' end describe 'when using --keep_hash and --sub_dir together like a PR test' do describe 'when there is a broken link in one of the books being built' do diff --git a/lib/ES/LinkCheck.pm b/lib/ES/LinkCheck.pm index 21d9c3720adf9..d2e2ea48a0acd 100644 --- a/lib/ES/LinkCheck.pm +++ b/lib/ES/LinkCheck.pm @@ -16,7 +16,7 @@ sub new { #=================================== my $class = shift; my $root = shift or die "No root dir specified"; - bless { root => $root, seen => {}, bad => {} }, $class; + bless { root => $root, seen => {}, bad => {}, warn => {} }, $class; } #=================================== @@ -63,8 +63,13 @@ sub check_source { while ( my ( $path, $fragment ) = $link_it->() ) { my $dest = $self->root->file($path); unless ( $self->_file_exists( $dest, $path ) ) { + if ($path =~ /master/) { + $self->add_warn( $file_descr, $path ); + } + else { $self->add_bad( $file_descr, $path ); - next; + } + next; } next unless $fragment; unless ( $self->_fragment_exists( $dest, $path, $fragment ) ) { @@ -90,16 +95,25 @@ sub report { #=================================== my $self = shift; my $bad = $self->bad; + my $warn = $self->warn; return "All cross-document links OK" - unless keys %$bad; - - my @error = "Bad cross-document links:"; - for my $file ( sort keys %$bad ) { + unless keys %$bad; + if (keys %$warn) { + my @warning = "Bad master links:"; + for my $file ( sort keys %$warn ) { + push @warning, " $file contains broken master links to:"; + push @warning, map {" - $_"} sort keys %{ $warn->{$file} }; + } + warn join "\n", @warning, ''; + } + if (keys %$bad) { + my @error = "Bad cross-document links:"; + for my $file ( sort keys %$bad ) { push @error, " $file contains broken links to:"; push @error, map {" - $_"} sort keys %{ $bad->{$file} }; + } + die join "\n", @error, ''; } - die join "\n", @error, ''; - } #=================================== @@ -137,10 +151,18 @@ sub add_bad { $self->bad->{$file}{$id} = 1; } +#=================================== +sub add_warn { +#=================================== + my ( $self, $file, $id ) = @_; + $self->warn->{$file}{$id} = 1; +} + #=================================== sub root { shift->{root} } sub seen { shift->{seen} } sub bad { shift->{bad} } +sub warn { shift->{warn} } sub has_bad { !keys %{ shift->bad } } #=================================== From 33074aa419a5dfdebf89236849ecedb6bc87c40b Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 3 Apr 2023 14:53:25 -0700 Subject: [PATCH 10/21] Revert "Test warnings" This reverts commit 7219c869ee2ec625ceed9aa51b669c3760dbb2fe. --- .../all_books_broken_link_detection_spec.rb | 59 ++++--------------- lib/ES/LinkCheck.pm | 38 +++--------- 2 files changed, 18 insertions(+), 79 deletions(-) diff --git a/integtest/spec/all_books_broken_link_detection_spec.rb b/integtest/spec/all_books_broken_link_detection_spec.rb index b2551c60e049a..b21c6c5bf9e44 100644 --- a/integtest/spec/all_books_broken_link_detection_spec.rb +++ b/integtest/spec/all_books_broken_link_detection_spec.rb @@ -21,18 +21,10 @@ include_context 'there is a broken link in the docs', 'https://www.elastic.co/guide/foo', check_links end - shared_context 'there is a broken absolute link to master' do |check_links| - include_context 'there is a broken link in the docs', - 'https://www.elastic.co/guide/foo', check_links - end shared_context 'there is a broken relative link in the docs' do |check_links| include_context 'there is a broken link in the docs', 'link:/guide/foo[]', check_links end - shared_context 'there is a broken relative link to master' do |check_links| - include_context 'there is a broken link in the docs', - 'link:/guide/foo[]', check_links - end shared_context 'there is a kibana link' do |check_links, url, expect_failure| convert_before do |src, dest| # Kibana is special and we check links in it with a little magic @@ -90,18 +82,6 @@ expect(outputs[0]).to include('Skipped Checking links') end end - describe 'when there is a broken absolute link to master' do - include_context 'there is a broken absolute link to master', false - it 'logs that it skipped link checking' do - expect(outputs[0]).to include('Skipped Checking links') - end - end - describe 'when there is a broken relative link to master' do - include_context 'there is a broken relative link to master', false - it 'logs that it skipped link checking' do - expect(outputs[0]).to include('Skipped Checking links') - end - end describe 'when there is a broken link in kibana' do include_context 'there is a broken link in kibana', false it 'logs that it skipped link checking' do @@ -126,17 +106,6 @@ LOG end end - shared_examples 'there are links to master in the docs' do - it 'logs there are master links' do - expect(outputs[-1]).to include('Bad master links:') - end - it 'logs the bad link' do - expect(outputs[-1]).to include(indent(<<~LOG.strip, ' ')) - /tmp/docsbuild/target_repo/html/test/current/chapter.html contains broken master links to: - - foo - LOG - end - end shared_examples 'there are broken links in kibana' do |url| it 'logs there are bad cross document links' do expect(outputs[-1]).to include('Bad cross-document links:') @@ -168,14 +137,6 @@ include_context 'there is a broken relative link in the docs', true include_examples 'there are broken links in the docs' end - describe 'when there is a broken absolute link to master' do - include_context 'there is a broken absolute link to master', true - include_examples 'there are links to master in the docs' - end - describe 'when there is a broken relative link to master' do - include_context 'there is a broken relative link to master', true - include_examples 'there are broken links in the docs' - end describe 'when there is a broken link in kibana' do include_context 'there is a broken link in kibana', true include_examples 'there are broken links in kibana', 'foo' @@ -189,25 +150,25 @@ include_context 'there is a kibana link', true, '${ELASTICSEARCH_DOCS}missing-page.html', true include_examples 'there are broken links in kibana', - 'en/elasticsearch/reference/current/missing-page.html' + 'en/elasticsearch/reference/master/missing-page.html' end describe 'when there is a broken Kibana guide link' do include_context 'there is a kibana link', true, '${KIBANA_DOCS}not-a-kibana-page.html', true include_examples 'there are broken links in kibana', - 'en/kibana/current/not-a-kibana-page.html' + 'en/kibana/master/not-a-kibana-page.html' end describe 'when there is a broken ES Plugin link' do include_context 'there is a kibana link', true, '${PLUGIN_DOCS}not-valid-plugin.html', true include_examples 'there are broken links in kibana', - 'en/elasticsearch/plugins/current/not-valid-plugin.html' + 'en/elasticsearch/plugins/master/not-valid-plugin.html' end describe 'when there is a broken Fleet link' do include_context 'there is a kibana link', true, '${FLEET_DOCS}not-a-fleet-page.html', true include_examples 'there are broken links in kibana', - 'en/fleet/current/not-a-fleet-page.html' + 'en/fleet/master/not-a-fleet-page.html' end describe 'when there is a broken APM link' do include_context 'there is a kibana link', true, @@ -219,37 +180,37 @@ include_context 'there is a kibana link', true, '${STACK_DOCS}not-a-stack-page.html', true include_examples 'there are broken links in kibana', - 'en/elastic-stack/current/not-a-stack-page.html' + 'en/elastic-stack/master/not-a-stack-page.html' end describe 'when there is a broken Security link' do include_context 'there is a kibana link', true, '${SECURITY_SOLUTION_DOCS}not-a-security-page.html', true include_examples 'there are broken links in kibana', - 'en/security/current/not-a-security-page.html' + 'en/security/master/not-a-security-page.html' end describe 'when there is a broken Stack Getting Started link' do include_context 'there is a kibana link', true, '${STACK_GETTING_STARTED}not-a-page.html', true include_examples 'there are broken links in kibana', - 'en/elastic-stack-get-started/current/not-a-page.html' + 'en/elastic-stack-get-started/master/not-a-page.html' end describe 'when there is a broken App Search link' do include_context 'there is a kibana link', true, '${APP_SEARCH_DOCS}not-a-search-page.html', true include_examples 'there are broken links in kibana', - 'en/app-search/current/not-a-search-page.html' + 'en/app-search/master/not-a-search-page.html' end describe 'when there is a broken Enterprise Search link' do include_context 'there is a kibana link', true, '${ENTERPRISE_SEARCH_DOCS}not-a-search-page.html', true include_examples 'there are broken links in kibana', - 'en/enterprise-search/current/not-a-search-page.html' + 'en/enterprise-search/master/not-a-search-page.html' end describe 'when there is a broken Workplace Search link' do include_context 'there is a kibana link', true, '${WORKPLACE_SEARCH_DOCS}not-a-search-page.html', true include_examples 'there are broken links in kibana', - 'en/workplace-search/current/not-a-search-page.html' + 'en/workplace-search/master/not-a-search-page.html' end describe 'when using --keep_hash and --sub_dir together like a PR test' do describe 'when there is a broken link in one of the books being built' do diff --git a/lib/ES/LinkCheck.pm b/lib/ES/LinkCheck.pm index d2e2ea48a0acd..21d9c3720adf9 100644 --- a/lib/ES/LinkCheck.pm +++ b/lib/ES/LinkCheck.pm @@ -16,7 +16,7 @@ sub new { #=================================== my $class = shift; my $root = shift or die "No root dir specified"; - bless { root => $root, seen => {}, bad => {}, warn => {} }, $class; + bless { root => $root, seen => {}, bad => {} }, $class; } #=================================== @@ -63,13 +63,8 @@ sub check_source { while ( my ( $path, $fragment ) = $link_it->() ) { my $dest = $self->root->file($path); unless ( $self->_file_exists( $dest, $path ) ) { - if ($path =~ /master/) { - $self->add_warn( $file_descr, $path ); - } - else { $self->add_bad( $file_descr, $path ); - } - next; + next; } next unless $fragment; unless ( $self->_fragment_exists( $dest, $path, $fragment ) ) { @@ -95,25 +90,16 @@ sub report { #=================================== my $self = shift; my $bad = $self->bad; - my $warn = $self->warn; return "All cross-document links OK" - unless keys %$bad; - if (keys %$warn) { - my @warning = "Bad master links:"; - for my $file ( sort keys %$warn ) { - push @warning, " $file contains broken master links to:"; - push @warning, map {" - $_"} sort keys %{ $warn->{$file} }; - } - warn join "\n", @warning, ''; - } - if (keys %$bad) { - my @error = "Bad cross-document links:"; - for my $file ( sort keys %$bad ) { + unless keys %$bad; + + my @error = "Bad cross-document links:"; + for my $file ( sort keys %$bad ) { push @error, " $file contains broken links to:"; push @error, map {" - $_"} sort keys %{ $bad->{$file} }; - } - die join "\n", @error, ''; } + die join "\n", @error, ''; + } #=================================== @@ -151,18 +137,10 @@ sub add_bad { $self->bad->{$file}{$id} = 1; } -#=================================== -sub add_warn { -#=================================== - my ( $self, $file, $id ) = @_; - $self->warn->{$file}{$id} = 1; -} - #=================================== sub root { shift->{root} } sub seen { shift->{seen} } sub bad { shift->{bad} } -sub warn { shift->{warn} } sub has_bad { !keys %{ shift->bad } } #=================================== From 84cb264ce7ea6204ad03ed456be3f11a46b7e2f9 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 12 Apr 2023 09:07:46 -0700 Subject: [PATCH 11/21] Change die to warning in link checks --- build_docs.pl | 2 +- lib/ES/LinkCheck.pm | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/build_docs.pl b/build_docs.pl index 1e96458a179cb..de50f47b7badd 100755 --- a/build_docs.pl +++ b/build_docs.pl @@ -337,7 +337,7 @@ sub check_links { say $link_checker->report; } else { - die $link_checker->report; + warn $link_checker->report; } } diff --git a/lib/ES/LinkCheck.pm b/lib/ES/LinkCheck.pm index 21d9c3720adf9..ff3a8708fe972 100644 --- a/lib/ES/LinkCheck.pm +++ b/lib/ES/LinkCheck.pm @@ -98,7 +98,7 @@ sub report { push @error, " $file contains broken links to:"; push @error, map {" - $_"} sort keys %{ $bad->{$file} }; } - die join "\n", @error, ''; + warn join "\n", @error, ''; } From a8d4bfcadba540d4fed69b15ab4fdbb2b87aeffe Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 12 Apr 2023 11:29:21 -0700 Subject: [PATCH 12/21] Change die to exit --- build_docs.pl | 2 +- lib/ES/LinkCheck.pm | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/build_docs.pl b/build_docs.pl index de50f47b7badd..02d3c57b2a8f9 100755 --- a/build_docs.pl +++ b/build_docs.pl @@ -337,7 +337,7 @@ sub check_links { say $link_checker->report; } else { - warn $link_checker->report; + exit $link_checker->report; } } diff --git a/lib/ES/LinkCheck.pm b/lib/ES/LinkCheck.pm index ff3a8708fe972..ff8656e5a4fab 100644 --- a/lib/ES/LinkCheck.pm +++ b/lib/ES/LinkCheck.pm @@ -98,7 +98,7 @@ sub report { push @error, " $file contains broken links to:"; push @error, map {" - $_"} sort keys %{ $bad->{$file} }; } - warn join "\n", @error, ''; + exit join "\n", @error, ''; } From 99f369ebc83a8ed5e0c31af14c187b656eb4c46c Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 12 Apr 2023 11:58:34 -0700 Subject: [PATCH 13/21] Revert "Change die to exit" This reverts commit 91a33d59461181b8cd1bbb1c340924d2e9d9def1. --- build_docs.pl | 2 +- lib/ES/LinkCheck.pm | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/build_docs.pl b/build_docs.pl index 02d3c57b2a8f9..de50f47b7badd 100755 --- a/build_docs.pl +++ b/build_docs.pl @@ -337,7 +337,7 @@ sub check_links { say $link_checker->report; } else { - exit $link_checker->report; + warn $link_checker->report; } } diff --git a/lib/ES/LinkCheck.pm b/lib/ES/LinkCheck.pm index ff8656e5a4fab..ff3a8708fe972 100644 --- a/lib/ES/LinkCheck.pm +++ b/lib/ES/LinkCheck.pm @@ -98,7 +98,7 @@ sub report { push @error, " $file contains broken links to:"; push @error, map {" - $_"} sort keys %{ $bad->{$file} }; } - exit join "\n", @error, ''; + warn join "\n", @error, ''; } From 1d34738a8f98af6756091ecdb2ad5a9cc9737713 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 12 Apr 2023 15:46:28 -0700 Subject: [PATCH 14/21] Fix Rust client config --- conf.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/conf.yaml b/conf.yaml index 282c5eeb9c388..e7a16f5959b4b 100644 --- a/conf.yaml +++ b/conf.yaml @@ -615,9 +615,9 @@ contents: path: docs/guide - title: Rust Client prefix: rust-api - current: master - branches: [ main, 8.6, 8.6, 8.4, 8.3, 8.2, 8.1, 8.0 ] - live: [ main, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] + current: main + branches: [ main, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0 ] + live: [ main, 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 From 0f6d3417a8c978c45d6ff2d621aecacb4fa7781e Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 17 Apr 2023 17:09:21 -0700 Subject: [PATCH 15/21] Add 8.6 and 8.7 version attribute files --- shared/versions/stack/8.6.asciidoc | 16 ++++++++-------- shared/versions/stack/8.7.asciidoc | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/shared/versions/stack/8.6.asciidoc b/shared/versions/stack/8.6.asciidoc index 9e333cbb84357..5de7aab8d6568 100644 --- a/shared/versions/stack/8.6.asciidoc +++ b/shared/versions/stack/8.6.asciidoc @@ -46,12 +46,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main diff --git a/shared/versions/stack/8.7.asciidoc b/shared/versions/stack/8.7.asciidoc index 11fec0e450d4f..e647524be2032 100644 --- a/shared/versions/stack/8.7.asciidoc +++ b/shared/versions/stack/8.7.asciidoc @@ -46,12 +46,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main From ef49d6384768ac749fc56f5d8e9e49f38c382993 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 25 Apr 2023 15:57:19 -0700 Subject: [PATCH 16/21] Add warnlinkcheck build option --- build_docs.pl | 11 +++++++++-- integtest/spec/helper/dest.rb | 5 +++++ lib/ES/LinkCheck.pm | 14 ++++++++------ 3 files changed, 22 insertions(+), 8 deletions(-) diff --git a/build_docs.pl b/build_docs.pl index de50f47b7badd..7a6314795d96d 100755 --- a/build_docs.pl +++ b/build_docs.pl @@ -337,9 +337,13 @@ sub check_links { say $link_checker->report; } else { - warn $link_checker->report; + if ( $Opts->{warnlinkcheck} ){ + say $link_checker->report; + } + else { + die $link_checker->report; + } } - } #=================================== @@ -1007,6 +1011,7 @@ sub command_line_opts { 'reference=s', 'reposcache=s', 'skiplinkcheck', + 'warnlinkcheck', 'sub_dir=s@', 'user=s', # Options only compatible with --preview @@ -1069,6 +1074,7 @@ sub usage { --repos_cache Directory to which working repositories are cloned. Defaults to `/.repos`. --skiplinkcheck Omit the step that checks for broken links + --warnlinkcheck Checks for broken links but does not fail if they exist --sub_dir Use a directory as a branch of some repo (eg --sub_dir elasticsearch:master:~/Code/elasticsearch) --target_repo Repository to which to commit docs @@ -1113,6 +1119,7 @@ sub check_opts { die('--rebuild only compatible with --all') if $Opts->{rebuild}; die('--reposcache only compatible with --all') if $Opts->{reposcache}; die('--skiplinkcheck only compatible with --all') if $Opts->{skiplinkcheck}; + die('--warnlinkcheck only compatible with --all') if $Opts->{warnlinkcheck}; die('--sub_dir only compatible with --all') if $Opts->{sub_dir}; } if ( !$Opts->{preview} ) { diff --git a/integtest/spec/helper/dest.rb b/integtest/spec/helper/dest.rb index f816d087dfbe4..3a1bb628246c7 100644 --- a/integtest/spec/helper/dest.rb +++ b/integtest/spec/helper/dest.rb @@ -235,6 +235,11 @@ def skip_link_check self end + def warn_link_check + @cmd += ['--warnlinkcheck'] + self + end + def keep_hash @cmd += ['--keep_hash'] self diff --git a/lib/ES/LinkCheck.pm b/lib/ES/LinkCheck.pm index ff3a8708fe972..72e2600e6f625 100644 --- a/lib/ES/LinkCheck.pm +++ b/lib/ES/LinkCheck.pm @@ -1,9 +1,8 @@ package ES::LinkCheck; - use strict; use warnings; use v5.10; -use ES::Util qw(run); +use ES::Util qw(run $Opts); our $Link_Re = qr{ (?:https?://(?:www.)?elastic.co|[\s"])/guide/ @@ -88,6 +87,7 @@ sub _link_extractor { #=================================== sub report { #=================================== + my ( $warnonly ) = @_; my $self = shift; my $bad = $self->bad; return "All cross-document links OK" @@ -98,8 +98,12 @@ sub report { push @error, " $file contains broken links to:"; push @error, map {" - $_"} sort keys %{ $bad->{$file} }; } - warn join "\n", @error, ''; - + if ($warnonly) { + return join "\n", @error, ''; + } + else { + die join "\n", @error, ''; + } } #=================================== @@ -143,5 +147,3 @@ sub seen { shift->{seen} } sub bad { shift->{bad} } sub has_bad { !keys %{ shift->bad } } #=================================== - -1 From ee21cc54a1f4787eda30ce1709adfdd0804b8426 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 10 May 2023 11:08:21 -0700 Subject: [PATCH 17/21] Warn on master links --- build_docs.pl | 17 ++++++----- integtest/spec/helper/dest.rb | 5 --- lib/ES/LinkCheck.pm | 49 +++++++++++++++++++++--------- shared/versions/stack/8.8.asciidoc | 20 ++++++------ 4 files changed, 55 insertions(+), 36 deletions(-) diff --git a/build_docs.pl b/build_docs.pl index e03207ac7d4f9..74a50e0eed0e5 100755 --- a/build_docs.pl +++ b/build_docs.pl @@ -333,16 +333,19 @@ sub check_links { check_kibana_links( $build_dir, $link_checker ) if exists $Conf->{repos}{kibana}; # Comment out due to build errors # check_elasticsearch_links( $build_dir, $link_checker ) if exists $Conf->{repos}{elasticsearch}; - if ( $link_checker->has_bad || $Opts->{warnlinkcheck}) { + if ( $Opts->{warnlinkcheck} || ($link_checker->has_bad && !$link_checker->has_warn)) { + #If --warnlinkcheck was specified or there are neither failing links nor warning links... don't die say $link_checker->report; } else { - if ( $Opts->{warnlinkcheck} ){ - say $link_checker->report; - } - else { - die $link_checker->report; - } + if (!$link_checker->has_bad) { + # If --warnlinkcheck was not specified and there are failing links... die + die $link_checker->report; + } + else { + # If --warnlinkcheck was not specified and there are no failing links but there are warning links... don't die + say $link_checker->report; + } } } diff --git a/integtest/spec/helper/dest.rb b/integtest/spec/helper/dest.rb index 3a1bb628246c7..f816d087dfbe4 100644 --- a/integtest/spec/helper/dest.rb +++ b/integtest/spec/helper/dest.rb @@ -235,11 +235,6 @@ def skip_link_check self end - def warn_link_check - @cmd += ['--warnlinkcheck'] - self - end - def keep_hash @cmd += ['--keep_hash'] self diff --git a/lib/ES/LinkCheck.pm b/lib/ES/LinkCheck.pm index 72e2600e6f625..f4c65488afa13 100644 --- a/lib/ES/LinkCheck.pm +++ b/lib/ES/LinkCheck.pm @@ -1,8 +1,9 @@ package ES::LinkCheck; + use strict; use warnings; use v5.10; -use ES::Util qw(run $Opts); +use ES::Util qw(run); our $Link_Re = qr{ (?:https?://(?:www.)?elastic.co|[\s"])/guide/ @@ -15,7 +16,7 @@ sub new { #=================================== my $class = shift; my $root = shift or die "No root dir specified"; - bless { root => $root, seen => {}, bad => {} }, $class; + bless { root => $root, seen => {}, bad => {}, warn => {} }, $class; } #=================================== @@ -37,7 +38,7 @@ sub check { if $item->basename =~ /\.html$/; } ); - return $self->has_bad; + return ($self->has_bad, $self->has_warn); } @@ -62,7 +63,12 @@ sub check_source { while ( my ( $path, $fragment ) = $link_it->() ) { my $dest = $self->root->file($path); unless ( $self->_file_exists( $dest, $path ) ) { - $self->add_bad( $file_descr, $path ); + if ($path =~ /master/) { + $self->add_warn( $file_descr, $path ); + } + else { + $self->add_bad( $file_descr, $path ); + } next; } next unless $fragment; @@ -87,23 +93,27 @@ sub _link_extractor { #=================================== sub report { #=================================== - my ( $warnonly ) = @_; my $self = shift; my $bad = $self->bad; + my $warn = $self->warn; return "All cross-document links OK" - unless keys %$bad; - - my @error = "Bad cross-document links:"; - for my $file ( sort keys %$bad ) { + unless ( keys %$bad || keys %$warn ); + if (keys %$bad) { + my @error = "Bad cross-document links:"; + for my $file ( sort keys %$bad ) { push @error, " $file contains broken links to:"; push @error, map {" - $_"} sort keys %{ $bad->{$file} }; - } - if ($warnonly) { - return join "\n", @error, ''; - } - else { + } die join "\n", @error, ''; } + if (keys %$warn) { + my @warning = "Bad master links:"; + for my $file ( sort keys %$warn ) { + push @warning, " $file contains broken links to:"; + push @warning, map {" - $_"} sort keys %{ $warn->{$file} }; + } + return join "\n", @warning, ''; + } } #=================================== @@ -141,9 +151,20 @@ sub add_bad { $self->bad->{$file}{$id} = 1; } +#=================================== +sub add_warn { +#=================================== + my ( $self, $file, $id ) = @_; + $self->warn->{$file}{$id} = 1; +} + #=================================== sub root { shift->{root} } sub seen { shift->{seen} } sub bad { shift->{bad} } sub has_bad { !keys %{ shift->bad } } +sub warn { shift->{warn} } +sub has_warn { !keys %{ shift->warn } } #=================================== + +1 diff --git a/shared/versions/stack/8.8.asciidoc b/shared/versions/stack/8.8.asciidoc index e1769079b8d70..4933c3ce83abc 100644 --- a/shared/versions/stack/8.8.asciidoc +++ b/shared/versions/stack/8.8.asciidoc @@ -14,10 +14,10 @@ bare_version never includes -alpha or -beta :prev-major-last: 7.17 :major-version-only: 8 :ecs_version: 8.8 -:esf_version: master +:esf_version: main ////////// -Keep the :esf_version: attribute value as master. +Keep the :esf_version: attribute value as main. ////////// ////////// @@ -51,12 +51,12 @@ APM Agent versions //// ECS Logging //// -:ecs-logging: master -:ecs-logging-go-logrus: master -:ecs-logging-go-zap: master +:ecs-logging: main +:ecs-logging-go-logrus: main +:ecs-logging-go-zap: main :ecs-logging-java: 1.x -:ecs-logging-dotnet: master -:ecs-logging-nodejs: master -:ecs-logging-php: master -:ecs-logging-python: master -:ecs-logging-ruby: master +:ecs-logging-dotnet: main +:ecs-logging-nodejs: main +:ecs-logging-php: main +:ecs-logging-python: main +:ecs-logging-ruby: main From 9e1923e3bf871f043e6e20501aac353db98b2244 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 10 May 2023 11:15:58 -0700 Subject: [PATCH 18/21] Update all_books_broken_link_detection_spec.rb integtest --- .../all_books_broken_link_detection_spec.rb | 147 +++++++++++------- 1 file changed, 95 insertions(+), 52 deletions(-) diff --git a/integtest/spec/all_books_broken_link_detection_spec.rb b/integtest/spec/all_books_broken_link_detection_spec.rb index b21c6c5bf9e44..361f2e452c21c 100644 --- a/integtest/spec/all_books_broken_link_detection_spec.rb +++ b/integtest/spec/all_books_broken_link_detection_spec.rb @@ -7,25 +7,33 @@ # repositories or the book's configuration. RSpec.describe 'building all books' do KIBANA_LINKS_FILE = 'src/core/public/doc_links/doc_links_service.ts' - shared_context 'there is a broken link in the docs' do |text, check_links| + shared_context 'there is a broken link' do |text, check, fail| convert_before do |src, dest| repo = src.repo_with_index 'repo', text book = src.book 'Test' book.source repo, 'index.asciidoc' convert = dest.prepare_convert_all src.conf - convert.skip_link_check unless check_links - convert.convert(expect_failure: check_links) + convert.skip_link_check unless check + convert.convert(expect_failure: fail) end end - shared_context 'there is a broken absolute link in the docs' do |check_links| - include_context 'there is a broken link in the docs', - 'https://www.elastic.co/guide/foo', check_links + shared_context 'there is a broken absolute link' do |check, fail| + include_context 'there is a broken link', + 'https://www.elastic.co/guide/foo', check, fail end - shared_context 'there is a broken relative link in the docs' do |check_links| - include_context 'there is a broken link in the docs', - 'link:/guide/foo[]', check_links + shared_context 'there is a broken relative link' do |check, fail| + include_context 'there is a broken link', + 'link:/guide/foo[]', check, fail end - shared_context 'there is a kibana link' do |check_links, url, expect_failure| + shared_context 'there is a broken absolute link to master' do |check, fail| + include_context 'there is a broken link', + 'https://www.elastic.co/guide/master/foo', check, fail + end + shared_context 'there is a broken relative link to master' do |check, fail| + include_context 'there is a broken link', + 'link:/guide/master/foo[]', check, fail + end + shared_context 'there is a kibana link' do |check, url, fail| convert_before do |src, dest| # Kibana is special and we check links in it with a little magic kibana_repo = src.repo 'kibana' @@ -57,33 +65,33 @@ book.current_branch = 'main' convert = dest.prepare_convert_all src.conf - convert.skip_link_check unless check_links - convert.convert(expect_failure: expect_failure) + convert.skip_link_check unless check + convert.convert(expect_failure: fail) end end - - shared_context 'there is a broken link in kibana' do |check_links| - # If we check links, we expect failure, and if we don't check links, we - # don't expect failure. - include_context 'there is a kibana link', check_links, - '${ELASTIC_WEBSITE_URL}guide/foo', check_links + shared_context 'there is a broken link in kibana' do |check, fail| + include_context 'there is a kibana link', check, + '${ELASTIC_WEBSITE_URL}guide/foo', fail + end + shared_context 'there is a broken link in kibana to master' do |check, fail| + include_context 'there is a kibana link', check, + '${ELASTIC_WEBSITE_URL}guide/master/foo', fail end - describe 'when broken link detection is disabled' do - describe 'when there is a broken absolute link in the docs' do - include_context 'there is a broken absolute link in the docs', false + describe 'when there is a broken absolute link' do + include_context 'there is a broken absolute link', false, false it 'logs that it skipped link checking' do expect(outputs[0]).to include('Skipped Checking links') end end - describe 'when there is a broken relative link in the docs' do - include_context 'there is a broken relative link in the docs', false + describe 'when there is a broken relative link' do + include_context 'there is a broken relative link', false, false it 'logs that it skipped link checking' do expect(outputs[0]).to include('Skipped Checking links') end end describe 'when there is a broken link in kibana' do - include_context 'there is a broken link in kibana', false + include_context 'there is a broken link in kibana', false, false it 'logs that it skipped link checking' do expect(outputs[0]).to include('Skipped Checking links') end @@ -95,7 +103,7 @@ expect(outputs[-1]).to include('All cross-document links OK') end end - shared_examples 'there are broken links in the docs' do + shared_examples 'there are broken links' do it 'logs there are bad cross document links' do expect(outputs[-1]).to include('Bad cross-document links:') end @@ -106,6 +114,17 @@ LOG end end + shared_examples 'there are broken links to master' do + it 'logs there are master links' do + expect(outputs[-1]).to include('Bad master links') + end + it 'logs the bad link to master' do + expect(outputs[-1]).to include(indent(<<~LOG.strip, ' ')) + /tmp/docsbuild/target_repo/html/test/current/chapter.html contains broken links to: + - master/foo + LOG + end + end shared_examples 'there are broken links in kibana' do |url| it 'logs there are bad cross document links' do expect(outputs[-1]).to include('Bad cross-document links:') @@ -117,6 +136,17 @@ LOG end end + shared_examples 'there are broken links in kibana to master' do |url| + it 'logs there are bad cross document links' do + expect(outputs[-1]).to include('Bad master links:') + end + it 'logs the bad link' do + expect(outputs[-1]).to include(indent(<<~LOG.strip, ' ')) + Kibana [master]: src/core/public/doc_links/doc_links_service.ts contains broken links to: + - #{url} + LOG + end + end describe 'when all of the links are intact' do convert_before do |src, dest| repo = src.repo_with_index( @@ -129,18 +159,31 @@ end include_examples 'all links are ok' end - describe 'when there is a broken absolute link in the docs' do - include_context 'there is a broken absolute link in the docs', true - include_examples 'there are broken links in the docs' + describe 'when there is a broken absolute link' do + include_context 'there is a broken absolute link', true, true + include_examples 'there are broken links' + end + describe 'when there is a broken relative link' do + include_context 'there is a broken relative link', true, true + include_examples 'there are broken links' end - describe 'when there is a broken relative link in the docs' do - include_context 'there is a broken relative link in the docs', true - include_examples 'there are broken links in the docs' + describe 'when there is a broken absolute link to master' do + include_context 'there is a broken absolute link to master', true, false + include_examples 'there are broken links to master' + end + describe 'when there is a broken relative link to master' do + include_context 'there is a broken relative link to master', true, false + include_examples 'there are broken links to master' end describe 'when there is a broken link in kibana' do - include_context 'there is a broken link in kibana', true + include_context 'there is a broken link in kibana', true, true include_examples 'there are broken links in kibana', 'foo' end + describe 'when there is a broken link in kibana to master' do + include_context 'there is a broken link in kibana to master', true, false + include_examples 'there are broken links in kibana to master', + 'master/foo' + end describe 'when a link in kibana goes to the website outside the guide' do include_context 'there is a kibana link', true, '${ELASTIC_WEBSITE_URL}not-part-of-the-guide', false @@ -148,26 +191,26 @@ end describe 'when there is a broken Elasticsearch Guide link in Kibana' do include_context 'there is a kibana link', true, - '${ELASTICSEARCH_DOCS}missing-page.html', true - include_examples 'there are broken links in kibana', + '${ELASTICSEARCH_DOCS}missing-page.html', false + include_examples 'there are broken links in kibana to master', 'en/elasticsearch/reference/master/missing-page.html' end describe 'when there is a broken Kibana guide link' do include_context 'there is a kibana link', true, - '${KIBANA_DOCS}not-a-kibana-page.html', true - include_examples 'there are broken links in kibana', + '${KIBANA_DOCS}not-a-kibana-page.html', false + include_examples 'there are broken links in kibana to master', 'en/kibana/master/not-a-kibana-page.html' end describe 'when there is a broken ES Plugin link' do include_context 'there is a kibana link', true, - '${PLUGIN_DOCS}not-valid-plugin.html', true - include_examples 'there are broken links in kibana', + '${PLUGIN_DOCS}not-valid-plugin.html', false + include_examples 'there are broken links in kibana to master', 'en/elasticsearch/plugins/master/not-valid-plugin.html' end describe 'when there is a broken Fleet link' do include_context 'there is a kibana link', true, - '${FLEET_DOCS}not-a-fleet-page.html', true - include_examples 'there are broken links in kibana', + '${FLEET_DOCS}not-a-fleet-page.html', false + include_examples 'there are broken links in kibana to master', 'en/fleet/master/not-a-fleet-page.html' end describe 'when there is a broken APM link' do @@ -178,38 +221,38 @@ end describe 'when there is a broken Stack link' do include_context 'there is a kibana link', true, - '${STACK_DOCS}not-a-stack-page.html', true - include_examples 'there are broken links in kibana', + '${STACK_DOCS}not-a-stack-page.html', false + include_examples 'there are broken links in kibana to master', 'en/elastic-stack/master/not-a-stack-page.html' end describe 'when there is a broken Security link' do include_context 'there is a kibana link', true, - '${SECURITY_SOLUTION_DOCS}not-a-security-page.html', true - include_examples 'there are broken links in kibana', + '${SECURITY_SOLUTION_DOCS}not-a-security-page.html', false + include_examples 'there are broken links in kibana to master', 'en/security/master/not-a-security-page.html' end describe 'when there is a broken Stack Getting Started link' do include_context 'there is a kibana link', true, - '${STACK_GETTING_STARTED}not-a-page.html', true - include_examples 'there are broken links in kibana', + '${STACK_GETTING_STARTED}not-a-page.html', false + include_examples 'there are broken links in kibana to master', 'en/elastic-stack-get-started/master/not-a-page.html' end describe 'when there is a broken App Search link' do include_context 'there is a kibana link', true, - '${APP_SEARCH_DOCS}not-a-search-page.html', true - include_examples 'there are broken links in kibana', + '${APP_SEARCH_DOCS}not-a-search-page.html', false + include_examples 'there are broken links in kibana to master', 'en/app-search/master/not-a-search-page.html' end describe 'when there is a broken Enterprise Search link' do include_context 'there is a kibana link', true, - '${ENTERPRISE_SEARCH_DOCS}not-a-search-page.html', true - include_examples 'there are broken links in kibana', + '${ENTERPRISE_SEARCH_DOCS}not-a-search-page.html', false + include_examples 'there are broken links in kibana to master', 'en/enterprise-search/master/not-a-search-page.html' end describe 'when there is a broken Workplace Search link' do include_context 'there is a kibana link', true, - '${WORKPLACE_SEARCH_DOCS}not-a-search-page.html', true - include_examples 'there are broken links in kibana', + '${WORKPLACE_SEARCH_DOCS}not-a-search-page.html', false + include_examples 'there are broken links in kibana to master', 'en/workplace-search/master/not-a-search-page.html' end describe 'when using --keep_hash and --sub_dir together like a PR test' do From feed144bddd03be8cb34158cb2643ff10c6b9e7f Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 11 May 2023 12:19:00 -0700 Subject: [PATCH 19/21] Add missing stackcurrent --- conf.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/conf.yaml b/conf.yaml index 0d9be4ca63a1b..19af3f557f455 100644 --- a/conf.yaml +++ b/conf.yaml @@ -76,6 +76,7 @@ contents_title: Welcome to Elastic Docs # : & # The keys don't really matter, but by convention the are the same as the variable. variables: + stackcurrent: &stackcurrent 8.7 stacklive: &stacklive [ main, 8.8, 8.7, 8.6, 7.17 ] cloudSaasCurrent: &cloudSaasCurrent ms-90 From 12ff3ad11cd3387feb6c49cbd5c4bf264e515d50 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 11 May 2023 17:10:21 -0700 Subject: [PATCH 20/21] Fix ESF version --- conf.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/conf.yaml b/conf.yaml index 19af3f557f455..701db09a3d428 100644 --- a/conf.yaml +++ b/conf.yaml @@ -1895,7 +1895,7 @@ contents: prefix: en/esf index: docs/en/index.asciidoc current: main - branches: [ {main: master} ] + branches: [ main ] live: [ main ] chunk: 2 tags: Cloud Native Ingest/Reference From 45204d11630c231482021ed7de6cf415cd48f684 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 11 May 2023 17:15:20 -0700 Subject: [PATCH 21/21] Update main.asciidoc --- shared/versions/stack/main.asciidoc | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/shared/versions/stack/main.asciidoc b/shared/versions/stack/main.asciidoc index bccbfdd0b47b8..ef9e2fa9d757d 100644 --- a/shared/versions/stack/main.asciidoc +++ b/shared/versions/stack/main.asciidoc @@ -1,19 +1,20 @@ -:version: 8.7.0 +:version: 8.9.0 //// bare_version never includes -alpha or -beta //// -:bare_version: 8.7.0 -:logstash_version: 8.7.0 -:elasticsearch_version: 8.7.0 -:kibana_version: 8.7.0 -:apm_server_version: 8.7.0 +:bare_version: 8.9.0 +:logstash_version: 8.9.0 +:elasticsearch_version: 8.9.0 +:kibana_version: 8.9.0 +:apm_server_version: 8.9.0 :branch: main -:minor-version: 8.7 +:minor-version: 8.9 :major-version: 8.x :prev-major-version: 7.x :prev-major-last: 7.17 :major-version-only: 8 -:ecs_version: 8.6 +:ecs_version: main +:esf_version: main ////////// release-state can be: released | prerelease | unreleased