Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: 作业平台文档建设 #3119

Closed
jsonwan opened this issue Jul 15, 2024 · 0 comments
Closed

docs: 作业平台文档建设 #3119

jsonwan opened this issue Jul 15, 2024 · 0 comments
Assignees
@nekzhang @wangyu096 @jsonwan
Labels
done 已上线到正式环境并验收通过 kind/enhancement 功能改进特性

Comments

@jsonwan
Copy link
Collaborator

jsonwan commented Jul 15, 2024

主要包含以下内容：
APIDocs（API文档）
Architecture（系统架构）
Operation（部署与运维）
TroubleShooting（问题排查）
ErrorCode（错误码）
UserGuide（用户指引）
@jsonwan jsonwan added kind/enhancement 功能改进特性 backlog 需求初始状态，等待产品进行评估 labels Jul 15, 2024
jsonwan added a commit to jsonwan/bk-job that referenced this issue Jul 19, 2024
@jsonwan
docs: 作业平台文档建设 TencentBlueKing#3119
dbf4836 
1. 支持根据ESB接口文档自动生成接口文档README.md
jsonwan added a commit to jsonwan/bk-job that referenced this issue Jul 19, 2024
@jsonwan
docs: 作业平台文档建设 TencentBlueKing#3119
bb43568 
1. 添加部署与运维文档。
jsonwan added a commit to jsonwan/bk-job that referenced this issue Jul 19, 2024
@jsonwan
docs: 作业平台文档建设 TencentBlueKing#3119
4004108 
1. 添加问题排查与处理文档。
jsonwan added a commit to jsonwan/bk-job that referenced this issue Jul 19, 2024
@jsonwan
docs: 作业平台文档建设 TencentBlueKing#3119
9a474b9 
1. 去除调试生成的多余README.md文档。
jsonwan added a commit to jsonwan/bk-job that referenced this issue Jul 22, 2024
@jsonwan
docs: 作业平台文档建设 TencentBlueKing#3119
8554584 
1. 处理Review意见；
2. 添加部署与运维英文文档。
jsonwan added a commit to jsonwan/bk-job that referenced this issue Jul 22, 2024
@jsonwan
docs: 作业平台文档建设 TencentBlueKing#3119
c5f6d77 
1. 添加首页文档链接，清理已过期的二进制安装部署文档。
jsonwan added a commit to jsonwan/bk-job that referenced this issue Jul 22, 2024
@jsonwan
docs: 作业平台文档建设 TencentBlueKing#3119
4e342f6 
1. 完善API文档简介，精简接口描述。
jsonwan added a commit that referenced this issue Jul 22, 2024
@jsonwan
Merge pull request #3138 from jsonwan/github_docs/add_docs
5ed1167 
docs: 作业平台文档建设 #3119
jsonwan added a commit to jsonwan/bk-job that referenced this issue Jul 22, 2024
@jsonwan
docs: 作业平台文档建设 TencentBlueKing#3119
651d9b6 
1. 支持生成英文版API文档简介；
2. 添加trouble_shooting英文版文档；
3. 修正部分接口文档中不合理的地方。
wangyu096 added a commit that referenced this issue Jul 22, 2024
@wangyu096
Merge pull request #3141 from jsonwan/github_docs/add_docs
ce701ca 
docs: 作业平台文档建设 #3119
@bkjob-bot bkjob-bot added todo 进入开发排期的状态，纳入了最近的迭代 for gray 可以在灰度环境/预发布环境验收 doing 已经接受处理，正在开发实施 done 已上线到正式环境并验收通过 and removed backlog 需求初始状态，等待产品进行评估 todo 进入开发排期的状态，纳入了最近的迭代 doing 已经接受处理，正在开发实施 for gray 可以在灰度环境/预发布环境验收 labels Aug 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@nekzhang nekzhang

@wangyu096 wangyu096

@jsonwan jsonwan

Labels
done 已上线到正式环境并验收通过 kind/enhancement 功能改进特性
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@nekzhang @wangyu096 @jsonwan @bkjob-bot