8000 建议增加贡献者指南 · Issue #40 · ustclug/mirrorhelp · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content
建议增加贡献者指南 #40
Open
@bianjp

Description

@bianjp

刚刚提了个 PR,增加了 EPEL 和 MariaDB 的帮助文档。由于没接触过 SphinxreStructureText ,很是费了一番功夫。

希望提供一份贡献者指南,以帮助初学者快速入门,并保证文档风格的统一。

建议包含以下内容:

  • 如何在本地预览文档(环境要求,安装依赖)
  • 如何添加一个新文档(文件位置、名称,添加后要相应修改哪些地方)
  • 帮助文档的结构(需包含那些部分)
  • 统一风格,比如
    • 各级标题分别使用哪种标识符(= - ` : ' " ~ ^ _ * + # < >),长度多少(目前很多 "WARNING: Title underline too short")
    • Code block 的标识符(::)是单独写在一行,还是写在前一句的末尾?偏爱前者,以免在中文中混入英文冒号
    • 支持多个发行版、同一发行版的多个版本的源,“使用说明”一节是列出所有组合下的配置文件内容,还是提供命令修改默认的配置文件(比如我提的 PR 中对 EPEL 的处理),亦或说明一下原理,让用户自己手动处理?
    • “相关链接”一节使用 Field List,还是无序列表并且使用 Embedded URL 形式不直接显示链接地址。偏爱后者,以免标题、链接过长时分行显示,不美观

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      0