Skip to content

docs(doc-review): 2026-10-22 diff audit — Prometheus Alertmanager rename, related raw-log results, symbol-file time filter, typo redirect - #1119

Merged
ysyneu merged 2 commits into
mainfrom
doc-review/20261022T081800Z
Oct 22, 2026
Merged

ysyneu merged 2 commits into
mainfrom
doc-review/20261022T081800Z

Conversation

@flashduty

@flashduty flashduty Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

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 (and fc-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 verified base == head and cross-checked through the GitHub commits API).

Changes

Finding Type Module Doc Action
f001 feature_drift on-call/integration `zh en/on-call/integration/alert-integration/alert-sources/prometheus.mdx`
f002 feature_drift on-call/integration `zh en/.../alert-sources/{cubeapm,chronosphere,red-hat-openshift,signoz,robusta}.mdx`
f003 feature_drift on-call `zh en/on-call/incident/search-view-incident.mdx`
f005 missing_coverage rum `zh en/rum/error-tracking/source-mapping.mdx`
f006 stale_content rum docs.json two additive redirects for the product's typo path /rum/error-tracking/erro-reporting/web → error-reporting/web (zh + en), so shipped console builds stop 404ing
f011 stale_content monitors `zh en/monitors/alert-rules/sls.mdx`
f012 config_drift monitors `zh en/monitors/quickstart/quickstart.mdx`
f013 missing_coverage monitors `zh en/monitors/quickstart/quickstart.mdx, zh
f014 missing_coverage monitors `zh en/monitors/alert-rules/investigation-entries.mdx`

Held (documented next round, not in this PR)

Finding Why it is not written yet Evidence
f007 / f008 / f009 (high/low/low, ai-sre) The IM natural-language chat-settings capability (fc-event chat_settings + fc-safari im-settings skill, its card tip, and the skill-list entry) ships behind deploy flag aiSreNlSettings, which is default false; etc/deploy.yml turns 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. fc-event config/config.go:117-123, etc/deploy.yml:12-14
f010 (high, on-call) Duty-notification robot @ mentions (mapping-table based) are live in fc-oncall and in an internal API, but the console control does not exist yet: 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. fc-oncall cron/robot_mentions.go, models/notify.go, docs/oncall-robot-mentions.md; fc-saas-web at origin/main

Skipped

  • f004 (low, 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.
  • Pre-existing /scope contradiction noticed while reading zh/ai-sre/im.mdx:208 (outside this window, not edited): the page says any account member can bind a session to any team, but fc-event logic/ai_sre/scope_resolution.go:544 resolves targets through GetPersonTeams, i.e. only teams the caller belongs to; the same subsection also says /scope personal works in group chats, while scope_resolution.go:63-65 refuses it there. Flagged for a human rather than fixed inside a diff-mode PR.
  • Internal Mongo→Postgres storage refactor in fc-event (model/pgpart, model/shadowread, query-shape changes), fc-rum issue counters / view deactivation, monit-edge HTTP/2 ping health check, fc-datasource last_source_time (no console consumer), the fc-foundation-app docsBaseUrl private-deployment knob (deployment config, not a console capability), and the whole antd→meow-ui migration in fc-saas-monit and fc-foundation-app: no user-visible capability or documented value changed.

Review checklist

  • Verify config field names and defaults match current code
  • Check that feature descriptions accurately reflect user-facing behavior
  • Ensure tone and style match the rest of the docs
  • Reader-fit deletions removed only mechanism, never a limit, default, or behavior the reader relies on
  • Confirm the Prometheus → Prometheus Alertmanager rename is live in the target environment (it is in deploy/data_source_plugin_init.sql and in migration 2026-10-21_t_data_source_plugin_prometheus_alertmanager_name.sql; the console reads the name from t_data_source_plugin.type_name)

Cross-repo follow-ups (flashduty-website)

  • lib/integrations/catalog.ts:754-763 — the integrations catalog still lists id: "prometheus", name: { zh: "Prometheus", en: "Prometheus" } with the blurb "接入 Alertmanager,把 Prometheus 告警送入 On-call 工作流", and docsPath: 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.
  • No website changelog entry is proposed this round: the two substantive features in the window (IM natural-language chat settings, schedule robot @ mentions) are held above, so their entries belong with their rollout.

Mapping warnings

  • derivative_surfaces.comparison_page still points at zh|en/on-call/quickstart/comparison.mdx, which does not exist; the real comparison pages are zh|en/on-call/comparison/vs-pagerduty.mdx and vs-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/) and terraform (developer/terraform/) docs_path entries are directories that do not exist; the pages are zh|en/developer/mcp-server.mdx and zh|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-web are mapped as fc-foundation-app submodule paths; this run scanned them as standalone clones (repository root = the package), so source.repo names in the findings differ from mapping.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-review skill (Daily Review - Document automation).

Flashduty AI-SRE 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)
@ysyneu
ysyneu merged commit d8b9be1 into main Oct 22, 2026
1 of 2 checks passed
@ysyneu
ysyneu deleted the doc-review/20261022T081800Z branch October 22, 2026 08:30
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