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

[8.13](backport #3674) Update APM URLs #3711

Merged
merged 1 commit into from
Mar 27, 2024
Merged

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Mar 27, 2024

Summary

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

Task list

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
  1. 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
```<hr>This is an automatic backport of pull request #3674 done by [Mergify](https://mergify.com).

(cherry picked from commit c60b759)
@mergify mergify bot requested a review from a team as a code owner March 27, 2024 19:36
@mergify mergify bot added the backport label Mar 27, 2024
Copy link
Contributor

A documentation preview will be available soon.

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.

@bmorelli25 bmorelli25 enabled auto-merge (squash) March 27, 2024 19:37
@bmorelli25 bmorelli25 merged commit 01ff359 into 8.13 Mar 27, 2024
7 checks passed
@bmorelli25 bmorelli25 deleted the mergify/bp/8.13/pr-3674 branch March 27, 2024 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants