-
Notifications
You must be signed in to change notification settings - Fork 184
Relocate APM Server getting started content #2410
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
Conversation
|
theletterf
left a comment
There was a problem hiding this 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.
|
florent-leborgne
left a comment
There was a problem hiding this 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
bmorelli25
left a comment
There was a problem hiding this 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.
Co-authored-by: Brandon Morelli <[email protected]>
mdbirnstiehl
left a comment
There was a problem hiding this 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! 🐦
simitt
left a comment
There was a problem hiding this 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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
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:
Alternatives considered:
Is there an alternative approach I'm not considering?
cc @bmorelli25 @theletterf @simitt