Skip to content

Commit b135a53

Browse files
authored
Merge pull request #26 from flashcatcloud/doc-review/2026-03-23-120000
docs: doc-review findings for week of 2026-03-23
2 parents cb6cc16 + 31246a8 commit b135a53

18 files changed

Lines changed: 91 additions & 43 deletions

en/on-call/channel/create-edit.mdx

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -40,23 +40,30 @@ Proper planning can significantly improve operational efficiency.
4040
<Step title="Fill in Basic Information">
4141
Enter **Channel Name**, preferably named after business type or team
4242
</Step>
43-
<Step title="Select Management Team">
44-
Select **Management Team**, members of this team have full operational permissions for the channel
43+
<Step title="Select Owning Team">
44+
Select **Owning Team**, members of this team have full operational permissions for the channel
45+
</Step>
46+
<Step title="Set Managing Team (Optional)">
47+
If you need to delegate channel management permissions to other teams, set **Managing Teams** (up to 3). When set, managing teams take over management permissions (edit, delete, etc.) from the owning team, but both teams retain read access. This feature must be enabled by contacting the Flashduty team; it is not enabled by default.
4548
</Step>
4649
<Step title="Set Access Level">
4750
- **Public**: Visible to all users in the account, can view and operate incidents but cannot modify channel configuration
48-
- **Private**: Only visible to management team, creator, and account administrators
51+
- **Private**: Only visible to the owning team (or managing team), creator, and account administrators
4952
</Step>
50-
<Step title="Configure Auto-close Timeout (Optional)">
51-
- **Auto-close after incident trigger**: Timer starts from when the incident is first triggered, suitable for alerts without automatic recovery
52-
- **Auto-close after alerts stop merging**: Timer starts from the last alert merge, suitable for scenarios with alert grouping enabled
53+
<Step title="Configure Auto-resolve Timeout (Optional)">
54+
Enable the auto-resolve timeout toggle, then configure the following parameters:
55+
- **Window timing start**: Select **Incident trigger** (timer starts from when the incident is first triggered, suitable for alerts without automatic recovery) or **Alerts stop merging** (timer starts from the last alert merge, suitable for scenarios with alert grouping enabled)
56+
- **Timeout duration**: Set the timeout duration in minutes, hours, or days, up to a maximum of 30 days
5357
</Step>
5458
<Step title="Configure Close with Alerts (Optional)">
5559
Enabled by default. When enabled, incidents automatically close when all associated alerts recover. When disabled, alert recovery does not auto-close the incident — you need to close it manually or rely on the auto-close timeout policy.
5660
</Step>
5761
<Step title="Enable Outlier Incident Detection (Optional)">
5862
When enabled, incident lists and notification content will include an "Outlier Incident" indicator for quick identification. [Learn more](/en/on-call/incident/outlier-incidents)
5963
</Step>
64+
<Step title="Enable External Reporting (Optional)">
65+
When enabled, external personnel can submit incident tickets via a shareable external reporting link without logging in. The system generates a shareable link that you can distribute to external personnel. Disabling external reporting immediately invalidates all previously shared links; re-enabling generates a new link.
66+
</Step>
6067
<Step title="Complete Creation">
6168
Click **Next** to complete creation
6269
</Step>
@@ -126,12 +133,19 @@ Links support two open modes: **Open in New Tab** and **Open in Embedded iframe*
126133

127134
### Changing Configuration
128135

129-
Go to Channel Details **Basic Settings** to modify:
136+
Go to Channel Details and modify configuration across two settings tabs:
130137

138+
**Basic Settings**:
131139
- Channel name, description
132-
- Management team
133-
- Auto-close timeout policy
140+
- Owning team
141+
- Managing team (must be enabled by contacting the Flashduty team; up to 3 managing teams; when set, managing teams take over management permissions from the owning team)
142+
- Access level (public or private)
143+
144+
**Advanced Settings**:
134145
- Close with alerts toggle
146+
- Auto-resolve timeout (toggle, window timing start, timeout duration)
147+
- Outlier incident detection
148+
- External reporting (when enabled, generates a shareable link for external personnel to submit incident tickets without logging in)
135149

136150
### Disabling and Deleting
137151

@@ -153,14 +167,17 @@ See [Search and View Incidents](/en/on-call/incident/search-view-incident) for d
153167
## FAQ
154168

155169
<AccordionGroup>
156-
<Accordion title="What's the difference between management team and access level?" icon="circle-question">
157-
- **Management Team**: Controls who can modify channel configuration (integrations, escalation rules, noise reduction rules, etc.)
158-
- **Access Level**: Controls who can see the channel and its incidents. Public channels are visible to everyone but only the management team can modify configuration; private channels are only visible to the management team
170+
<Accordion title="What's the difference between owning team, managing team, and access level?" icon="circle-question">
171+
- **Owning Team**: The team that owns the channel and has full management permissions (edit, delete, etc.) by default
172+
- **Managing Team**: When set, managing teams take over management permissions (edit, delete, etc.) from the owning team, but both teams retain read access. This feature must be enabled by contacting the Flashduty team
173+
- **Access Level**: Controls who can see the channel and its incidents. Public channels are visible to everyone but only the owning team (or managing team) can modify configuration; private channels are only visible to the owning team (or managing team)
159174
</Accordion>
160175

161-
<Accordion title="How to choose between the two auto-close timeout policies?" icon="circle-question">
162-
- If the alert source doesn't have automatic recovery events and alert grouping is not enabled, choose **Auto-close after incident trigger**
163-
- If alert grouping is enabled, choose **Auto-close after alerts stop merging** to ensure all alerts within the grouping window are processed
176+
<Accordion title="How to configure auto-resolve timeout?" icon="circle-question">
177+
Enable the auto-resolve timeout toggle in Advanced Settings, then select a window timing start and timeout duration:
178+
- **Window timing start** set to **Incident trigger**: Timer starts from when the incident is first triggered, suitable for alert sources without automatic recovery events and when alert grouping is not enabled
179+
- **Window timing start** set to **Alerts stop merging**: Timer starts from the last alert merge, suitable for scenarios with alert grouping enabled, ensuring all alerts within the grouping window are processed
180+
- **Timeout duration** supports minutes, hours, or days as units, up to a maximum of 30 days
164181
</Accordion>
165182

166183
<Accordion title="Is incident data still available after deleting a channel?" icon="circle-question">

en/on-call/channel/escalation-rule.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ In each escalation level, you can enable the **Loop Notification** feature. When
8787
- **Timeout without acknowledgment**: No one acknowledges within N minutes after incident trigger
8888
- **Timeout without closure**: Incident not resolved within N minutes after trigger
8989

90+
The minimum escalation timeout is 1 minute.
91+
9092
**Typical Scenarios**:
9193

9294
| Scenario | Escalation Path |

en/on-call/channel/noise-reduction.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,9 @@ Flashduty On-call provides two grouping modes:
9999

100100
| Configuration | Description |
101101
| :------- | :----------------------------------- |
102-
| **Grouping Window** | Only group alerts within the time window, alerts outside the window trigger new incidents |
103-
| **Window Type** | **Tumbling** (default): Fixed timer starts from incident creation, stops grouping when the window duration is reached. **Sliding**: Timer resets each time a new alert merges in, the window recalculates from the last merge |
102+
| **Aggregation Window** | Optional toggle. When disabled, new alerts continue merging into the incident until the incident is closed. When enabled, alerts within the window are merged; alerts arriving after the window expires are grouped into a new incident |
103+
| **Window Timing Start** | Only configurable when the aggregation window is enabled. **Incident trigger** (default): Fixed timer starts from incident creation, stops grouping when the window duration is reached. **Alert merges into incident**: Timer resets each time a new alert merges in, the window recalculates from the last merge |
104+
| **Window Duration** | Only configurable when the aggregation window is enabled. Set the duration of the aggregation window |
104105
| **Alert Storm Warning** | When merged alert count reaches the configured threshold, the system records an alert storm event in the incident timeline and triggers a warning notification, prompting urgent handling |
105106
| **Strict Grouping** | When enabled, empty label values are treated as different; when disabled, empty values are treated as the same (not supported for intelligent grouping) |
106107

@@ -329,6 +330,7 @@ When a new alert meets conditions, and there's an **active incident** (not close
329330
<Accordion title="What's the maximum number of events a single alert can be associated with?" icon="circle-question">
330331
- **Rule-based Grouping**: No limit, default maximum grouping window is 24 hours. After 24 hours from alert trigger, new events create new incidents
331332
- **Intelligent Grouping**: No limit, default maximum grouping window is 24 hours, with certain subscription plans supporting extension up to 30 days. After exceeding the window, new events create new incidents
333+
- If the aggregation window is disabled, alerts continue merging into the existing incident until the incident is closed, with no time limit
332334
</Accordion>
333335
</AccordionGroup>
334336

en/on-call/incident/alert-management.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@ The alert list displays the following information:
1515
| :--- | :--- |
1616
| **Severity** | Displays alert severity as a color bar (Critical, Warning, Info) |
1717
| **Title** | Alert title description |
18-
| **Processing Status** | Whether the alert is closed (Closed / Not Closed) |
19-
| **Recovery Status** | Whether a closed alert has auto-recovered (Recovered / Not Recovered) |
20-
| **Duration** | Time elapsed from alert trigger to current time or closure |
18+
| **Processing Status** | Current recovery status of the alert (Recovered / Active). The list header supports quick filtering by "Active Alerts" and "Recovered Alerts" tabs |
19+
| **Incident Progress** | Current processing progress of the incident associated with this alert |
2120
| **Associated Events** | Number of raw events associated with the alert |
2221
| **Associated Incident** | The incident this alert belongs to; click to navigate to incident details |
2322
| **Trigger Time** | When the alert was first triggered |

en/on-call/incident/search-view-incident.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Incident details is the main entry point for investigating incidents, displaying
8989
| 5 | Comprehensive Info | Shows incident attributes, processing status, [images](https://developer.flashcat.cloud/api-344943718), and responder info |
9090
| 6 | Custom Fields | Custom field configuration area |
9191

92-
You can switch tabs above to view more detailed **Associated Alerts**, **Timeline**, and **Change History** for root cause analysis. For closed incidents, the system also shows a **Resolution** page displaying root cause and resolution.
92+
You can switch tabs above to view more detailed **Associated Alerts**, **Timeline**, **Change History**, and **Post-Mortem**. Post-mortem supports creating and editing post-mortem reports directly from the incident details. See [Post-Mortem](/en/on-call/post-mortem/create-edit-post-mortem) for details. For incidents with existing resolution records, the system still displays the **Resolution** tab.
9393

9494
### Change History
9595

en/on-call/incident/what-is-incident.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ Incidents can be triggered in the following ways:
6969

7070
- **Auto-trigger**: Flashduty On-call receives an alert event from an integration (like Zabbix notification), event auto-triggers an alert, alert auto-triggers an incident
7171
- **Manual trigger**: Click **Create Incident** button in Flashduty On-call console, fill in title, description, severity, etc. to trigger a new incident
72+
- **External reporting**: After enabling external reporting, external personnel can submit incident tickets through a dedicated link without logging into a Flashduty account. See [Channel Configuration](/en/on-call/channel/create-edit) for details
7273
</Step>
7374

7475
<Step title="Assignment and Notification">

en/on-call/integration/alert-integration/routing-rules.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ When using name mapping mode, if corresponding channel doesn't exist, delivers t
5050
| Insert Rule | Quickly insert new rules before or after a specified rule without manually dragging to adjust position |
5151
| Filter Rules | Filter by channel to quickly locate all rules delivering to a specific channel, ideal for scenarios with many rules |
5252
| Edit History | View historical configuration versions, compare differences, and quickly restore (see details below) |
53+
| Route Preview | After editing routing rules, click the preview button and select up to 20 real alerts to see how the modified rules would route each alert. The system displays routing differences between old and new rules, including added, removed, and unchanged channels |
5354

5455
### Edit History
5556

en/platform/configure-sso.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ LDAP single sign-on is only supported in the **private deployment version**.
7575
| LDAP URL | LDAP service address, e.g., `ldap://10.10.10.10:389` |
7676
| BIND DN | Username for connecting to LDAP, e.g., `cn=admin,dc=flashduty,dc=com` |
7777
| BIND DN Password | Password for connecting to LDAP, stored encrypted in the database |
78-
| Encryption | Supports **TLS** and **StartTLS** encryption methods (mutually exclusive, only one can be enabled). After enabling either method, you can optionally **skip SSL/TLS certificate verification**; if not skipped, you need to provide the SSL/TLS certificate path |
78+
| Encryption | Supports **TLS** and **StartTLS** encryption methods (mutually exclusive, only one can be enabled). After enabling either method, you can optionally **skip SSL/TLS certificate verification**; if not skipped, you can optionally provide the SSL/TLS certificate path |
7979
| User DN | Defines where to start searching for users, e.g., `ou=people,dc=flashduty,dc=com` |
8080
| Auth Filter | Custom filter expression for retrieving user DN information, basic form: `(&(mail=%s))`. Note: Opening and closing parentheses are required |
8181
| Field Mapping | Flashduty extracts user email, username, phone, and Group information from the identity provider through mapped fields. Email is a required mapping field. The Group field defaults to `memberOf` and is used for role and team synchronization |

en/platform/team-members.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ A team is a collection of members. You can group members with different responsi
4949

5050
---
5151

52+
In the member list, a warning icon appears next to unverified email addresses or phone numbers. Unverified contact methods cannot receive alert notifications. Please remind members to complete verification promptly.
53+
5254
### Invitation Methods
5355

5456
<Tabs>

0 commit comments

Comments
 (0)