From a3c48498292cc75d8eaf88de86a907c1d47e5d9a Mon Sep 17 00:00:00 2001 From: xiezipeng05 Date: Mon, 27 May 2024 20:30:10 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=88=9D=E6=AC=A1=E6=8F=90=E4=BA=A4?= =?UTF-8?q?=E5=86=85=E5=AE=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../1_example_section/1_example_article.md | 6 ---- .../1_example_section/1_example_article2.md | 6 ---- 1_example_chapter/1_example_section/README.md | 1 - 1_example_chapter/2_example_article3.md | 6 ---- 1_example_chapter/README.md | 1 - .../1_example_section2/README.md | 1 - 2_example_chapter2/README.md | 1 - 3_example_chapter3/README.md | 1 - _config.yml | 4 +-- _toc.yml | 29 +++++++++++-------- cooporation/issues.md | 4 +++ cooporation/plans.md | 3 ++ docs/README.md | 16 ++++++++++ index.md | 4 +++ naming/handbooks.md | 2 ++ naming/platforms/README.md | 1 + naming/platforms/codes.md | 6 ++++ naming/platforms/docs.md | 4 +++ naming/standards.md | 2 ++ naming/tools/README.md | 1 + naming/tools/applications.md | 4 +++ naming/tools/domains.md | 4 +++ naming/tutorials.md | 2 ++ 23 files changed, 72 insertions(+), 37 deletions(-) delete mode 100644 1_example_chapter/1_example_section/1_example_article.md delete mode 100644 1_example_chapter/1_example_section/1_example_article2.md delete mode 100644 1_example_chapter/1_example_section/README.md delete mode 100644 1_example_chapter/2_example_article3.md delete mode 100644 1_example_chapter/README.md delete mode 100644 2_example_chapter2/1_example_section2/README.md delete mode 100644 2_example_chapter2/README.md delete mode 100644 3_example_chapter3/README.md create mode 100644 cooporation/issues.md create mode 100644 cooporation/plans.md create mode 100644 docs/README.md create mode 100644 naming/handbooks.md create mode 100644 naming/platforms/README.md create mode 100644 naming/platforms/codes.md create mode 100644 naming/platforms/docs.md create mode 100644 naming/standards.md create mode 100644 naming/tools/README.md create mode 100644 naming/tools/applications.md create mode 100644 naming/tools/domains.md create mode 100644 naming/tutorials.md diff --git a/1_example_chapter/1_example_section/1_example_article.md b/1_example_chapter/1_example_section/1_example_article.md deleted file mode 100644 index 9233c38..0000000 --- a/1_example_chapter/1_example_section/1_example_article.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -level: introductory -stage: alpha ---- - -# 测试文章 diff --git a/1_example_chapter/1_example_section/1_example_article2.md b/1_example_chapter/1_example_section/1_example_article2.md deleted file mode 100644 index db8928f..0000000 --- a/1_example_chapter/1_example_section/1_example_article2.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -level: introductory -stage: alpha ---- - -# 测试文章2 diff --git a/1_example_chapter/1_example_section/README.md b/1_example_chapter/1_example_section/README.md deleted file mode 100644 index d3ed8ec..0000000 --- a/1_example_chapter/1_example_section/README.md +++ /dev/null @@ -1 +0,0 @@ -# 示例节1 diff --git a/1_example_chapter/2_example_article3.md b/1_example_chapter/2_example_article3.md deleted file mode 100644 index 336f212..0000000 --- a/1_example_chapter/2_example_article3.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -level: introductory -stage: alpha ---- - -# 测试文章3 diff --git a/1_example_chapter/README.md b/1_example_chapter/README.md deleted file mode 100644 index d68340c..0000000 --- a/1_example_chapter/README.md +++ /dev/null @@ -1 +0,0 @@ -# 示例章 \ No newline at end of file diff --git a/2_example_chapter2/1_example_section2/README.md b/2_example_chapter2/1_example_section2/README.md deleted file mode 100644 index 89a285f..0000000 --- a/2_example_chapter2/1_example_section2/README.md +++ /dev/null @@ -1 +0,0 @@ -# 示例节2 diff --git a/2_example_chapter2/README.md b/2_example_chapter2/README.md deleted file mode 100644 index 1825e6a..0000000 --- a/2_example_chapter2/README.md +++ /dev/null @@ -1 +0,0 @@ -# 示例章2 \ No newline at end of file diff --git a/3_example_chapter3/README.md b/3_example_chapter3/README.md deleted file mode 100644 index 1825e6a..0000000 --- a/3_example_chapter3/README.md +++ /dev/null @@ -1 +0,0 @@ -# 示例章2 \ No newline at end of file diff --git a/_config.yml b/_config.yml index a255055..671880d 100644 --- a/_config.yml +++ b/_config.yml @@ -1,7 +1,7 @@ # https://jupyterbook.org/en/stable/customize/config.html name: quanttide-example-of-documentation -title: 量潮示例文档项目 +title: 量潮数字资产手册 author: 量潮科技 -description: 量潮文档项目实例 +description: 量潮数字资产手册 # Jupyter Book Config only_build_toc_files: true \ No newline at end of file diff --git a/_toc.yml b/_toc.yml index 6d0c126..f2b4d77 100644 --- a/_toc.yml +++ b/_toc.yml @@ -1,18 +1,23 @@ format: jb-book root: index.md parts: - - caption: 示例部分 + - caption: 命名 chapters: - - file: 1_example_chapter/README.md + - file: naming/tutorials.md + - file: naming/handbooks.md + - file: naming/standards.md + - file: naming/tools/README.md sections: - - file: 1_example_chapter/1_example_section/README.md - sections: - - file: 1_example_chapter/1_example_section/1_example_article.md - - file: 1_example_chapter/1_example_section/1_example_article2.md - - file: 1_example_chapter/2_example_article3.md - - caption: 示例部分2 - chapters: - - file: 2_example_chapter2/README.md + - file: naming/tools/domains.md + - file: naming/tools/applications.md + - file: naming/platforms/README.md sections: - - file: 2_example_chapter2/1_example_section2/README.md - - file: 3_example_chapter3/README.md \ No newline at end of file + - file: naming/platforms/codes.md + - file: naming/platforms/docs.md + - caption: 团队协作 + chapters: + - file: cooporation/plans.md + - file: cooporation/issues.md + - caption: 文档工程 + chapters: + - file: docs/README.md \ No newline at end of file diff --git a/cooporation/issues.md b/cooporation/issues.md new file mode 100644 index 0000000..2ffe2f6 --- /dev/null +++ b/cooporation/issues.md @@ -0,0 +1,4 @@ +# 议题 + +1. 议题文档命名："<年份和周数>-<委员会和编号>-<简化的标题>"，如“2024年第6周-常委会议题4-微盘资源治理”。 +2. 议题文档格式：分为元数据区、提案区、讨论区、投票区四个部分，具体参考上面文档的格式。 diff --git a/cooporation/plans.md b/cooporation/plans.md new file mode 100644 index 0000000..0cec8e3 --- /dev/null +++ b/cooporation/plans.md @@ -0,0 +1,3 @@ +# 计划 + +工作计划是为了有一个全局的视角知道项目的计划和进度，在整个项目过程中随时把对计划最新的调整同步上去，避免参与者只知局部不知全貌。 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..9351f8f --- /dev/null +++ b/docs/README.md @@ -0,0 +1,16 @@ +# 文档维护 +1. 草稿 + +草稿汇总：个人 -> 部门（如微盘“CEO办公室”） -> 公司（微盘“数字资产”空间）-> 文档工程-文档管理-草稿 + +2. 已解决的文档 + +草稿中已经通过流程审议完毕的内容，通过PR提交到对应Github仓库 + +3. 悬而未决的文档 + +草稿中审议后还不确定的内容，提交到对应Github仓库中的Issue，等到讨论清楚以后走PR流程提交到仓库 + +4. 后续 + +丢弃原草稿（指删除已经审议、上传过的内容），避免重复信息 diff --git a/index.md b/index.md index b6d4af6..1f48dab 100644 --- a/index.md +++ b/index.md @@ -1 +1,5 @@ # 简介 + +之所以要定义不同类型的数字资产，是要分别维护不同类型的信息，方便在组织内外部流转。 + +把需要标准化和数字资产化的资源集中到微盘的一个空间集中管控。使用我们已经制定的各种标准来制定各种资源管理的最佳实践，并记录到手册里。利用这个方法，可以不断检验标准、积累手册，为研发云平台积累经验，减少未来迁移资源的成本。 diff --git a/naming/handbooks.md b/naming/handbooks.md new file mode 100644 index 0000000..966339a --- /dev/null +++ b/naming/handbooks.md @@ -0,0 +1,2 @@ +# 手册 +quanttide-handbook-of- diff --git a/naming/platforms/README.md b/naming/platforms/README.md new file mode 100644 index 0000000..3141b35 --- /dev/null +++ b/naming/platforms/README.md @@ -0,0 +1 @@ +# 平台 \ No newline at end of file diff --git a/naming/platforms/codes.md b/naming/platforms/codes.md new file mode 100644 index 0000000..152499d --- /dev/null +++ b/naming/platforms/codes.md @@ -0,0 +1,6 @@ +# 代码类 +qtcloud-data-provider，即品牌标识-功能标识（-语言和框架标识），语言和框架标识在多套代码时使用在次要项目上。 + +provider是server中作为底层依赖的 + +console sdk cli是client的三种主要形式，不提供SDK和CLI的终端应用可使用client代替console，如qtclass-client diff --git a/naming/platforms/docs.md b/naming/platforms/docs.md new file mode 100644 index 0000000..8b0c0a1 --- /dev/null +++ b/naming/platforms/docs.md @@ -0,0 +1,4 @@ +# 文档类 +qtcloud-data-architecture-docs，即品牌标识-功能标识-docs。 + +其中readme是特例，不加docs后缀。 diff --git a/naming/standards.md b/naming/standards.md new file mode 100644 index 0000000..5e8e2c7 --- /dev/null +++ b/naming/standards.md @@ -0,0 +1,2 @@ +# 标准 +quanttide-specification-of- diff --git a/naming/tools/README.md b/naming/tools/README.md new file mode 100644 index 0000000..fb79fd1 --- /dev/null +++ b/naming/tools/README.md @@ -0,0 +1 @@ +# 工具库 \ No newline at end of file diff --git a/naming/tools/applications.md b/naming/tools/applications.md new file mode 100644 index 0000000..6cf886d --- /dev/null +++ b/naming/tools/applications.md @@ -0,0 +1,4 @@ +# 应用层 +quanttide-code-agents，即 品牌标识-项目标识 + +由于一般是交叉多个领域，所以使用公司标识为主。 diff --git a/naming/tools/domains.md b/naming/tools/domains.md new file mode 100644 index 0000000..78eb130 --- /dev/null +++ b/naming/tools/domains.md @@ -0,0 +1,4 @@ +# 领域层 +quanttide-data-python，即 品牌标识-语言（如果不带则默认Python，一般都带），遵循社区命名习惯 + +flutter-quanttide-data，即 框架-品牌标识，遵循社区命名习惯 diff --git a/naming/tutorials.md b/naming/tutorials.md new file mode 100644 index 0000000..55a9abc --- /dev/null +++ b/naming/tutorials.md @@ -0,0 +1,2 @@ +# 教程 +quanttide-tutorial-of-