# Bohrium-docs

**Repository Path**: likefallwind/bohrium-docs

## Basic Information

- **Project Name**: Bohrium-docs
- **Description**: Bohrium的用户文档仓库
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 13
- **Created**: 2022-09-17
- **Last Updated**: 2022-09-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Bohrium 帮助文档

1. 在提交新的内容前，需要先合并下master的代码
2. 开发流程与之前一致，需要提交的内容先提PR到develop分支；
3. 新增测试环境：https://bohrium-doc.test.dp.tech/docs/
4. 在develop分支，如何将代码部署到测试环境？
  - mac用户执行本地脚本: ./deploy/tag.sh
  - 遵循流水线tag规范，在本地新建tag推送到远程仓库
  - 遵循流水线tag规范，在网页中新建tag
5. 如何观察测试环境的部署进度？
  - 在云效流水线查看: https://flow.aliyun.com/pipelines/1881128/current
  - 没有权限的同学可以联系 武子涵 开通权限
6. 测试通过后，如何部署到正式环境？
  - 流水线部署测试环境成功后，验证通过开发审批，就会部署到正式环境
7. 如何回滚正式环境的内容？
  - 回滚需要运维小伙伴进行操作，联系 武子涵，可以将正式环境的内容恢复到之前的版本。

## 快速入口

- 正式环境地址: https://bohrium-doc.dp.tech/docs/

- 测试环境地址: https://bohrium-doc.test.dp.tech/docs/

- 部署流水线: [bohrium-docs流水线](https://flow.aliyun.com/pipelines/1881128/current)

## 语法

- 支持使用 [标准 Markdown 语法](https://www.markdown.xyz/basic-syntax/)

- 支持使用 [Docusaurus 扩展语法 & 自定义组件 & 数学公式](https://docusaurus.io/zh-CN/docs/markdown-features)

#### 内部文档链接

- 定位到内部文档: [想要展示的文本](/文档相对根目录的路径)

- 定位到内部文档的带后缀写法: [想要展示的文本](/文档相对根目录的路径.md)

- 定位到内部文档的某个标题: [想要展示的文本](/文档相对根目录的路径#标题名)

```
[跨项目共享镜像](/docs/software-case/OtherSoftwares#共享自定义镜像给其他人使用)
```

#### 使用图片

- 图片资源推荐统一存放在`docs/pictures`目录下

- 使用下面的语法来导入图片：

```
![价格计算器](pictures/screenshot-20220328-201023.png)
```

#### 使用视频

帮助文档中导入B站视频，可在视频下方的 `分享图标` 中点击 `嵌入代码`

![导入B站视频](pictures/screenshot-20220905-180444.png)

复制后的语法如下：
```
<iframe src="//player.bilibili.com/player.html?aid=687179636&bvid=BV1cU4y1k7H7&cid=807199761&page=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true"> </iframe>
```

1. 将复制后的`frameborder`  `framespacing`  `allowfullscreen` 改为小驼峰命名
- ❌  `frameborder`  `framespacing`  `allowfullscreen`
- ✅  `frameBorder`  `frameSpacing`  `allowFullScreen`

2. 设置视频的宽高（根据实际情况自行设置）

- `width="100%" height="500"`

3. 最终代码，复制到md文件中即可

```
<iframe width="100%" height="500" src="//player.bilibili.com/player.html?aid=687179636&bvid=BV1cU4y1k7H7&cid=807199761&page=1" scrolling="no" border="0" frameBorder="no" frameSpacing="0" allowFullScreen="true" sandbox="allow-top-navigation allow-same-origin allow-forms allow-scripts"> </iframe>
```

#### 特殊字符转义

docusaurus会对**html标签**进行特殊处理，当你在文档中需要使用类似于 `<ANY_WORD>` 的语法时，需要在标签的尾部增加斜杠进行转义：

- ❌  `<Group ID>`

- ✅ `<Group ID\>`

## 本地预览文档

#### 配置环境

本地启动帮助文档，需要 `node@16` 的开发环境，推荐使用 `nvm` 安装和管理 `node`

本地启动项目后，每次保存文档时，页面内容会同步更新

##### 安装 `nvm`

- mac: https://github.com/nvm-sh/nvm/blob/master/README.md#install--update-script
- windows: https://github.com/coreybutler/nvm-windows

##### 安装 `node@16`

``` bash
nvm install 16

nvm use 16
```

##### 验证安装结果

``` bash
node -v

npm -v
```

#### 安装依赖

在项目目录内执行:

``` bash
npm install
```

#### 启动项目

在项目目录内执行:

``` bash
npm start
```

## 部署到测试环境

#### 方法1，mac用户执行本地脚本:

1. 打开`./deploy/tag.sh`文件，确认/修改版本号
2. 在项目目录内执行:

``` bash
./deploy/tag.sh
```

#### 方法2，在web中打tag:

在 [Bohrium-docs](https://gitee.com/dptech-corp/bohrium-docs/tags) 新建 `tag`，可以自动将你的修改部署到 [测试环境](https://bohrium-doc.test.dp.tech/)。新建 `tag` 必须遵循 [流水线TAG规范](https://dptechnology.feishu.cn/wiki/wikcn1TgD7VR97Ww0B5MVfjuY45):

```
// b_服务名称_三位版本号_日期与时间

b_bohrium-docs_1.1.2_2022-07-28-10-29
```

#### 查看部署进度

你可以在 [bohrium-docs流水线](https://flow.aliyun.com/pipelines/1881128/current) 上查看部署进度。

如果你无法打开流水线页面，可以联系**运维小伙伴**开通权限

## 执行上线

当 [测试环境](https://bohrium-doc.test.dp.tech/) 的文件测试通过后，在 [bohrium-docs流水线](https://flow.aliyun.com/pipelines/1881128/current) 通过 **开发审批**，就可以将文件推送到 [正式环境](https://bohrium-doc.dp.tech/)