From 88f50cfbf594b6fa288b289f86faa0f79b2cb7a3 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Wed, 17 Jan 2024 11:03:10 -0600 Subject: [PATCH] [hold until 8.12] [apm docs consolidation] Update landing pages and APM breadcrumb dropdown (#2879) * update apm dropdown * attempt to add a custom apm landing page * temporarily use master instead of current * add note linking to prev versions, address feedback from @bmorelli25 * attempt to add note to apm guide landing page * only show previous versions on apm guide landing page * update links to current * whoops * update build aliases --- conf.yaml | 2 + doc_build_aliases.sh | 6 +-- extra/apm_docs_landing.html | 42 +++++++++++++++++++ extra/apm_guide_landing.html | 36 ++++++++++++++++ extra/client_docs_landing.html | 2 +- .../lib/chunker/obs_breadcrumbs.rb | 4 +- 6 files changed, 86 insertions(+), 6 deletions(-) create mode 100644 extra/apm_docs_landing.html create mode 100644 extra/apm_guide_landing.html diff --git a/conf.yaml b/conf.yaml index 354a1e4af959c..ecaabf00e9a36 100644 --- a/conf.yaml +++ b/conf.yaml @@ -441,9 +441,11 @@ contents: path: shared/attributes.asciidoc - title: Application Performance Monitoring (APM) base_dir: en/apm + toc_extra: extra/apm_docs_landing.html sections: - title: APM Guide prefix: guide + toc_extra: extra/apm_guide_landing.html index: docs/en/apm-server/integrations-index.asciidoc current: *stackcurrent branches: [ {main: master}, 8.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/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' diff --git a/extra/apm_docs_landing.html b/extra/apm_docs_landing.html new file mode 100644 index 0000000000000..be53e8e85e609 --- /dev/null +++ b/extra/apm_docs_landing.html @@ -0,0 +1,42 @@ + + +
+

APM user guide

+

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

+
+
+
+

+ To view APM documentation for versions before 8.12, go to the APM guide instead. +

+
+
+
+
+

APM agents

+ +
+
+

APM extensions

+ +
diff --git a/extra/apm_guide_landing.html b/extra/apm_guide_landing.html new file mode 100644 index 0000000000000..d810c2381e134 --- /dev/null +++ b/extra/apm_guide_landing.html @@ -0,0 +1,36 @@ + + +
+
+
+
+

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

+
+
+
+
+

Previous versions:

+ +
diff --git a/extra/client_docs_landing.html b/extra/client_docs_landing.html index a29c2283ebc86..aacd7cd310edc 100644 --- a/extra/client_docs_landing.html +++ b/extra/client_docs_landing.html @@ -60,7 +60,7 @@

Welcome to the Clients documentation

- You can find the documentation of all the offical Elasticsearch clients here! + You can find the documentation of all the official Elasticsearch clients here!

diff --git a/resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb b/resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb index 2e990d92b363d..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)