Update APM URLs

[bmorelli25]

Summary

This PR updates our APM documentation by prepending the APM documentation paths with apm-.

Task list

• [Pre-req] Remove old release note redirects Temporarily comment out release note redirects #3688
• [Pre-req] Update release note URLs Update release note URLs to include apm- apm-server#12820
• [Pre-req] Create and test redirect list (WIP Google Sheet)
• [This PR] Revert #3688 and add new redirects for release notes
• [This PR] Update all URL paths to include apm-
• [after merge] Request 301 redirects from marketing

URLs not updated

The following URLs had paths already prepended with apm- and thus do not need redirects:

/apm.html
/apm-agent-auth.html
/apm-breaking.html
/apm-data-security.html
/apm-data-streams.html
/apm-distributed-tracing.html
/apm-integration-upgrade-steps.html
/apm-integration-upgrade-steps-ess.html
/apm-integration-upgrade-steps.html
/apm-k8s-attacher.html
/apm-mutating-admission-webhook.html
/apm-rum.html
/apm-server-configuration.html
/apm-server-starting.html

Related

For #3573.

Process

Documenting my process below in case we need to make similar changes in the future. Note that this is absolutely not performant, but it somehow does work! The bash file in step two takes ~3 minutes to run.

1. I replaced all APM headings in VSC:

Find: \[\[(.+)\]\]
Replace: [[apm-$1]]
Include: docs/en/observability/apm

2. I found all headings in the APM documentation that were prepended with apm-*. For each heading, this script searches for links missing apm-* and automatically adds them.

grep -Rih "\[\[apm-" /Users/brandon/Documents/GitHub/observability-docs/docs/en/observability/apm > headings.txt
cat headings.txt | while read line
do
  data=$(echo $line | sed -r 's/\[\[apm-(.*)\]\]$/\1/')
  echo $data
  # Update internal links
  sed -i '' "s/\<\<$data/\<\<apm-$data/g" $(find . -type f -name "*.asciidoc" 2>/dev/null)
  # Update external links (mostly in redirects file)
  sed -i '' "s/\observability-guide\}\/$data/\observability-guide\}\/apm-$data/g" $(find . -type f -name "*.asciidoc" 2>/dev/null)
done

[github-actions]

A documentation preview will be available soon.

• 🔨 Buildkite builds
• 📚 HTML diff
• 📙 Preview page

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.}

[simitt]

@bmorelli25 the broken links sections mean, that these links will forward to the new pages?

I'm generally +1 on the changes, but it doesn't update the release note URLs, which I think are especially misleading with e.g. https://www.elastic.co/guide/en/observability/current/release-notes-8.12.html. Is this something that you intend to pick up later?

[bmorelli25]

@bmorelli25 the broken links sections mean, that these links will forward to the new pages?

Sorry, those comments were for me for debugging purposes. You can ignore them.

I'm generally +1 on the changes, but it doesn't update the release note URLs, which I think are especially misleading with e.g. https://www.elastic.co/guide/en/observability/current/release-notes-8.12.html. Is this something that you intend to pick up later?

Fair point. Working on that in conjunction with this PR now.

[bmorelli25]

Okay, this PR is ready for review again. This PR prepends all APM URLs, including release note URLs, with apm-. I plan on merging this PR and backporting to 8.13. When the 8.13 release goes out, we'll ask marketing to implement the redirects listed in this google sheet.

[simitt]

LGTM;
@bmorelli25 are you taking care of the follow up actions mentioned in the related issue?
You'll need to collaborate with @jmlrt on updating the URLs in a follow up PR.

[mdbirnstiehl]

👍

[mdbirnstiehl]

🐦