Skip to content

Commit 25a57eb

Browse files
docs: document escalation contacts and user management (#173)
* docs: document escalation contacts and user management * chore: auto-translate docs * docs: note severity is required for maintenance tickets * chore: auto-translate docs --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 3916dad commit 25a57eb

8 files changed

Lines changed: 2286 additions & 1 deletion

docs/contribute-ops-management.es.md

Lines changed: 316 additions & 0 deletions
Large diffs are not rendered by default.

docs/contribute-ops-management.fr.md

Lines changed: 316 additions & 0 deletions
Large diffs are not rendered by default.

docs/contribute-ops-management.it.md

Lines changed: 316 additions & 0 deletions
Large diffs are not rendered by default.

docs/contribute-ops-management.ja.md

Lines changed: 316 additions & 0 deletions
Large diffs are not rendered by default.

docs/contribute-ops-management.ko.md

Lines changed: 316 additions & 0 deletions
Large diffs are not rendered by default.

docs/contribute-ops-management.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,13 @@ doublezero contributor update \
4545

4646
Once authenticated, the **Incident Tracking Table** shows.
4747

48+
Account settings live behind the **Settings** menu (the gear icon, top right): API Key Management, User Management, and Escalation Contacts. The options you see depend on your role.
49+
4850
### 3. Create API Keys (Optional)
4951

5052
For programmatic access instead of the web form:
5153

52-
1. Click **Manage API Keys** on the portal.
54+
1. Open the **Settings** menu (gear icon) and choose **API Key Management**.
5355
2. Create one or more API keys.
5456
3. Download the API documentation from this page.
5557

@@ -188,10 +190,13 @@ Click **Create New Record** > **Maintenance** on the portal, or submit via the A
188190
|-------|-------------|
189191
| `title` | Short summary (max 100 characters) |
190192
| `description` | Detailed explanation (max 500 characters) |
193+
| `severity` | `sev1`, `sev2`, or `sev3`. Set it to the expected user impact (see note below). |
191194
| `start_at` | Planned start time (UTC) |
192195
| `end_at` | Planned end time (UTC); must be after `start_at` |
193196
| Device and/or Link | At least one required. On the web form, select from a dropdown of your device and link codes. When using the API, pass the corresponding pubkeys as `device_pubkey` and/or `affected_link_pubkey`. |
194197

198+
Severity applies to maintenance the same way it does to incidents. Set it to the user impact you expect during the window, using the [severity levels above](#severity-levels).
199+
195200
Once created, a notification is posted to the contributor maintenance Slack channel with the ticket ID, affected devices/links, planned window, and contributor name.
196201

197202
### Managing Maintenance Status
@@ -214,13 +219,81 @@ planned → in-progress → completed → closed (auto 24h after end_at)
214219

215220
---
216221

222+
## Escalation Contacts
223+
224+
Escalation contacts tell DoubleZero and other contributors who to reach when your part of the network has a problem. You set up your own contacts for your organization. A contact can be a person or a team, such as your NOC. Each contact has one or more ways to reach it and a schedule for when it is on call.
225+
226+
Open the **Settings** menu (gear icon) and choose **Escalation Contacts**. Only ops managers can add or edit contacts.
227+
228+
### Adding a Contact
229+
230+
For each contact, set:
231+
232+
| Field | Description |
233+
|-------|-------------|
234+
| Name | A name for the contact, whether a person or a team such as your NOC |
235+
| Timezone | The local timezone, used to read the schedule |
236+
| Availability | **24/7**, or one or more weekly time slots when the contact is on call |
237+
| Contact methods | One or more ways to reach the contact, in priority order |
238+
239+
Supported contact methods are email, phone, Slack, Telegram, and WhatsApp. Order matters: the first method is the one to try first.
240+
241+
### Availability and Coverage Gaps
242+
243+
A contact is either available around the clock (24/7) or available during weekly time slots you define, for example Monday to Friday, 09:00 to 17:00. Slots are entered in the contact's local timezone and shown in UTC, so daylight saving is handled for you.
244+
245+
The **coverage gaps** view shows the times each week when no one from your organization is on call. Use it to find and close gaps.
246+
247+
### Rotation Windows
248+
249+
The week is split into half-hour windows. For each window you can set the order in which your contacts are reached. This lets you run an on-call rotation without editing each contact.
250+
251+
### Visibility
252+
253+
You control who can see your contacts. DoubleZero can always see them. You choose who else can:
254+
255+
| Setting | Who else can see your contacts |
256+
|---------|-------------------------------|
257+
| DoubleZero only (default) | No other contributors |
258+
| Everybody | All contributors |
259+
| Some contributors | Only the contributors you select |
260+
261+
Your own team can always see your contacts. Visibility is set once for your whole organization and applies to all your contacts.
262+
263+
---
264+
265+
## User Management
266+
267+
By default, your Ops Manager key is the only account that can act for your organization. You can add team members so more than one person can manage your tickets.
268+
269+
Open the **Settings** menu (gear icon) and choose **User Management**. Only ops managers can add or remove team members.
270+
271+
For each team member, set:
272+
273+
| Field | Description |
274+
|-------|-------------|
275+
| Name | The person's name |
276+
| Wallet pubkey | The Solana wallet they sign in with |
277+
| Access level | **Read** or **Read-write** |
278+
279+
Access levels:
280+
281+
- **Read**: can view tickets and escalation contacts, and create read-only API keys. Cannot create, update, or close tickets.
282+
- **Read-write**: full access to create, update, and close tickets, and can create API keys of any level.
283+
284+
Each team member signs in with their own wallet, the same way you connected your Ops Manager key.
285+
286+
---
287+
217288
## Permissions and Escalation
218289

219290
### What Contributors Can Do
220291

221292
- Create and manage tickets for their own devices and links only.
222293
- Assign tickets to themselves or escalate to DZ/Malbeclabs.
223294
- View all tickets across all contributors.
295+
- Add team members and set their access level (ops managers only).
296+
- Manage escalation contacts for their organization (ops managers only).
224297

225298
### What DZ/Malbeclabs Admins Can Do
226299

0 commit comments

Comments
 (0)