-
Notifications
You must be signed in to change notification settings - Fork 164
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
Align formatting of APM rules with other rules docs #4366
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
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 and/or @dedemorton can you take a look and let me know what you think? |
In general, I think what you've done is fine. Unfortunately there are a lot of inconsistencies across the alerting topics we've developed, so suggesting the best way forward is a little tricky. (See the issue I opened about this problem.) I'm not sure who should make the final decision about how to structure these docs (maybe Lisa?), but I think we need to establish a repeatable pattern and stick with it (in the Obs docs, in the Kibana docs, etc). To meet the immediate objective (getting the APM rules broken out into separate topics and organized with other rules), I'm OK with you sticking to the format you have here with the understanding that we will clean this up later. |
This pull request is now in conflict. Could you fix it @colleenmcginnis? 🙏
|
# Conflicts: # docs/en/observability/apm-alerts.asciidoc # docs/en/observability/apm/act-on-data/index.asciidoc
Good stuff! I like where this is heading. |
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.
🌸 ❗❗
* split apm alerts and format like other rule docs * fill out individual apm rule pages * address feedback * apm ui -> applications ui --------- Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> (cherry picked from commit 49453be)
* split apm alerts and format like other rule docs * fill out individual apm rule pages * address feedback * apm ui -> applications ui --------- Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> (cherry picked from commit 49453be)
* split apm alerts and format like other rule docs * fill out individual apm rule pages * address feedback * apm ui -> applications ui --------- Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> (cherry picked from commit 49453be) Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
* split apm alerts and format like other rule docs * fill out individual apm rule pages * address feedback * apm ui -> applications ui --------- Co-authored-by: bmorelli25 <brandon.morelli@elastic.co> (cherry picked from commit 49453be) Co-authored-by: Colleen McGinnis <colleen.mcginnis@elastic.co>
* split apm alerts and format like other rule docs * fill out individual apm rule pages * address feedback * apm ui -> applications ui --------- Co-authored-by: bmorelli25 <brandon.morelli@elastic.co>
Description
Aligns formatting of APM rules with other rules docs. This includes:
So far, I've fully written the APM Anomaly rule page. If the team thinks this is a good approach, I'll finish building out the content on the pages for the rest of the APM-related rules.Preview: https://observability-docs_bk_4366.docs-preview.app.elstc.co/guide/en/observability/master/apm-alerts.html
Documentation sets edited in this PR
Check all that apply.
docs/en/observability/*
)docs/en/serverless/*
)docs/en/integrations/*
)Related issue
Closes #4040
Checklist
Product/Engineering ReviewFollow-up tasks
Select one.
I'm not going to port to serverless right now because:
Let me know if you have any concerns about this approach!