Skip to content

docs(ai-sre): quickstart additions — automatic incident analysis & BYOC Runner - #201

Merged
ysyneu merged 2 commits into
feat/ai-srefrom
feat/ai-sre-quickstart-additions
Jul 22, 2026
Merged

docs(ai-sre): quickstart additions — automatic incident analysis & BYOC Runner#201
ysyneu merged 2 commits into
feat/ai-srefrom
feat/ai-sre-quickstart-additions

Conversation

@ysyneu

@ysyneu ysyneu commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Two additions requested for the published quickstart, plus drift fixes found on the way.

Quickstart (zh + en)

  • 让每条新故障自动得到第一轮分析 — new build-out section: create a rule from the 故障自动分析 template, enable the On-call incident trigger, pick channels/severities; every matching new incident gets an automatic investigation with a summary comment written back to the incident (conclusion first, session link, rides the incident's notification chain). Explicitly contrasted with war-room auto-diagnosis (independent paths).
  • 部署一个 BYOC Runner(约 3 分钟) — new build-out section: 4 steps (create self-hosted Environment → run generated install command → Pending→Online → pick it in the composer's environment picker), plus the three first-success gotchas (outbound reachability, sudo, ~90s heartbeat cycle). Details stay in the environments reference page.

Automations (zh + en)

  • Documented the PR fc-safari#595 behavior (merged to feat/ai-sre): at run end, AI SRE writes one summary comment back to the triggering incident — previously undocumented.
  • Fixed stale template example names to the shipped set: 每周洞察 / 告警治理 / 故障自动分析 / On-call 负载分析 (was 告警噪音分析 / 事故响应复盘 / 每周值班洞察 / 升级和值班负载分析) — same fix in the quickstart's Automations entry.

Verification

  • mint broken-links: clean.
  • Rendered check on mint dev: all 4 changed pages HTTP 200, new sections present, anchor IDs #on-call-故障触发 / #on-call-incident-trigger exist and match the new links.
  • Template names verified against fc-safari etc/automation_templates/{zh-CN,en-US}.yml on feat/ai-sre.

Note: the write-back behavior ships with fc-safari feat/ai-sre (#595, merged 2026-07-21) — keep the usual docs-release-after-backend-deploy ordering.

ysyneu added 2 commits July 22, 2026 05:24
…r walkthrough

Two additions to the 15-minute quickstart, both in the build-out section:
- Get every new incident analyzed automatically: On-call Incident Analysis
  template + On-call incident trigger, result written back as an incident
  comment; contrasted with war-room auto-diagnosis.
- Deploy a BYOC Runner (~3 minutes): create self-hosted Environment, run
  the generated install command, Pending→Online, pick it in the composer.
Also aligns example template names with the shipped set.
The On-call incident trigger section now covers the run-end behavior:
one summary comment written back to the triggering incident (conclusion
first, session link at the end), delivered via the incident's existing
notification chain — automatic for every rule with this trigger.
Template example names updated to the shipped set (Weekly Insights /
Alert Governance / On-call Incident Analysis / On-call Load Analysis).
@ysyneu
ysyneu merged commit be440c0 into feat/ai-sre Jul 22, 2026
ysyneu added a commit that referenced this pull request Aug 12, 2026
…itions

docs(ai-sre): quickstart additions — automatic incident analysis & BYOC Runner
ysyneu added a commit that referenced this pull request Aug 12, 2026
…itions

docs(ai-sre): quickstart additions — automatic incident analysis & BYOC Runner
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant