Skip to content

Commit d039115

Browse files
committed
Initial commit: migrate code from pijiang3/docs
0 parents  commit d039115

347 files changed

Lines changed: 117549 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.DS_Store

6 KB
Binary file not shown.

.cursor/rules/rule.md

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

.cursor/rules/term.md

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
Flashduty是一个类似pagerduty的SaaS服务,目前正在做i18n多语言适配。你是一个语言专家,请将中文文档翻译为英文。
2+
3+
## 翻译要求
4+
1. 保持语言简洁专业,不要出现Chinglish
5+
2. 保持句子通顺,不要出现语法错误,保持翻译的一致性
6+
3. 请为完整的句子补上标点符号,遵循Sentence case大小写风格
7+
4. 如果中文原文包含变量或占位符,请确保其顺序在翻译后的文件中保持一致
8+
5. 请确保下方专业术语的翻译保持不变
9+
6. 翻译后的英文文档请按照中文文档目录(zh)结构进行组织
10+
11+
## 专业术语
12+
- "协作空间": "channel"
13+
- "故障": "incident"
14+
- "告警": "alert"
15+
- "分派": "assign"
16+
- "分派策略": "escalation rule"
17+
- "故障升级": "escalation"
18+
- "告警风暴": "alert storm"
19+
- "暂缓": "snooze"
20+
- "取消暂缓": "unsnooze"
21+
- "解决故障": "resolve the incident"
22+
- "关闭故障": "close the incident"
23+
- "抖动": "flapping"
24+
- "静默策略": "silence rule"
25+
- "抑制策略": "inhibit rule"
26+
- "排除规则": "drop rule"
27+
- "处理人员": "responders"
28+
- "响应人员": "responders"
29+
- "分派人员": "responders"
30+
- "值班人员": "responders"
31+
- "严重程度": "severity"
32+
- "等级": "severity"
33+
- "严重": "critical"
34+
- "一般": "warning"
35+
- "轻微": "info"
36+
- "值班表": "schedule"
37+
- "报警": "alert"
38+
- "手机号": "phone"
39+
- "邮箱": "email"
40+
- "降噪": "reduce noise"
41+
- "详情": "details"
42+
- "告警聚合": "alert grouping"
43+
- "触发": "trigger"
44+
- "发生": "trigger"
45+
- "输入不能为空": "the field is required"
46+
- "启用": "Enable"
47+
- "开启": "Enable"
48+
- "禁用": "Disable"
49+
- "删除": "Delete"
50+
- "聚合": "group"
51+
- "视频教学": "watch videos"
52+
- "发生时间": "triggered at"
53+
- "触发时间": "triggered at"
54+
- "结束时间": "ended at"
55+
- "IP段匹配": "CIDR matching"
56+
- "集成来源": "integration"
57+
- "回复": "reply"
58+
- "国内": "mainland China"
59+
- "环节": "level"
60+
- "值班": "schedule"
61+
- "值班轮换": "On-call shift"
62+
- "修改": "change"
63+
- "企业微信": "WeCom"
64+
- "微信": "WeCom"
65+
- "飞书": "Feishu/Lark"
66+
- "钉钉": "Dingtalk"
67+
- "北京快猫星云科技有限公司": "Beijing Flashcat Cloud Technology Co.,Ltd."
68+
- "小型团队": "small team"
69+
- "增长中的团队": "growing team"
70+
- "中大型企业": "Medium to Large Business"
71+
- "属性": "attribute"
72+
- "标签": "label"
73+
- "相同项": "equal item"
74+
- "订阅": "plan"
75+
- "分析看板": "insights"
76+
- "赠送金": "bonus"
77+
- "认领": "acknowledge"
78+
- "关联": "associated"
79+
- "数据源": "integration"
80+
- "告警列表": "Alerts"
81+
- "告警标题": "Title"
82+
- "中文对照": "alias"
83+
- "循环通知": "loop notification"
84+
- "解决办法": "resolution"
85+
- "快速静默": "quick silence"
86+
- "推送地址": "push URL"
87+
- "组合规则": "composition rule"
88+
- "值班轮换": "On-call rotation"
89+
- "跳转链接": "jump link"
90+
- "用户未关联": "user not linked"
91+
- "应用未关联": "app not linked"
92+
- "专业版": "Pro"
93+
- "标准版": "Standard"
94+
- "免费版": "Free"
95+
- "订阅升级": "plan upgrade"
96+
- "主体": "owner"
97+
- "成员": "member"
98+
- "主体账号": "owner"
99+
- "成员账号": "member"
100+
- "未关闭": "open"
101+
- "处理中": "processing"
102+
- "待处理": "triggered"
103+
- "已关闭": "closed"
104+
- "管理团队": "Team"
105+
- "登录": "sign in"
106+
- "登出": "sign out"
107+
- "注册": "sign up"
108+
- "常见问题": "FAQ"
109+
- "新奇故障": "outlier incident"
110+
- "故障数量": "incidents"
111+
- "中断次数": "interruption"
112+
- "通知次数": "notifications"
113+
- "时间段": "hours"
114+
- "工作时间": "work"
115+
- "睡眠时间": "sleep"
116+
- "休息时间": "rest"
117+
- "响应投入": "response effort"
118+
- "错误聚合": "error grouping"
119+
- "指纹": "fingerprint"

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 Mintlify
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# Flashduty Documentation
2+
3+
This repository contains the official documentation for [Flashduty](https://flashcat.cloud/), an incident management and on-call platform similar to PagerDuty. Built with [Mintlify](https://mintlify.com/).
4+
5+
## Documentation Structure
6+
7+
```
8+
docs/
9+
├── zh/ # Chinese documentation
10+
│ ├── home.mdx # Homepage
11+
│ ├── on-call/ # On-call product docs
12+
│ ├── rum/ # RUM product docs
13+
│ ├── monitors/ # Monitors product docs
14+
│ ├── platform/ # Platform configuration
15+
│ ├── openapi/ # API documentation
16+
│ └── ...
17+
├── en/ # English documentation
18+
│ └── (same structure as zh/)
19+
├── logo/ # Logo assets
20+
└── docs.json # Mintlify configuration
21+
```
22+
23+
## Products
24+
25+
- **On-call**: Incident management, alert routing, escalation rules, and on-call scheduling
26+
- **RUM**: Real User Monitoring for frontend performance and error tracking
27+
- **Monitors**: Alert rules configuration for various data sources
28+
29+
## Development
30+
31+
### Prerequisites
32+
33+
Install the [Mintlify CLI](https://www.npmjs.com/package/mint):
34+
35+
```bash
36+
npm i -g mint
37+
```
38+
39+
### Local Preview
40+
41+
Run the following command at the root of this repository:
42+
43+
```bash
44+
mint dev
45+
```
46+
47+
View your local preview at `http://localhost:3000`.
48+
49+
### Check for Errors
50+
51+
```bash
52+
mint broken-links
53+
```
54+
55+
## Contributing
56+
57+
1. All documentation supports both Chinese (`zh/`) and English (`en/`) languages
58+
2. Follow the existing file structure and naming conventions
59+
3. Use Mintlify components for consistent styling
60+
4. Test changes locally before submitting
61+
62+
## Resources
63+
64+
- [Flashduty Console](https://console.flashcat.cloud/)
65+
- [Flashduty Website](https://flashcat.cloud/)
66+
- [Mintlify Documentation](https://mintlify.com/docs)

0 commit comments

Comments
 (0)