Skip to content

Conversation

@colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Aug 5, 2025

In #2310 we moved the Fleet-managed and APM Server binary getting started guides to the Fleet and Elastic Agent section of the reference documentation. Then Fleet-managed guide could possibly belong there, but the APM binary guide definitely doesn't since it doesn't use Fleet or Elastic Agent.

Here's my proposal:

  • Create a new Work with APM Server section (a working title) in the Observability solution section of the docs.
  • Put the existing APM Server specific content (Configure APM Server and Monitor APM Server) into the new Work with APM Server section.
  • Create a new subsection in Work with APM Server that will contain the Fleet-managed and APM Server binary getting started guides. In this draft PR I called it Set up to avoid using Get started, but I'm not sure if that's the right title.
  • Recreates the comparison content that was removed in Rewrite APM get started docs #2310 on the Set up page.
  • Delete the Fleet-managed and APM Server binary getting started guides from the Fleet and Elastic Agent section.

Alternatives considered:

  • Keeping the Fleet-managed getting started guide in the Fleet and Elastic Agent section of the reference docs, and only moving the binary guide.
    • Why not? It makes more sense (especially to me) to keep these two guides close together alongside the content that helps users decide between the two approaches.
  • Moving both the old getting started guides into a new APM Server section of the reference section.
    • Why not? The bulk of the APM Server content is well-established in the solutions guide. I think users will have a hard time finding previously established solutions content in a new reference section that contains only non-reference content.

Is there an alternative approach I'm not considering?

cc @bmorelli25 @theletterf @simitt

@colleenmcginnis colleenmcginnis self-assigned this Aug 5, 2025
@github-actions
Copy link

github-actions bot commented Aug 5, 2025

⚠️ Markdown file changes detected

The following 2 Markdown files were renamed in this PR:

  • reference/fleet/get-started-apm-server-binary.mdsolutions/observability/apm/apm-server-binary.md
  • reference/fleet/get-started-managed-apm-server.mdsolutions/observability/apm/apm-server-fleet-managed.md

Action Required

We currently do not have an easy way to implement redirects for removed or renamed files. If possible, please:

  • Keep files whenever possible and hide them from the TOC by using hidden
  • Add a notice at the top of the file indicating that the page has moved with a link to the new location
  • Ensure you've updated redirects.yml accordingly if files must be removed or renamed

Thank you!

@elastic elastic deleted a comment from github-actions bot Aug 5, 2025
Copy link
Contributor

@theletterf theletterf left a comment

Choose a reason for hiding this comment

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

@colleenmcginnis I love this. While working on #2310 I noticed APM Server docs needed a recognizable home. This PR provides just that. Good job!

I only left a couple comments to preserve Get Started links as they are in the intros.

@github-actions
Copy link

github-actions bot commented Aug 5, 2025

⚠️ Markdown file changes detected

The following 2 Markdown files were renamed in this PR:

  • reference/fleet/get-started-apm-server-binary.mdsolutions/observability/apm/apm-server-binary.md
  • reference/fleet/get-started-managed-apm-server.mdsolutions/observability/apm/apm-server-fleet-managed.md

Action Required

We currently do not have an easy way to implement redirects for removed or renamed files. If possible, please:

  • Keep files whenever possible and hide them from the TOC by using hidden
  • Add a notice at the top of the file indicating that the page has moved with a link to the new location
  • Ensure you've updated redirects.yml accordingly if files must be removed or renamed

Thank you!

@colleenmcginnis colleenmcginnis marked this pull request as ready for review August 5, 2025 19:31
@colleenmcginnis colleenmcginnis requested review from a team as code owners August 5, 2025 19:31
Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

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

LGTM. I'll let @mdbirnstiehl take a quick look too since this is a significant move

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.

Keeping the Fleet-managed getting started guide in the Fleet and Elastic Agent section of the reference docs, and only moving the binary guide.

Agreed that keeping these two options side-by-side is best for our users.

Moving both the old getting started guides into a new APM Server section of the reference section.

a new reference section that contains only non-reference content

🤪 let's not do that.

I think this is the right approach. No notes on overall structure. Just a few comments on content.

Copy link
Contributor

@mdbirnstiehl mdbirnstiehl left a comment

Choose a reason for hiding this comment

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

Approach and content LGTM! 🐦

Copy link
Contributor

@simitt simitt left a comment

Choose a reason for hiding this comment

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

Left two notes, but generally looks good to keep apm-server docs together but less prominent.

We recommend you use the same version of {{es}}, {{kib}}, and APM Server. See [Installing the {{stack}}](/get-started/the-stack.md) for more information about installing these products.

:::{image} /reference/fleet/images/observability-apm-architecture-diy.png
:::{image} /solutions/images/observability-apm-architecture-diy.png
Copy link
Contributor

Choose a reason for hiding this comment

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

Is ## Step 4: Install APM agents [apm-next-steps] still something that we want to show in this level of detail for the apm-server choice? Asking as there is also https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2410/solutions/observability/apm/elastic-apm-agents

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'm going to leave that section as is for now so we can at least get these guides back into the observability docs. Let's discuss this in a follow-up issue.

@colleenmcginnis colleenmcginnis enabled auto-merge (squash) August 7, 2025 20:39
@colleenmcginnis colleenmcginnis merged commit fed69be into main Aug 7, 2025
7 of 8 checks passed
@colleenmcginnis colleenmcginnis deleted the move-apm-get-started-guides branch August 7, 2025 20:40
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.

7 participants