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

Clean up APM getting started intro page #4599

Merged
merged 2 commits into from
Dec 13, 2024

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Nov 27, 2024

Description

Cleans up the APM getting started intro page as discussed in #4336 including:

  • Which option is the "easiest": @simitt @bmorelli25 what do you think about just removing the note at the top and letting users determine which is the easiest method for their situation? If we can't say that one is easier than the other without explaining the context, then I'm not sure it makes sense to have a note at the top.
  • What's preventing feature parity: I moved this note to the part of the table that discusses supported outputs.
  • Required components: I rephrased the Elastic Agent list item (I was going to use a footnote but I was having trouble using it inside a list that's inside a table).
  • I also deleted a big block of commented out content since we can get it from the git history if needed, but let me know if you think we should keep it.

Documentation sets edited in this PR

Check all that apply.

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #4336

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

Select one.

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

@colleenmcginnis colleenmcginnis added backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify labels Nov 27, 2024
@colleenmcginnis colleenmcginnis self-assigned this Nov 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 previously approved these changes Dec 4, 2024
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.

I'm good with these changes. The Get Started page is now a quick overview, a brief pro/con list of each option, and the flowchart to help people decide. I think there's enough context on the page for users to decide which option is easiest for their use case.

@eedugon

This comment was marked as off-topic.

@eedugon

This comment was marked as off-topic.

@simitt

This comment was marked as off-topic.

@eedugon

This comment was marked as off-topic.

@colleenmcginnis
Copy link
Contributor Author

@eedugon do you mind if we move your comments to a separate issue? I think updating the diagram and the other subpages in the getting started section are out of scope for this PR, which aims to address the issues listed in #4336.

@eedugon
Copy link
Contributor

eedugon commented Dec 4, 2024

@colleenmcginnis , totally! sorry for having jumped in without a clear scope of the changes! 🙏

I'll create an issue for the APM installation guide and its relation with the Fleet Setup, which I think it's probably the most important part of my comment.

@colleenmcginnis
Copy link
Contributor Author

Moved @eedugon's comments to #4668 and #4669. Hiding them in this PR.

@colleenmcginnis colleenmcginnis merged commit 494830b into elastic:main Dec 13, 2024
5 checks passed
@colleenmcginnis colleenmcginnis deleted the issue-4336 branch December 13, 2024 15:39
mergify bot pushed a commit that referenced this pull request Dec 13, 2024
* clean up apm getting started intro page

* Update docs/en/observability/apm/getting-started-apm/index.asciidoc

(cherry picked from commit 494830b)
mergify bot pushed a commit that referenced this pull request Dec 13, 2024
* clean up apm getting started intro page

* Update docs/en/observability/apm/getting-started-apm/index.asciidoc

(cherry picked from commit 494830b)
mergify bot pushed a commit that referenced this pull request Dec 13, 2024
* clean up apm getting started intro page

* Update docs/en/observability/apm/getting-started-apm/index.asciidoc

(cherry picked from commit 494830b)
colleenmcginnis added a commit that referenced this pull request Dec 13, 2024
* clean up apm getting started intro page

* Update docs/en/observability/apm/getting-started-apm/index.asciidoc

(cherry picked from commit 494830b)

Co-authored-by: Colleen McGinnis <[email protected]>
colleenmcginnis added a commit that referenced this pull request Dec 13, 2024
* clean up apm getting started intro page

* Update docs/en/observability/apm/getting-started-apm/index.asciidoc

(cherry picked from commit 494830b)

Co-authored-by: Colleen McGinnis <[email protected]>
colleenmcginnis added a commit that referenced this pull request Dec 13, 2024
* clean up apm getting started intro page

* Update docs/en/observability/apm/getting-started-apm/index.asciidoc

(cherry picked from commit 494830b)

Co-authored-by: Colleen McGinnis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.x Automated backport to the 8.x branch with mergify backport-8.16 Automated backport with mergify backport-8.17 Automated backport with mergify needs-dev-review needs-writer-review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request]: Review APM getting started landing page
4 participants