Repository navigation
docs(doc-review): 2026-10-22 diff audit — Prometheus Alertmanager rename, related raw-log results, symbol-file time filter, typo redirect - #1119
Merged
Conversation
added 2 commits
October 22, 2026 08:21
…ame, related raw-log results, symbol-file time filter, typo redirect - on-call/integration: alert-source card renamed to Prometheus Alertmanager (5 pages, zh+en) - on-call: related-query results split by query type (table vs raw log lines, 3-row hover cap) - rum: symbol-file list time-filter limits (30-day span, 365-day lookback) - docs.json: additive redirects for the product's erro-reporting typo path - held: IM natural-language chat settings (flag off in prod), schedule robot @ mentions (console control not shipped)
…block restructure, editable group, investigation min step - monitors/alert-rules/sls.mdx: SLS now supports per-series no-data detection (only tencent_cls is excluded); drop the stale 'existing rules' section - monitors/quickstart: event block is flat and reordered (channel, notes, repeat, custom fields, related queries) and custom fields are tag+dialog - monitors/quickstart + folders: the group row is an editable dropdown when editing a rule - monitors/alert-rules/investigation-entries: 最小步长 is now a first-class query-entry field (Prometheus/Loki range queries)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doc Review — 2026-10-22
Mode: diff (since 2026-10-21T08:02:38Z, the previous successful run)
Findings: 14 total — 3 high, 4 medium, 7 low · applied 9 · skipped 1 · held 4
Window with real changes:
fc-event,fc-oncall,fc-datasource,fc-rum,fc-safari,monit-edge,fc-foundation-app,fc-saas-web,fc-saas-monit,ai-sre-web,fc-saas-rum(andfc-pgy, tests only). Zero-commit repos in the window:fc-statuspage,monit-webapi,flashduty-app,flashduty-cli,go-flashduty,flashduty-mcp-server,terraform-provider-flashduty,ai-assistant-web,flashduty-website(each verifiedbase == headand cross-checked through the GitHub commits API).Changes
docs.json/rum/error-tracking/erro-reporting/web→error-reporting/web(zh + en), so shipped console builds stop 404ing,zhHeld (documented next round, not in this PR)
ai-sre)chat_settings+ fc-safariim-settingsskill, its card tip, and the skill-list entry) ships behind deploy flagaiSreNlSettings, which is default false;etc/deploy.ymlturns it on for dev/test only and says production enables it per rollout. Documenting it now would describe a chat behaviour customers cannot use yet.config/config.go:117-123,etc/deploy.yml:12-14on-call)fc-saas-web pages/Schedular/components/BasicSettings/ChatNotifyWay/*still renders only address/Token and alias — no @ switch, no mapping-table selector. fc-oncall's own rollout note orders oncall → event → frontend entry.cron/robot_mentions.go,models/notify.go,docs/oncall-robot-mentions.md; fc-saas-web atorigin/mainSkipped
monitors): a new read-only rule page exists (/monit/rule/detail/:id, breadcrumb 查看规则, six block sections, bottom 编辑). Its only inbound links today are the rule IDs inside the Monitors overview problem list, and that overview page is itself undocumented — writing a section about a page the reader cannot reach from a documented flow would not pass the delete test. Worth a page once the rule list links to it.zh/ai-sre/im.mdx:208(outside this window, not edited): the page says any account member can bind a session to any team, butfc-event logic/ai_sre/scope_resolution.go:544resolves targets throughGetPersonTeams, i.e. only teams the caller belongs to; the same subsection also says/scope personalworks in group chats, whilescope_resolution.go:63-65refuses it there. Flagged for a human rather than fixed inside a diff-mode PR.model/pgpart,model/shadowread, query-shape changes), fc-rum issue counters / view deactivation, monit-edge HTTP/2 ping health check, fc-datasourcelast_source_time(no console consumer), thefc-foundation-appdocsBaseUrlprivate-deployment knob (deployment config, not a console capability), and the whole antd→meow-ui migration infc-saas-monitandfc-foundation-app: no user-visible capability or documented value changed.Review checklist
Prometheus → Prometheus Alertmanagerrename is live in the target environment (it is indeploy/data_source_plugin_init.sqland in migration2026-10-21_t_data_source_plugin_prometheus_alertmanager_name.sql; the console reads the name fromt_data_source_plugin.type_name)Cross-repo follow-ups (flashduty-website)
lib/integrations/catalog.ts:754-763— the integrations catalog still listsid: "prometheus", name: { zh: "Prometheus", en: "Prometheus" }with the blurb "接入 Alertmanager,把 Prometheus 告警送入 On-call 工作流", anddocsPath: on-call/integration/alert-integration/alert-sources/prometheus. If the console card is now Prometheus Alertmanager, the catalog name should follow; the docs page it points at keeps its Prometheus title.Mapping warnings
derivative_surfaces.comparison_pagestill points atzh|en/on-call/quickstart/comparison.mdx, which does not exist; the real comparison pages arezh|en/on-call/comparison/vs-pagerduty.mdxandvs-opsgenie.mdx. The comparison check ran by hand this round and found no Flashduty-side cell affected by the changes above.mcp-server(developer/mcp-server/) andterraform(developer/terraform/)docs_pathentries are directories that do not exist; the pages arezh|en/developer/mcp-server.mdxandzh|en/developer/terraform.mdx. Those two modules were therefore not cross-referenced this round.fc-saas-web/fc-saas-monit/fc-saas-rum/ai-sre-webare mapped asfc-foundation-appsubmodule paths; this run scanned them as standalone clones (repository root = the package), sosource.reponames in the findings differ frommapping.yaml.Validation
mint broken-links→success no broken links found(run after both commits)integration-docs:node scripts/build.mjs→Built 348 documentation keys for zh/en.;node scripts/check.mjs→Compatibility check passed: 348 keys for zh/en.jq empty docs.json→ OK (2 additive redirects, no existing redirect removed)🤖 Generated with the
doc-reviewskill (Daily Review - Document automation).