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

[migration] Update current branch for APM agent docs #3185

Merged
merged 1 commit into from
Mar 12, 2025

Conversation

colleenmcginnis
Copy link
Contributor

Follow up to #3173

We're migrating the latest major version of each APM agent's docs from AsciiDoc to Markdown. Because of the way APM agent teams manage release branches, it's important that they are able to force push from main to the latest major version branch.

In the initial migration PRs (https://github.com/elastic/docs-eng-team/issues/130), we deleted AsciiDoc files and added Markdown files to main. We should also do the same for the latest major version to make it easier for engineers to make changes to the latest version. But, if we delete the AsciiDoc files on the latest major version branch, we need to pull AsciiDoc files from a different branch for the next ~3 weeks (until the Markdown docs are live on elastic.co).

I created a new do-not-delete_legacy-docs branch off the latest major version branch in each apm-agent-* repo. We can use this temporary branch to continue publishing AsciiDoc docs until the new docs are live.

@bmorelli25 feel free to correct me and/or elaborate if I missed anything!

@colleenmcginnis colleenmcginnis self-assigned this Mar 11, 2025
Copy link

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.

@colleenmcginnis colleenmcginnis marked this pull request as ready for review March 11, 2025 22:19
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner March 11, 2025 22:19
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.

LGTM, thanks!

@colleenmcginnis colleenmcginnis merged commit 4fac579 into master Mar 12, 2025
5 checks passed
@colleenmcginnis colleenmcginnis deleted the apm-agent-temp-branches branch March 12, 2025 14:36
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