# Docs

**Repository Path**: suli01/anolis-docs

## Basic Information

- **Project Name**: Docs
- **Description**: 龙蜥社区开源文档仓库
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 18
- **Created**: 2024-07-08
- **Last Updated**: 2025-03-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 龙蜥社区开源文档仓库 文档

## 介绍
龙蜥社区文档，涵盖开发者类、产品类、技术类、运营类、基础设施类，等五大类文档，帮助社区用户快速了解 OpenAnolis。  
仓库文档会同步更新到龙蜥社区，访问地址：https://docs.openanolis.cn/  
  
参与文档贡献请参考如下说明：

## 1 如何新增、修改文档
### 1.1 新增、修改目录或文件
第一步：fork 仓库 gitee.com/anolis/anolis-docs 
第二步：在五大目录下新建目录或文件。  

五大目录分别对应：
|目录名称|展示名称|  
|--|--| 
|DEVELOPER_DOCS|开发者类|
|PRODUCT_DOCS|产品类|
|TECHNOLOGY_DOCS|技术类|
|OPERATIONS_DOCS|运营类|
|INFRA_DOCS|基础设施类|

### 1.2 编排目录层级
修改内容所属五大类目录下 menu.yaml 文件，来编排目录，目录层级会体现在龙蜥社区文档系统中。  

修改说明：
* 默认一个缩进为一级目录，两个缩进为二级目录，三个缩进为三级目录。示例如下：

```
INFRA_DOCS:
  社区管理流程:
    CLA 签署操作手册: ./社区管理流程/CLA 签署操作手册.md
```

* 文件地址使用：名称 + “: ” + 路径 的形式，如：xx文件: ../xx/xx.md
其中路径以必须 **../** 和 **./** 开头。


**注意事项：**  
* menu.yaml 必须以根目录名开头。如：

```
INFRA_DOCS:  # 必须以根目录名开头
  社区管理流程: ./xx.md
```

* 文件地址中的 “: ” 冒号为英文格式，且 “: ” 后必须有一个空格
* 文件地址中的 路径 只支持 .md 结尾的 markdown 文件

### 1.3 设置目录审查人
maintainers.yaml 用于定义目录文件的权限，当提交的 PR 文件变更时，文件所属的 maintainer 权限人会被系统自动设置为该 PR 的审查人。
maintainers.yaml 写法示例如下：

```
# maintainers 用于定义权限用户组，用户组名称可自己定义
maintainers:
  - default_group: &default_group
      - openanolis_id: xx
        gitee_id: xxxx
  - network_group: &network_group
      - openanolis_id: yankai
        gitee_id: just-sososo
      - openanolis_id: yankai
        gitee_id: just-sososo
  - io_group: &io_group
      - openanolis_id: lisi
        gitee_id: lisi
      - openanolis_id: xxx
        gitee_id: just-sososo
  - other_group: &other_group
      - openanolis_id: yankai
        gitee_id: just-sososo

# paths 用于指定文档目录所属的权限用户组
paths:
  - /*: *default_group  # 文档路径: 用户权限组
  - ./network/*: *network_group
  - ./DEVELOPER_DOCS/*: *other_group
  - ./INFRA_DOCS/*: *other_group
```

修改说明：
* maintainers 为自定义分组，在每个具体的分组下可指定maintainer，包括龙蜥社区帐户id以及gitee账户id
* paths 用来指定每个文档路径对应的用户组权限，每个用户组可单独作用于path路径

**注意事项：**  
* paths 下的文档路径如果是给所有文件设置权限必须使用 /* ，如果是路径文件必须以 ./ 开头。

具体使用规则介绍：
* 整体控制：文件路径为 /* 的对应的权限分组可以控制整个文档类别下所有文档的权限，包括 maintainers.yaml 及 menu.yaml 的权限。
* 细粒度控制：每类文档可自行定义各路径的权限分组。
* 优先级及用户选择：  
  a. 当同一个文档被多个路径所代表的权限分组同时覆盖时，优先使用最小范围的权限分组。  
  b. 当同一个 PR 中既有配置文件和内容文件更新时，会同时使用配置文件和内容文件对应的权限组进行审核。

### 1.4 提交PR
将以上修改提交到 Gitee 仓库上，并在 Gitee 上创建一个 PR。同步程序会自动检查内容是否符合规范，如不符合规范请按提示修改。修改后可在 PR 评论区，回复 “/retest” 指令重新检查，直到同步程序回复可以同步为止。如回复指令后评论区未看到提示，请刷新页面后再查看。  
注意：同步时只支持 “/retest” 指令，暂不支持其它指令

## FAQ