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.

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

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

Merged

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Jan 3, 2024

Related to https://github.com/elastic/obs-docs-projects/issues/216

Update how users navigate to APM content in the Observability guide from other pages in elastic.co/guide/*:

⚠️ Before merging:

  • Update Observability > APM links to use current instead of master

cc @bmorelli25

@colleenmcginnis colleenmcginnis self-assigned this Jan 3, 2024
Copy link

github-actions bot commented Jan 3, 2024

A documentation preview will be available soon.

Help us out by validating the Buildkite preview and reporting issues here.
Please also be sure to double check all images to ensure they are correct in the preview.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@colleenmcginnis
Copy link
Contributor Author

If the custom landing page renders as expected, it should look something like this:

Screenshot 2024-01-03 at 10 22 07 AM

Comment on lines 18 to 36
<div class="w-100 mb-5">
<h2>Previous versions:</h2>
<ul>
<li><a href="/guide/en/apm/agent/guide/8.11/index.html">APM Guide: 8.11</a></li>
<li><a href="/guide/en/apm/agent/guide/8.10/index.html">APM Guide: 8.10</a></li>
<li><a href="/guide/en/apm/agent/guide/8.9/index.html">APM Guide: 8.9</a></li>
<li><a href="/guide/en/apm/agent/guide/8.8/index.html">APM Guide: 8.8</a></li>
<li><a href="/guide/en/apm/agent/guide/8.7/index.html">APM Guide: 8.7</a></li>
<li><a href="/guide/en/apm/agent/guide/8.6/index.html">APM Guide: 8.6</a></li>
<li><a href="/guide/en/apm/agent/guide/8.5/index.html">APM Guide: 8.5</a></li>
<li><a href="/guide/en/apm/agent/guide/8.4/index.html">APM Guide: 8.4</a></li>
<li><a href="/guide/en/apm/agent/guide/8.3/index.html">APM Guide: 8.3</a></li>
<li><a href="/guide/en/apm/agent/guide/8.2/index.html">APM Guide: 8.2</a></li>
<li><a href="/guide/en/apm/agent/guide/8.1/index.html">APM Guide: 8.1</a></li>
<li><a href="/guide/en/apm/agent/guide/8.0/index.html">APM Guide: 8.0</a></li>
<li><a href="/guide/en/apm/agent/guide/7.17/index.html">APM Guide: 7.17</a></li>
<li><a href="/guide/en/apm/agent/guide/7.16/index.html">APM Guide: 7.16</a></li>
</ul>
</div>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated this and hard-coded previous versions so we could still keep publishing 8.12 and master to keep the temporary redirects up (and satisfy the link checker) without linking to them here.

Screenshot 2024-01-03 at 2 27 13 PM

bmorelli25
bmorelli25 previously approved these changes Jan 3, 2024
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

🐐

@colleenmcginnis colleenmcginnis changed the title [apm docs consolidation] Update landing pages and APM breadcrumb dropdown [hold until 8.12] [apm docs consolidation] Update landing pages and APM breadcrumb dropdown Jan 3, 2024
@colleenmcginnis
Copy link
Contributor Author

@elasticmachine, run elasticsearch-ci/docs

@colleenmcginnis colleenmcginnis marked this pull request as ready for review January 17, 2024 15:50
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner January 17, 2024 15:50
Comment on lines -179 to +180
# 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'
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

@colleenmcginnis colleenmcginnis merged commit 88f50cf into elastic:master Jan 17, 2024
4 checks passed
@colleenmcginnis colleenmcginnis deleted the apm-consolidation-landing-pages branch January 17, 2024 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants