From 0d5c9a4205d42ec1de52fc3eb690bd3904c46213 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Wed, 3 Jan 2024 09:50:20 -0600 Subject: [PATCH 1/9] update apm dropdown --- resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb b/resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb index 2e990d92b363d..44404cba44f9f 100644 --- a/resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb +++ b/resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb @@ -16,7 +16,7 @@ def generate_apm_breadcrumbs(doc) From 4d97e6f3a771a82576c1e9ecdbd13b3aa3d1c76e Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Wed, 3 Jan 2024 11:46:49 -0600 Subject: [PATCH 5/9] attempt to add note to apm guide landing page --- conf.yaml | 1 + extra/apm_guide_landing.html | 9 +++++++++ 2 files changed, 10 insertions(+) create mode 100644 extra/apm_guide_landing.html diff --git a/conf.yaml b/conf.yaml index 9738c175394b4..898562370afb6 100644 --- a/conf.yaml +++ b/conf.yaml @@ -445,6 +445,7 @@ contents: sections: - title: APM Guide prefix: guide + toc_extra: extra/apm_guide_landing.html index: docs/en/apm-server/integrations-index.asciidoc current: *stackcurrent branches: [ {main: master}, 8.12, 8.11, 8.10, 8.9, 8.8, 8.7, 8.6, 8.5, 8.4, 8.3, 8.2, 8.1, 8.0, 7.17, 7.16 ] diff --git a/extra/apm_guide_landing.html b/extra/apm_guide_landing.html new file mode 100644 index 0000000000000..0862760b88b60 --- /dev/null +++ b/extra/apm_guide_landing.html @@ -0,0 +1,9 @@ +
+
+
+

+ Starting with version 8.12, the content from the APM guide has been moved to + the Observability guide. +

+
+
From 93ad8505c788e64093f8339dd12b71f219cf14ac Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Wed, 3 Jan 2024 14:28:06 -0600 Subject: [PATCH 6/9] only show previous versions on apm guide landing page --- extra/apm_guide_landing.html | 41 ++++++++++++++++++++++++++++++------ 1 file changed, 34 insertions(+), 7 deletions(-) diff --git a/extra/apm_guide_landing.html b/extra/apm_guide_landing.html index 0862760b88b60..464731714c59d 100644 --- a/extra/apm_guide_landing.html +++ b/extra/apm_guide_landing.html @@ -1,9 +1,36 @@ -
-
-
-

- Starting with version 8.12, the content from the APM guide has been moved to - the Observability guide. -

+ + +
+
+
+
+

+ Starting with version 8.12, the content from the APM guide has been moved to + the Observability guide. +

+
+
+

Previous versions:

+ +
From 72095b899dc9cdf96d6d8102ae0de00b909f5343 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Wed, 3 Jan 2024 14:30:04 -0600 Subject: [PATCH 7/9] update links to current --- extra/apm_docs_landing.html | 2 +- extra/apm_guide_landing.html | 2 +- resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/extra/apm_docs_landing.html b/extra/apm_docs_landing.html index 34dc97538fe55..be53e8e85e609 100644 --- a/extra/apm_docs_landing.html +++ b/extra/apm_docs_landing.html @@ -7,7 +7,7 @@

APM user guide

- Learn how to use APM in the Observability guide. + Learn how to use APM in the Observability guide.

diff --git a/extra/apm_guide_landing.html b/extra/apm_guide_landing.html index 464731714c59d..a70fcfe1bca2c 100644 --- a/extra/apm_guide_landing.html +++ b/extra/apm_guide_landing.html @@ -10,7 +10,7 @@

Starting with version 8.12, the content from the APM guide has been moved to - the Observability guide. + the Observability guide.

diff --git a/resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb b/resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb index 109e635bab504..75e011345a84d 100644 --- a/resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb +++ b/resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb @@ -16,7 +16,7 @@ def generate_apm_breadcrumbs(doc)
  • APM
  • APM agents
      • From f03576da61de60496516517b46ad646d98c01e05 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Wed, 3 Jan 2024 14:34:10 -0600 Subject: [PATCH 8/9] whoops --- extra/apm_guide_landing.html | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/extra/apm_guide_landing.html b/extra/apm_guide_landing.html index a70fcfe1bca2c..d810c2381e134 100644 --- a/extra/apm_guide_landing.html +++ b/extra/apm_guide_landing.html @@ -18,19 +18,19 @@

      Previous versions:

      From 2eb5592840937611d4f63ba329f27c06bac84122 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Tue, 16 Jan 2024 22:43:55 -0600 Subject: [PATCH 9/9] update build aliases --- doc_build_aliases.sh | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc_build_aliases.sh b/doc_build_aliases.sh index 427635b2bacd4..33f27bb8735e8 100644 --- a/doc_build_aliases.sh +++ b/doc_build_aliases.sh @@ -110,7 +110,7 @@ alias docbldeesr='$GIT_HOME/docs/build_docs --doc $GIT_HOME/enterprise-search-ru alias docbldewsn='$GIT_HOME/docs/build_docs --doc $GIT_HOME/enterprise-search-pubs/client-docs/workplace-search-node/index.asciidoc --single' # Observability Guide 8.8 and later -alias docbldob='$GIT_HOME/docs/build_docs --doc $GIT_HOME/observability-docs/docs/en/observability/index.asciidoc --chunk 2 --resource $GIT_HOME/apm-server/docs/guide --resource=$GIT_HOME/ingest-docs/docs' +alias docbldob='$GIT_HOME/docs/build_docs --doc $GIT_HOME/observability-docs/docs/en/observability/index.asciidoc --chunk 3 --resource $GIT_HOME/apm-server --resource=$GIT_HOME/ingest-docs/docs' # Observability Guide 8.7 and earlier alias docbldobold='$GIT_HOME/docs/build_docs --doc $GIT_HOME/observability-docs/docs/en/observability/index.asciidoc --chunk 2 --resource $GIT_HOME/beats/libbeat/docs --resource $GIT_HOME/apm-server/docs/guide --resource=$GIT_HOME/ingest-docs/docs' @@ -176,8 +176,8 @@ alias docbldim='$GIT_HOME/docs/build_docs --doc $GIT_HOME/ingest-docs/docs/en/in # Integrations developer guide alias docbldidg='$GIT_HOME/docs/build_docs --doc $GIT_HOME/observability-docs/docs/en/integrations/index.asciidoc --resource=$GIT_HOME/package-spec/versions --chunk 2' -# APM Guide -alias docbldapm=' $GIT_HOME/docs/build_docs --doc $GIT_HOME/apm-server/docs/integrations-index.asciidoc --resource=$GIT_HOME/observability-docs/ --resource=$GIT_HOME/ingest-docs/ --chunk 2 --open' +# APM Guide (7.16-8.11) +alias docbldapm=' $GIT_HOME/docs/build_docs --doc $GIT_HOME/observability/docs/en/apm-server/integrations-index.asciidoc --resource=$GIT_HOME/apm-server/ --resource=$GIT_HOME/ingest-docs/ --chunk 2 --open' # APM Agents alias docbldama='$GIT_HOME/docs/build_docs --doc $GIT_HOME/apm-agent-android/docs/index.asciidoc --chunk 1'