Anolis Features

这个仓库包含了龙蜥社区Anolis的技术特性。用于向社区用户展示龙蜥社区的最新技术成果。

龙蜥社区主页：https://openanolis.cn/

Contributing

龙蜥社区是一个开放包容的社区，非常欢迎志同道合之士与我们一起共建该文档库。

对于文档中您觉得任何疑惑之处，都可以新开issue，我们将积极回应。

对于文档中的不足，也欢迎您新建PR来更新。

issue规范

为了方便我们及时响应您的请求，issue标题需要给出必要的信息。例如我对龙蜥社区Anolis Kernel代码感兴趣，但是overview里没有给出具体的代码库链接，那么可以提这样的issue：

overview: there is no link of anolis kernel code repo.

希望overview中添加anolis内核仓库代码链接

如果您对某个方向下的一个section有疑惑，例如mutli_arch下有intel_spr_support.md文件介绍了anolis对spr平台的支持，但是您希望了解更多关于SPR SIOV的资料，那么您可以提以下issue：

multi_arch/intel_spr_support: hope to add more materials of SPR SIOV

PR提交规范

作为一个社区文档，我们认为必要的提交规范有助于社区健康发展。为此，您在提交commit时，务必在标题开头添加您更新部分的关键字，然后是冒号和简短描述。例如我在overview添加了文档的描述信息，就可以这样：

overview: add description for this document

对于如何指定PR的reviewer，请参看文档库相关owner这一节。

文档规范

• 在八大技术领域的某一目录下放置你的文档.md

  • 以intel_spr_support.md为例，在multi_arch目录下新建intel_spr_support.md文档
  • 文章可以加tag，具体操作请参看tags一节
  • 若文档内容同时包括英文和中文，则必须在英文和中文之间加一个空格
    • 如“这是 Anolis 技术素材库”，在“是”和“Anolis”之间以及“Anolis”和“技”之间分别有一个空格

• 在materials下放置你的素材

  • 如图片就在imgs下的八大技术领域目录下新建一个自己内容的文档
    • 以intel_spr_support为例，在materials/img/multi_arch下新建intel_spr_support目录，将所有图片放在这个目录下
  • 图片命名请突出图片所表达的信息，单词之间以下划线分隔
  • 图片请以jpg或png格式提交

• 更新SUMMARY.md，新建一个标题项，并链接到自己的文档

如何测试

在您提交文档库更新时，请务必确保已在本地进行过构建测试。

测试方法：

1. 安装nvm https://github.com/nvm-sh/nvm/blob/master/README.md

2. 安装node.js

   • 执行 nvm -i 10
   • 执行 nvm use 10
   • 安装gitbook-cli，执行 npm install gitbook-cli -g

重要‼️ 这里有需要修改一下gibook的配置 vim ~/.gitbook/versions/3.2.3/lib/output/website/copyPluginAssets.js 修改112行的 confirm：true为false

3. 构建gitbook
   • 安装插件 gitbook install
   • 构建 gitbook build
   • 本地启动一个server：gitbook serve

Tags

本文档库目前支持对文章加tags，方便管理和阅读一个系列的文档。

具体的操作方式：在文档一级标题下，放置tags。以multi_arch下intel_spr_support.md为例，我想给改文章加一个tag“一云多芯硬件生态”。那么只需按照如下方式：

Intel SPR平台支持

tags: 一云多芯硬件生态

目前支持 tags 类型

为了方便管理，我们定义了两种类型的 tags，文档必须使用这里预定义的 tags。具体定义分别是:

1. 技术方向 tags

• CentOS 迁移
• 云原生场景
• 一云多芯硬件生态
• 运维与性能
• 软硬件协同
• 安全可信
• 编程语言
• 社区基础设施

2. 版本 tags

• Anolis23
• Anolis8

文档库相关owner

目前文档库owner的划分是按照OpenAnolis SIG组来划分的。所以在您提交PR之后，可以按照内容所属的SIG组指定owner来review。