-
Notifications
You must be signed in to change notification settings - Fork 157
Rewrite APM get started docs #2310
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
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! Great use of snippets.
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.
Good stuff 👍 . A couple comments
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.
If @mdbirnstiehl likes it, I like it 👍
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](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2410/solutions/observability/apm/apm-server) section (a working title) in the Observability solution section of the docs. * Put the existing APM Server specific content ([Configure APM Server](https://www.elastic.co/docs/solutions/observability/apm/configure-apm-server) and [Monitor APM Server](https://www.elastic.co/docs/solutions/observability/apm/monitor-apm-server)) into the new _Work with APM Server_ section. * Create a new subsection in [Work with APM Server](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2410/solutions/observability/apm/apm-server) that will contain the Fleet-managed and APM Server binary getting started guides. In this draft PR I called it [Set up](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2410/solutions/observability/apm/apm-server-setup) to avoid using _Get started_, but I'm not sure if that's the right title. * Recreates the comparison content that was removed in #2310 on the [Set up](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/2410/solutions/observability/apm/apm-server-setup) 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 --------- Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
Fixes #2309