Skip to content

Commit 0f55817

Browse files
authored
Update Project Pages, Logo, and some i18n (#140)
* update footer and some label * update footer * update favicon * update device collector config settings * update coScene spelling
1 parent 075b90a commit 0f55817

Some content is hidden

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

51 files changed

+189
-325
lines changed

docs/1-coscene-intro.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ coScene 的语义搜索引擎提供了一个开放的搜索和发现框架,用
3131

3232
## 系统概念
3333

34-
登陆 coScene 之后,您立即就可以使用平台的全部正式功能,下面是一些主要概念的简介。
34+
登录 coScene 之后,您立即就可以使用平台的全部正式功能,下面是一些主要概念的简介。
3535

3636
### 组织(Organization)
3737

docs/4-recipes/13-image/3-push-image.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,23 @@ sidebar_position: 3
1010

1111
已经存在编译好的镜像或者按照[打包镜像](./2-build-image.md)的过程,打包好了测试镜像。
1212

13-
## 推送镜像至 Docker Hub
13+
## 推送镜像至 Docker Hub
1414

1515
可以查看对应的文档[推送镜像至 Docker Hub](https://docs.docker.com/docker-hub/repos/#pushing-a-docker-container-image-to-docker-hub)
1616

17-
1817
## 推送镜像至刻行镜像仓库
1918

20-
### 1. 认证和登陆刻行的镜像仓库
19+
### 1. 认证和登录刻行的镜像仓库
2120

22-
登陆刻行平台,在右上角用户设置下拉面板中,访问【个人设置】,在【个人设置】页面中,访问[【安全】](https://coscene.cn/profile?section=security)页面。
21+
登录刻行平台,在右上角用户设置下拉面板中,访问【个人设置】,在【个人设置】页面中,访问[【安全】](https://coscene.cn/profile?section=security)页面。
2322

24-
点击生成访问命令,获取登陆刻行镜像仓库的命令和密码
23+
点击生成访问命令,获取登录刻行镜像仓库的命令和密码
2524

2625
![generate-cr-token](../img/generate-cr-token.png)
2726

2827
![login-cr](../img/login-cr.png)
2928

30-
在命令行中输入包含用户名的登陆,使用之前获得的认证凭证进行认证
29+
在命令行中输入包含用户名的登录,使用之前获得的认证凭证进行认证
3130

3231
![docker-login](../img/docker-login.png)
3332

docs/4-recipes/2-project.md

+27-83
Original file line numberDiff line numberDiff line change
@@ -4,110 +4,54 @@ sidebar_position: 2
44

55
# 项目
66

7-
## 1. 创建项目
7+
## 1. 创建新项目
88

9-
### 1.1 创建项目的权限
9+
在主页上点击"创建项目"按钮,然后按照指引步骤完成项目创建。
1010

11-
- 组织中的「管理员」和「成员」在组织中有权限创建新的项目;组织「只读成员」只能加入已存在的项目
11+
![create-project](./img/4-2-create-project.png)
1212

13-
### 1.2 如何创建一个新项目
13+
## 2. 项目可见性设置
1414

15-
- 点击首页左上角的【创建项目】按钮,即可开始创建
15+
刻行提供两种项目可见性选项,项目管理员可以根据需求进行设置:
1616

17-
---
18-
19-
## 2.项目的可见性
20-
21-
在 coScene 中,您可以选择谁能访问您的项目。
22-
23-
> 谁可以使用这个功能<br />
24-
> 仅组织管理员和项目管理员可设置项目可见性
25-
26-
### 2.1 关于项目可见性
27-
28-
我们建议您在更改项目可见性之前查看以下注意事项。
29-
30-
**将项目设为私有**
31-
32-
- 仅组织管理员和项目内部用户可访问。
33-
34-
- 项目内部用户的权限受项目角色控制。
17+
### 2.1 可见性类型
3518

36-
**将项目设为内部**
19+
1. **私有项目**
3720

38-
- 组织内任意用户都能够访问,且在内部项目中具有项目成员权限。
21+
- 访问限制:仅组织管理员和项目成员可访问
22+
- 权限控制:项目成员权限由项目角色决定
3923

40-
- 项目内部用户的权限受项目角色控制。
24+
2. **内部项目**
25+
- 访问范围:组织内所有用户均可访问
26+
- 权限控制:访问用户具有项目成员权限,具体权限由项目角色决定
4127

4228
### 2.2 修改项目可见性
4329

44-
- 在项目中,点击【管理项目】
30+
项目管理员可在项目设置中切换项目可见性
4531

46-
<img src="https://user-images.githubusercontent.com/105594127/197425216-52b61e16-1ec3-46cf-acdf-9d56fa8991c7.png" width="180" />
32+
![设置项目可见性](./img/4-2-setting-project-visibility.png)
4733

48-
- 在【设置】中,点击【切换可见性】。
34+
## 3. 项目归档与恢复
4935

50-
![image](https://user-images.githubusercontent.com/105594127/197425268-2a25f79c-5244-47b8-a7c9-ff8ebf1595f4.png)
36+
刻行支持项目归档功能,用于管理历史数据或低活跃度项目。
5137

52-
- 选择可见性,验证更改的项目可见性是否正确。
53-
54-
<img src="https://user-images.githubusercontent.com/105594127/197425364-72635f56-cf1c-42ce-86a6-0560256c5eda.png" width="400" />
55-
56-
- 键入要更改其可见性的项目名称后,点击【切换项目可见性】。
57-
58-
<img src="https://user-images.githubusercontent.com/105594127/197425587-f87f1ca9-fac8-424f-bb06-d7d5fff35e59.png" width="400" />
59-
60-
---
61-
62-
## 3.项目成员的权限
63-
64-
---
38+
归档效果:
6539

66-
## 4. 归档与取消归档项目
67-
68-
在 coScene 中,您可以归档项目来存放低活跃度的数据,以供他人查看和参考。
69-
70-
> 谁可以使用这个功能<br />
71-
> 仅组织管理员和项目管理员可归档项目
40+
- 归档后:项目变为只读状态,数据停止更新
41+
- 恢复后:项目恢复可读可写状态,正常运作
7242

7343
### 3.1 归档项目
7444

75-
> 项目归档后,变为只读状态,项目内所有数据不再更新。
76-
77-
- 在项目中,点击【管理项目】。
78-
79-
![image](https://user-images.githubusercontent.com/105594127/197172077-a2645985-6c0b-49e8-b924-178c564e4bca.png)
80-
81-
- 在【设置】下,点击【归档项目】。
82-
83-
![image](https://user-images.githubusercontent.com/105594127/197173493-2949ad4c-7dd9-45e3-859c-d2dc8b833bb2.png)
84-
85-
### 3.2 取消归档项目
86-
87-
> 项目取消归档后,恢复可读可写状态。
88-
89-
- 在项目中,点击【管理项目】。
90-
91-
![image](https://user-images.githubusercontent.com/105594127/197172077-a2645985-6c0b-49e8-b924-178c564e4bca.png)
92-
93-
- 在【设置】下,点击【取消归档项目】。
94-
95-
![image](https://user-images.githubusercontent.com/105594127/197175752-5aa5fd03-f6fc-43bc-b358-0fbbc85cb9fb.png)
96-
97-
### 3.3 更多方法
98-
99-
- 在主页「我的项目」下方,点击【查看所有项目】,进入组织管理页面中默认的「项目列表」页面。
100-
101-
![image](https://user-images.githubusercontent.com/105594127/197178989-66ccee21-3a30-49ea-a66a-5c478c9689cd.png)
102-
103-
**归档项目**
45+
项目管理员可在项目设置中执行归档操作。
10446

105-
- 在【活跃】的项目下,鼠标悬停在目标项目,点击【归档】按钮。
47+
![archive-project](./img/4-2-archive-project.png)
10648

107-
![image](https://user-images.githubusercontent.com/105594127/197180846-3232f01f-1e3f-4e32-a642-6ba61827e6bd.png)
49+
### 3.2 恢复已归档项目
10850

109-
**取消归档项目**
51+
组织管理员可通过以下步骤恢复已归档项目:
11052

111-
- 在【项目】下,点击【已归档】,切换到已归档的项目列表。鼠标悬停在目标项目,点击【取消归档】按钮。
53+
1. 在组织项目列表中切换至已归档项目视图
54+
2. 选择需要恢复的项目
55+
3. 点击"取消归档"以恢复项目
11256

113-
![image](https://user-images.githubusercontent.com/105594127/197178306-3f9d187d-4f9f-4942-929a-119ddc44e69a.png)
57+
![unarchive-project](./img/4-2-unarchive-project.png)

docs/4-recipes/3-device/4-device-collector.md

+10-41
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,14 @@ sidebar_position: 4
2424

2525
![org-dev-rule-save](./img/device-save-collector.png)
2626

27-
<br />
28-
2927
## 数采规则格式
3028

3129
数采规则主要对三个模块进行设置:
3230

3331
- **数据收集器设置(collector)**:完成数据采集后,是否删除设备端数据
3432
- **存储设置(mod)**:设备端数据的存储目录;设备标识文件的地址
35-
- **事件设置(event_code)**:事件错误码的上传规则地址以及是否上传条件限制
3633
- **更新设置(updater)**:当前程序是否开启自动更新
3734

38-
<br />
39-
4035
示例数采设备信息文件如下:
4136

4237
```yaml
@@ -50,21 +45,15 @@ mod:
5045
conf:
5146
enabled: true # 是否启用,默认为 true
5247
robot_file: '/root/.ros/sn.txt' # 设备标识文件,用于存放设备唯一标识码,如 sn
53-
base_dir: '/root/.ros/auto-upload/' # 数据监听目录
54-
55-
event_code: # 错误码功能
56-
enabled: false # 错误码白名单配置,默认 False
57-
whitelist:
58-
'1001': 8 # key 为错误码,字符串类型;value 为次数,表示在 reset_interval_in_sec 周期内只上传规定次数,多余数据会忽略上传
59-
reset_interval_in_sec: 86400 # 计算周期,默认为一天
60-
code_json_url: cos://organizations/current/configMaps/device.errorCode # 默认采用云端配置模式,支持其他公开文件
48+
base_dirs:
49+
# 设备端的监听目录,作为项目中数据采集任务与规则采集的指定目录
50+
- /home/bag/
51+
- /home/log/
6152

6253
updater:
63-
enabled: true # 自动升级配置,默认值:True
54+
enabled: false # 是否自动更新数采程序,默认值为 false
6455
```
6556
66-
<br />
67-
6857
### 数据收集器设置
6958
7059
设置完成数据采集后,是否删除设备端数据,以释放设备端硬盘存储
@@ -77,8 +66,6 @@ collector:
7766
scan_interval_in_secs: 60 # 默认值:60,即 60s 对文件夹扫描一次
7867
```
7968
80-
<br />
81-
8269
### 存储设置
8370
8471
设置设备端数据的存储地址
@@ -90,37 +77,19 @@ mod:
9077
conf:
9178
enabled: true # 是否启用,默认为 true
9279
robot_file: '/root/.ros/sn.txt' # 设备标识文件,用于存放设备唯一标识码,如 sn
93-
base_dir: '/root/.ros/auto-upload/' # 数据监听目录
94-
```
9580

96-
<br />
97-
98-
### 事件代码设置
99-
100-
设置触发数据采集的事件错误码和条件
101-
102-
```yaml
103-
# 事件代码设置
104-
event_code: # 错误码功能
105-
enabled: false # 错误码功能是否启用,默认 False
106-
whitelist:
107-
'1001': 8 # key 为错误码,字符串类型;value 为次数,表示在 reset_interval_in_sec 周期内只上传规定次数,多余数据会忽略上传
108-
reset_interval_in_sec: 86400 # 计算周期,单位为秒,默认值为 86400s
109-
code_json_url: cos://organizations/current/configMaps/device.errorCode # 默认采用云端配置
81+
# 设备端的监听目录,作为项目中数据采集任务与规则采集的指定目录
82+
base_dirs:
83+
- /home/bag/
84+
- /home/log/
11085
```
11186
112-
- **whitelist**:在白名单中的事件错误码发生时,会触发数据的自动上传。可设置该错误码发生后,最多上传的次数,防止同一问题多次重复上报
113-
- **reset_interval_in_sec**:重置关于错误码「最多上传的次数」的设置。例如 86400 表示 24 小时后,当同一错误码再次发生时,「上传次数」重新从 1 开始计数
114-
- **code_json_url**:事件代码的 JSON 数据源地址
115-
116-
<br />
117-
11887
### 更新设置
11988
12089
设置是否自动更新数采程序
12190
12291
```yaml
12392
# 更新设置
12493
updater:
125-
enabled: true # 是否自动更新数采程序,默认值为 true
94+
enabled: false # 是否自动更新数采程序,默认值为 false
12695
```

docs/4-recipes/8-regression/2-image-management.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ sidebar_position: 2
1010

1111
本机已经安装并启动 Docker
1212

13-
## 1. 认证和登陆刻行的镜像仓库
13+
## 1. 认证和登录刻行的镜像仓库
1414

15-
登陆刻行时空平台,在右上角用户设置下拉面板中,访问【个人设置】,在【个人设置】页面中,访问[【安全】](https://coscene.cn/profile?section=security)页面。
15+
登录刻行时空平台,在右上角用户设置下拉面板中,访问【个人设置】,在【个人设置】页面中,访问[【安全】](https://coscene.cn/profile?section=security)页面。
1616

17-
点击生成访问命令,获取登陆平台镜像仓库的命令和密码
17+
点击生成访问命令,获取登录平台镜像仓库的命令和密码
1818

1919
![generate-cr-token](../img/generate-cr-token.png)
2020

2121
![login-cr](../img/login-cr.png)
2222

23-
在命令行中输入包含用户名的登陆,使用之前获得的认证凭证进行认证
23+
在命令行中输入包含用户名的登录,使用之前获得的认证凭证进行认证
2424

2525
![docker-login](../img/docker-login.png)
2626

docs/4-recipes/9-data-diagnosis/2-get-started.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -85,10 +85,10 @@ sidebar_position: 2
8585
name: 'default' # mod 名称,默认 default,定制版请联系刻行产品了解详细信息
8686
conf:
8787
enabled: true # 是否启用,默认为 true
88-
base_dir: '/root/logs/' # 数据监听目录
89-
90-
event_code: # 错误码功能
91-
enabled: false # 错误码白名单配置,默认 False
88+
# 设备端的监听目录,作为项目中数据采集任务与规则采集的指定目录
89+
base_dirs:
90+
- /home/bag/
91+
- /home/log/
9292
```
9393
9494
\*更多配置参见[数采规则格式](https://docs.coscene.cn/docs/receipts/device/device-authorize#%E6%95%B0%E9%87%87%E8%A7%84%E5%88%99%E6%A0%BC%E5%BC%8F)
372 KB
Loading
977 KB
Loading
Loading
191 KB
Loading

docs/5-use-case/1-common-task.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,21 @@ sidebar_position: 1
1414

1515
```yaml
1616
mod:
17-
name: 'default'
1817
# mod 名称,默认 default,支持监听设备端指定目录下的文件,定制版请联系刻行
18+
name: 'default'
1919
conf:
20-
enabled: true
2120
# 启用开关,true/false,默认启用
21+
enabled: true
22+
23+
# 设备端的监听目录,作为项目中数据采集任务与规则采集的指定目录
2224
base_dirs:
23-
# 设备端的监听目录,作为项目中数据采集任务与规则采集的指定目录
2425
- /home/bag/
2526
- /home/log/
2627

28+
# 自动更新
2729
updater:
28-
# 自动更新
29-
enabled: false
3030
# 数采客户端自动更新开关,true/false,默认关闭
31+
enabled: false
3132
```
3233
3334
具体的配置文件信息介绍,请查看文档[数采规则](../4-recipes/3-device/4-device-collector.md)

docs/5-use-case/2-automated-data-collection.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,10 @@ mod:
9090
name: 'default' # mod 名称,默认 default,定制版请联系刻行产品了解详细信息
9191
conf:
9292
enabled: true # 是否启用,默认为 true
93-
base_dir: '/root/logs/' # 数据监听目录
94-
95-
event_code: # 错误码功能
96-
enabled: false # 错误码白名单配置,默认 False
93+
# 设备端的监听目录,作为项目中数据采集任务与规则采集的指定目录
94+
base_dirs:
95+
- /home/bag/
96+
- /home/log/
9797
```
9898
9999
## 准入设备&添加设备

docs/6-cli/1-cli-install.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ cocli -h
2727
cocli update
2828
```
2929

30-
## 登陆
30+
## 登录
3131

3232
:::tip
3333

34-
登陆和初始化刻行 CLI 需要如下信息
34+
登录和初始化刻行 CLI 需要如下信息
3535

3636
- 个人访问令牌(Token):
3737
- 默认工作项目的(Slug):

docs/6-cli/99-advanced-features.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ sidebar_position: 99
77

88
## 切换登录凭证
99

10-
刻行的命令行工具内置了登录凭证管理系统,高级用户和测试人员可以在不同的组织、项目、和环境中切换登陆凭证,方便测试和管理。
10+
刻行的命令行工具内置了登录凭证管理系统,高级用户和测试人员可以在不同的组织、项目、和环境中切换登录凭证,方便测试和管理。
1111

12-
在您有了默认的登陆凭证之后,想要再添加一个登陆凭证时,您可以使用如下命令来添加一个新的登陆凭证
12+
在您有了默认的登录凭证之后,想要再添加一个登录凭证时,您可以使用如下命令来添加一个新的登录凭证
1313

1414
```bash
1515
cocli login add -n <凭证名字> -p <项目Slug> -t <访问令牌>
@@ -21,15 +21,15 @@ cocli login add -n <凭证名字> -p <项目Slug> -t <访问令牌>
2121
cocli login list
2222
```
2323

24-
在不同的登陆凭证中间切换也非常容易
24+
在不同的登录凭证中间切换也非常容易
2525

2626
```bash
2727
cocli login switch
2828
```
2929

30-
在运行命令后的交互提示中,用箭头来选择想要切换到的登陆凭证,回车确认选择
30+
在运行命令后的交互提示中,用箭头来选择想要切换到的登录凭证,回车确认选择
3131

32-
切换完成之后会提示当前激活的登陆凭证,也可以用如下命令来确认
32+
切换完成之后会提示当前激活的登录凭证,也可以用如下命令来确认
3333

3434
```
3535
cocli login current

0 commit comments

Comments
 (0)