# Bohrium-docs

**Repository Path**: JiamengHuang/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-07-12
- **Last Updated**: 2022-09-15

## 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.test.dp.tech/docs/UpgradeGuide/)

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

## 查看文档

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

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

## 语法

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

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

## 本地预览文档

#### 配置环境

本地启动帮助文档，需要 `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/)