[hold until 8.12] [apm docs consolidation] Update landing pages and A…

…PM 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
elastic · Jan 17, 2024 · 88f50cf · 88f50cf
1 parent ad6c96d
commit 88f50cf
Show file tree

Hide file tree

Showing 6 changed files with 86 additions and 6 deletions.
diff --git 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
@@ -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
@@ -0,0 +1,42 @@
+<style>
+#content > .ulist .itemizedlist {
+  visibility: hidden;
+}
+</style>
+
+<div class="w-100 mb-5">
+  <h2>APM user guide</h2>
+  <p>
+    Learn how to use APM in the <a href="/guide/en/observability/current/apm.html">Observability guide</a>.
+  </p>
+  <div class="note admon">
+    <div class="icon"></div>
+      <div class="admon_content">
+      <p>
+        To view APM documentation for versions before 8.12, go to the <a href="/guide/en/apm/guide/index.html">APM guide</a> instead.
+      </p>
+    </div>
+  </div>
+</div>
+<div class="w-100 mb-5">
+  <h2>APM agents</h2>
+  <ul>
+    <li><a href="/guide/en/apm/agent/android/current/intro.html">Android Agent Reference</a></li>
+    <li><a href="/guide/en/apm/agent/go/current/introduction.html">Go Agent Reference</a></li>
+    <li><a href="/guide/en/apm/agent/swift/current/intro.html">iOS Agent Reference</a></li>
+    <li><a href="/guide/en/apm/agent/java/current/intro.html">Java Agent Reference</a></li>
+    <li><a href="/guide/en/apm/agent/dotnet/current/intro.html">.NET Agent Reference</a></li>
+    <li><a href="/guide/en/apm/agent/nodejs/current/intro.html">Node.js Agent Reference</a></li>
+    <li><a href="/guide/en/apm/agent/php/current/intro.html">PHP Agent Reference</a></li>
+    <li><a href="/guide/en/apm/agent/python/current/getting-started.html">Python Agent Reference</a></li>
+    <li><a href="/guide/en/apm/agent/ruby/current/introduction.html">Ruby Agent Reference</a></li>
+    <li><a href="/guide/en/apm/agent/rum-js/current/intro.html">Real User Monitoring JavaScript Agent Reference</a></li>
+  </ul>
+</div>
+<div class="w-100 mb-5">
+  <h2>APM extensions</h2>
+  <ul>
+    <li><a href="/guide/en/apm/lambda/current/aws-lambda-arch.html">APM AWS Lambda extension</a></li>
+    <li><a href="/guide/en/apm/attacher/current/apm-attacher.html">APM attacher</a></li>
+  </ul>
+</div>
diff --git a/extra/apm_guide_landing.html b/extra/apm_guide_landing.html
@@ -0,0 +1,36 @@
+<style>
+  #content > .ulist .itemizedlist {
+    visibility: hidden;
+  }
+</style>
+
+<div class="w-100 mb-5">
+  <div class="important admon">
+    <div class="icon"></div>
+      <div class="admon_content">
+      <p class="font-weight-bold">
+        Starting with version 8.12, the content from the APM guide has been moved to
+        the <a class="font-weight-bold" href="/guide/en/observability/current/apm.html">Observability guide</a>.
+      </p>
+    </div>
+  </div>
+</div>
+<div class="w-100 mb-5">
+  <h2>Previous versions:</h2>
+  <ul>
+    <li><a href="/guide/en/apm/guide/8.11/index.html">APM Guide: 8.11</a></li>
+    <li><a href="/guide/en/apm/guide/8.10/index.html">APM Guide: 8.10</a></li>
+    <li><a href="/guide/en/apm/guide/8.9/index.html">APM Guide: 8.9</a></li>
+    <li><a href="/guide/en/apm/guide/8.8/index.html">APM Guide: 8.8</a></li>
+    <li><a href="/guide/en/apm/guide/8.7/index.html">APM Guide: 8.7</a></li>
+    <li><a href="/guide/en/apm/guide/8.6/index.html">APM Guide: 8.6</a></li>
+    <li><a href="/guide/en/apm/guide/8.5/index.html">APM Guide: 8.5</a></li>
+    <li><a href="/guide/en/apm/guide/8.4/index.html">APM Guide: 8.4</a></li>
+    <li><a href="/guide/en/apm/guide/8.3/index.html">APM Guide: 8.3</a></li>
+    <li><a href="/guide/en/apm/guide/8.2/index.html">APM Guide: 8.2</a></li>
+    <li><a href="/guide/en/apm/guide/8.1/index.html">APM Guide: 8.1</a></li>
+    <li><a href="/guide/en/apm/guide/8.0/index.html">APM Guide: 8.0</a></li>
+    <li><a href="/guide/en/apm/guide/7.17/index.html">APM Guide: 7.17</a></li>
+    <li><a href="/guide/en/apm/guide/7.16/index.html">APM Guide: 7.16</a></li>
+  </ul>
+</div>
diff --git a/extra/client_docs_landing.html b/extra/client_docs_landing.html
@@ -60,7 +60,7 @@
         <h2>Welcome to the Clients documentation</h2>
       </p>
       <p>
-        You can find the documentation of all the offical Elasticsearch clients here!
+        You can find the documentation of all the official Elasticsearch clients here!
       </p>
     </div>
     <div class="col-md-6 col-12">

diff --git 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)
           <ul>
           <li class="dropdown-category">APM</li>
           <ul>
-          <li><a href="/guide/en/apm/guide/current/apm-overview.html">User Guide</a></li>
+          <li><a href="/guide/en/observability/current/apm.html">Observability › APM</a></li>
           </ul>
           <li class="dropdown-category">APM agents</li>
           <ul>
@@ -33,7 +33,7 @@ def generate_apm_breadcrumbs(doc)
           </ul>
           <li class="dropdown-category">APM extensions</li>
           <ul>
-          <li><a href="/guide/en/apm/lambda/current/aws-lambda-arch.html">Monitoring AWS Lambda Functions</a></li>
+          <li><a href="/guide/en/apm/lambda/current/aws-lambda-arch.html">AWS Lambda extension</a></li>
           <li><a href="/guide/en/apm/attacher/current/apm-attacher.html">Attacher</a></li>
           </ul>
           </ul>