# day-docs

**Repository Path**: yutting123/docs

## Basic Information

- **Project Name**: day-docs
- **Description**: 文档系统仓库
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 6
- **Created**: 2024-05-17
- **Last Updated**: 2024-12-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# OpenAnolis 文档

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


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

修改说明：
* 默认一个缩进为一级目录，两个缩进为二级目录，三个缩进为三级目录。  
* 文件地址使用：名称+“:”+路径的形式，如：xx文件:../xx/xx.md

注意事项：  
* 前三行为默认内容无必要请不要修改。
* 只支持.md结尾文件，作为文档路径
* “:”冒号为英文格式

### 1.3 设置目录审查人
修改内容所属五大类目录下maintainers.yaml文件，设置目录对应maintainer，后续涉及到该目录下内容的修改PR，系统会自动将maintainer设置为该PR的审查人。

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

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

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

## FAQ