V3.3.10 docs improve (TencentBlueKing#102)

* docs: 修改源码部署SaaS文档，并优化对应配置代码 TencentBlueKing#98 * docs: 优化issue_template.md * docs: 更新3.3.10版本日志
pagezz-canway · Apr 11, 2019 · d10a1b8 · d10a1b8
1 parent 5687485
commit d10a1b8
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 17 deletions.
diff --git a/config/prod.py b/config/prod.py
@@ -31,11 +31,11 @@
 
 
 # 正式环境数据库可以在这里配置
-# 默认 default 请不要修改，如果使用了外部数据库，请联系【蓝鲸助手】授权
-# DATABASES.update(
+# USE FOLLOWING SQL TO CREATE THE DATABASE NAMED APP_CODE
+# SQL: CREATE DATABASE `bk_sops` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
+# DATABASES = (
 #     {
-#         # 外部数据库授权，请联系 【蓝鲸助手】
-#         'external_db': {
+#         'default': {
 #             'ENGINE': 'django.db.backends.mysql',
 #             'NAME': '',  # 外部数据库名
 #             'USER': '',  # 外部数据库用户

diff --git a/config/stag.py b/config/stag.py
@@ -31,11 +31,11 @@
 
 
 # 预发布环境数据库可以在这里配置
-# 默认 default 请不要修改，如果使用了外部数据库，请联系【蓝鲸助手】授权
-# DATABASES.update(
+# USE FOLLOWING SQL TO CREATE THE DATABASE NAMED APP_CODE
+# SQL: CREATE DATABASE `bk_sops` DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci;
+# DATABASES = (
 #     {
-#         # 外部数据库授权，请联系 【蓝鲸助手】
-#         'external_db': {
+#         'default': {
 #             'ENGINE': 'django.db.backends.mysql',
 #             'NAME': '',  # 外部数据库名
 #             'USER': '',  # 外部数据库用户

diff --git a/docs/install/source_code_deploy.md b/docs/install/source_code_deploy.md
@@ -72,7 +72,7 @@ add_app_token bk-sops-ce "$(_app_token bk-sops-ce)" "标准运维定制版"
 按照前面的步骤操作后，你已经在蓝鲸社区版 PaaS 上创建了一个标准运维的定制版本，如果功能测试正常（请主要测试流程模板创建、任务执行、任务操作等核心功能），那么你可以选择下架官方标准运维应用，并用定制版本替换。  
 
 1) 如果需要保留官方标准运维应用的所有数据，你需要修改数据库配置  
-获取你部署的蓝鲸社区版平台的数据库账号密码，以及官方标准运维应用的数据库名，默认测试环境是 bk_sops_bkt，正式环境是 bk_sops。修改代码的 conf/settings_testing.py 和 conf/settings_production.py，分别修改为上面获取的官方标准运维应用的数据库信息。
+获取你部署的蓝鲸社区版平台的数据库账号密码，以及官方标准运维应用的数据库名，默认测试环境是 bk_sops_bkt，正式环境是 bk_sops。修改代码的 config/stag.py 和 config/prod.py，分别修改为上面获取的官方标准运维应用的数据库信息。
 ```python
 DATABASES = {
     'default': {

diff --git a/docs/release.md b/docs/release.md
@@ -266,4 +266,7 @@
     - 修复任务节点执行时间超过一天后耗时计算不正确的问题
 
 # 3.3.10
-#todo
+- 新功能
+    - 新增节点回调 API，可以通过该接口继续执行中等待回调的标准插件节点，如BK-暂停、JOB系列插件
+- 优化项
+    - 获取节点详情及创建任务 API 返回数据新增任务树及任务链接
diff --git a/issue_template.md b/issue_template.md
@@ -1,23 +1,23 @@
 问题描述
 =======
-<这里写问题描述>
+<!-- 这里写问题描述 -->
 
 
 重现方法
 =======
-<列出如何重现的方法或操作步骤>
+<!-- 列出如何重现的方法或操作步骤 -->
 
 
-**重要提醒**: 请优先尝试部署使用最新发布的版本 (发布清单： https://github.com/Tencent/bk-sops/releases), 如果问题不能在最新发布的版本里重现，说明此问题已经被修复。
+<!-- **重要提醒**: 请优先尝试部署使用最新发布的版本 (发布清单： https://github.com/Tencent/bk-sops/releases), 如果问题不能在最新发布的版本里重现，说明此问题已经被修复。 -->
 
 
 关键信息
 =======
 
-**重要提醒**: 这些关键信息会辅助我们快速定位问题。
+<!--  **重要提醒**: 这些关键信息会辅助我们快速定位问题。 -->
 
 请提供以下信息:
 
- - [x] bk_sops   版本 (发布版本号 或 git tag): `<示例： V3.1.32-ce 或者 git sha. 请不要使用 "最新版本" 或 "当前版本"等无法准确定位代码版本的语句描述>`
- - [ ] 蓝鲸PaaS   版本: `<示例：PaaS 3.0.58、PaaSAgent 3.0.9>`
- - [ ] bk_sops 异常日志
+ - [x] bk-sops   版本 (发布版本号 或 git tag)： <!-- `示例： V3.1.32-ce 或者 git sha. 请不要使用 "最新版本" 或 "当前版本"等无法准确定位代码版本的语句描述`  -->
+ - [ ] 蓝鲸PaaS   版本：<!-- `<示例：PaaS 3.0.58、PaaSAgent 3.0.9`  -->
+ - [ ] bk_sops 异常日志：