Files
codefever/doc/en-us/contribute/doc_pr.md
Carney Wu d3de96487f initial version (#1)
* fix(Useless Code): remove useless code

* feat(Deploy Scripts): add deploy scripts

* fix(Delopy Script): change settings

* fix(Deploy Script): fix ssh-keygen script

* fix(Deploy Script): change env file path

* feat(Deploy Script): add db migration

* fix(Deploy script): change script

* feat(Deploy Script): add sql file to create database

* fix(Deploy Script): add composer support

* fix(Deploy Script): add composer

* fix(Service Script): add http gateway

* fix(Deploy Script): add git path

* fix(Deploy Script): fix setting bugs

* fix(Init Script): get user from config

* fix(Service): adjust run users

* feat(Doc): add doc

* fix(Doc): change docs

* fix(Deploy script): change owner of storage path

* feat: codefever-community documentation system

* fix(Doc): doc details page style

* feat: fix page navigation

* fix(SQL File): fix db file fit MySQL 5.7

* fix(FileTree): empty repository display

* fix: fix helper navigation

* docs(zh-cn essential part):

* fix(Doc Style): change markdown.css

* docs(contribution doc):

* fix: unified page style

* docs(Readme): add readme

* build(Build):

Co-authored-by: cubic <carneywu@pgyer.com>
Co-authored-by: pololi <pololi@pgyer.com>
Co-authored-by: yangchen <chenyang@pgyer.com>
2022-01-19 17:21:59 +08:00

1.3 KiB

提交文档

文档贡献

当阅读 CodeFever 文档过程中发现文档中有缺失或错误时, 并且你有能力进行补充或修复时, 欢迎向我们提交文档 PR

文档 PR 接收的内容:

  • 文档中的错误
  • 文档中缺失的描述
  • 新增更详细的文档内容
  • 翻译工作

满足以上任何一条的 PR 均可以被合并。

提交文档 PR 的步骤如下:

  1. Fork 本项目
  2. 在自己的仓库下完成文档编辑工作
  3. 提交 PR 前请到 issue 中搜索您的修改是否解决了某些 issue , 如果解决了, 请在提交 PR 时引用
  4. 提交 PRdev/master 分支

在正式贡献文档之前, 建议阅读下一节内容: 文档要求

文档要求

  • CodeFever 文档时树形结构, 以 /doc 为根目录 /doc/zh-cn 是中文文档目录 /doc/en-us 是英文文档目录。 目录按照文档内容区分并分级, 每级目录下的 index.md 文件为目录文件, 所有文档均为 Markdown 文档。

  • 目录文件每行是一个 Markdown 链接, 使用相对路径链接其他文档。

  • 文档文件名由 单词下划线 组成; 使用 Markdown 语法; 图片和附件均保存在文档当前目录的 assets 目录下, 使用相对路径引用。