Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[hold until 8.12] [apm docs consolidation] Update landing pages and APM breadcrumb dropdown #2879

Merged
merged 9 commits into from
Jan 17, 2024
Merged

[hold until 8.12] [apm docs consolidation] Update landing pages and APM breadcrumb dropdown #2879

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0d5c9a4
update apm dropdown
colleenmcginnis Jan 3, 2024
11dc2df
attempt to add a custom apm landing page
colleenmcginnis Jan 3, 2024
83a4953
temporarily use master instead of current
colleenmcginnis Jan 3, 2024
099d3a2
add note linking to prev versions, address feedback from @bmorelli25
colleenmcginnis Jan 3, 2024
4d97e6f
attempt to add note to apm guide landing page
colleenmcginnis Jan 3, 2024
93ad850
only show previous versions on apm guide landing page
colleenmcginnis Jan 3, 2024
72095b8
update links to current
colleenmcginnis Jan 3, 2024
f03576d
whoops
colleenmcginnis Jan 3, 2024
2eb5592
update build aliases
colleenmcginnis Jan 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions conf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ]
Expand Down
6 changes: 3 additions & 3 deletions doc_build_aliases.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Comment on lines -179 to +180
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating these


# APM Agents
alias docbldama='$GIT_HOME/docs/build_docs --doc $GIT_HOME/apm-agent-android/docs/index.asciidoc --chunk 1'
Expand Down
42 changes: 42 additions & 0 deletions extra/apm_docs_landing.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
36 changes: 36 additions & 0 deletions extra/apm_guide_landing.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
2 changes: 1 addition & 1 deletion extra/client_docs_landing.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
4 changes: 2 additions & 2 deletions resources/asciidoctor/lib/chunker/obs_breadcrumbs.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand Down