From 4c781d5c05a639ff827c2dad3381526e9a52175c Mon Sep 17 00:00:00 2001 From: Guo-Zhang Date: Wed, 22 Nov 2023 09:32:10 +0000 Subject: [PATCH] deploy: 4de32f911618dc492e43a48a4ef04fa290765028 --- _sources/init/README.md | 1 + _sources/init/repo_naming.md | 30 +++ init/README.html | 408 +++++++++++++++++++++++++++++++ init/repo_naming.html | 462 +++++++++++++++++++++++++++++++++++ objects.inv | 7 +- searchindex.js | 2 +- 6 files changed, 905 insertions(+), 5 deletions(-) create mode 100644 _sources/init/README.md create mode 100644 _sources/init/repo_naming.md create mode 100644 init/README.html create mode 100644 init/repo_naming.html diff --git a/_sources/init/README.md b/_sources/init/README.md new file mode 100644 index 0000000..40aba66 --- /dev/null +++ b/_sources/init/README.md @@ -0,0 +1 @@ +# 初始化 diff --git a/_sources/init/repo_naming.md b/_sources/init/repo_naming.md new file mode 100644 index 0000000..e45f118 --- /dev/null +++ b/_sources/init/repo_naming.md @@ -0,0 +1,30 @@ +# 仓库命名 + +## 代码类仓库 + +命名遵循`-(-)`的格式。 +比如:`qtcloud-data-provider`; `qtcloud-sdk-py` + +主要的品牌见“量潮品牌管理手册”。 + +主要的类别包括: + +- `server`、`provider`: 服务端。后者特指云的服务端。 +- `client`、`console`: 客户端、控制台。后者特指云的控制台,SDK和CLI也是客户端的具体形式。 +- `sdk`: SDK。 +- `cli`: 命令行工具(CLI)。 + +## 文档类仓库 + +命名遵循`--of-`的格式。 +比如:`quanttide-handbook-of-devops` + +主要的类别包括: + +- `tutorial`: 基础教程 +- `handbook`: 工作手册 +- `specification`: 工程标准 +- `template`: 模板项目。遵循`cookiecutter`模板规范。 +- `example`: 示例项目 +- `dataset`: 数据集 +- `research`: 研究项目 diff --git a/init/README.html b/init/README.html new file mode 100644 index 0000000..b95b930 --- /dev/null +++ b/init/README.html @@ -0,0 +1,408 @@ + + + + + + + + + + + + 初始化 — 量潮DevOps手册 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
+
+
+
+
+ + + +
+
+ +
+ + + + + + + + + + + + + +
+ +
+ + + +
+ +
+
+ +
+
+ +
+ +
+ +
+ + +
+ +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ + + +
+

初始化

+ +
+
+ +
+
+
+ + + + +
+ +
+

初始化#

+
+ + + + +
+ + + + + + +
+ +
+
+
+ +
+ + + + +
+
+ + +
+ + +
+
+
+ + + + + +
+
+ + \ No newline at end of file diff --git a/init/repo_naming.html b/init/repo_naming.html new file mode 100644 index 0000000..00f1659 --- /dev/null +++ b/init/repo_naming.html @@ -0,0 +1,462 @@ + + + + + + + + + + + + 仓库命名 — 量潮DevOps手册 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + +
+
+
+
+
+ + + +
+
+ +
+ + + + + + + + + + + + + +
+ +
+ + + +
+ +
+
+ +
+
+ +
+ +
+ +
+ + +
+ +
+ +
+ + + + + + + + + + + + + + + + + +
+ +
+ +
+
+ + + +
+

仓库命名

+ +
+
+ +
+

Contents

+
+ +
+
+
+ + + + +
+ +
+

仓库命名#

+
+

代码类仓库#

+

命名遵循<brand>-<category>(-<framework/language>)的格式。 +比如:qtcloud-data-provider; qtcloud-sdk-py

+

主要的品牌见“量潮品牌管理手册”。

+

主要的类别包括:

+
    +
  • serverprovider: 服务端。后者特指云的服务端。

  • +
  • clientconsole: 客户端、控制台。后者特指云的控制台,SDK和CLI也是客户端的具体形式。

  • +
  • sdk: SDK。

  • +
  • cli: 命令行工具(CLI)。

  • +
+
+
+

文档类仓库#

+

命名遵循<brand>-<category>-of-<domain>的格式。 +比如:quanttide-handbook-of-devops

+

主要的类别包括:

+
    +
  • tutorial: 基础教程

  • +
  • handbook: 工作手册

  • +
  • specification: 工程标准

  • +
  • template: 模板项目。遵循cookiecutter模板规范。

  • +
  • example: 示例项目

  • +
  • dataset: 数据集

  • +
  • research: 研究项目

  • +
+
+
+ + + + +
+ + + + + + +
+ +
+
+
+ +
+ + + +
+ + +
+
+ + +
+ + +
+
+
+ + + + + + + + \ No newline at end of file diff --git a/objects.inv b/objects.inv index 13699c5..3cd5ac1 100644 --- a/objects.inv +++ b/objects.inv @@ -2,7 +2,6 @@ # Project: Python # Version: # The remainder of this file is compressed using zlib. -xڅJ@)UܺڅbO0 I`2]ⅈ1+Ap 8I} Igͥ sIbÁ -ev sYrGg}rtE,O/a