-
Notifications
You must be signed in to change notification settings - Fork 25k
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
[AutoOps] Reference AutoOps solution on troubleshooting pages #119630
Conversation
Documentation preview: |
@alaudazzi please enable the option "Allow edits and access to secrets by maintainers" on your PR. For more information, see the documentation. |
Pinging @elastic/es-docs (Team:Docs) |
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.
It will be automatically activated for your deployment, with no installation required.
these are elasticsearch docs, so this isn't true (AutoOps is cloud only).
this note is also very large and prominent. could we instead introduce autoops as an optional tool in the monitoring section instead of on all of the troubleshooting pages, with the caveat that it's available for cloud hosted only?
To avoid these docs needing an edit in future, it would be nice to not frame this as an announcement, and instead as one of the options we offer.
Thank you for your feedback, @shainaraskas. |
@alaudazzi @shainaraskas -
We want to make AutoOps the go-to solution for Elastic Cloud monitoring, it is free to use and available to all cloud users. |
these pages are shared by all of the deployment types, so we need to be very careful to provide that context, especially using language like "automatically activated". I'd prefer that we cut this down to something like "If you're using Elastic Cloud Hosted, then you can use AutoOps to xyz", perhaps with one "benefit" sentence, then link out.
My main concern is the size and lifespan of these notes. Ideally, we'd explain how AutoOps would help them to identify this issue specifically to hint that AutoOps is relevant to them.
I agree that this is a good goal to have, but given the audience of these docs, we need to be more deliberate with our messaging. |
Thanks @shainaraskas for your comments.
Can we go with this text? |
Consider the following edit. I recommend not including the rollout info here but instead in the "Monitor with AutoOps" topic so we only have to remove it in one place. I'd also prefer this note to be below the overview for each page so people can understand what the page is about
|
@shainaraskas I am OK with your suggestions. |
@shainaraskas @arnonst |
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
… (#120181) * Reference AutoOps on troubleshooting pages * Integrate reviewer's feedback (cherry picked from commit 70e5a67) # Conflicts: # docs/reference/troubleshooting/common-issues/circuit-breaker-errors.asciidoc # docs/reference/troubleshooting/common-issues/hotspotting.asciidoc Co-authored-by: Arianna Laudazzi <46651782+alaudazzi@users.noreply.github.com>
This PR updates the troubleshooting pages to reference AutoOps as the go-to solution.
Relates to https://github.com/elastic/obs-docs-projects/issues/279