README

⚠️ 进行中：该仓库目前正在开发中！ 🚧

该仓库的目的是存放EasyEngine v4文档。随着时间的推移，我们希望将EasyEngine.io上发布的所有教程都放在这里。

V4 文档

EasyEngine v4 文档分为两部分。

命令参考

这部分通过解析PHP文档块自动生成。请勿编辑commands文件夹中的markdown文件，因为它们可能会随时被覆盖。

如果您想为命令文档发送一个修复，最好的方式是发送一个包含对相应仓库中PHP文档块的更改的pull request。

或者，可以在本仓库中创建一个新问题，包括以下详细信息

1. 您要修复的EE命令
2. 说明错误的部分（截图也行）
3. 说明正确的部分（可选）

手册

EasyEngine v4有很多内容。Docker魔法，新的文件系统布局等等。这部分是独立于任何命令的。

目前，我们在每个我们认为需要文档的方面创建标记为documentation的问题。

您可以通过以下方式提供帮助

编写新的文档

如果您熟悉EasyEngine v4

1. 选择一个标记为documentation的问题。
2. 请在问题上发表评论，例如“正在处理此问题”。这样其他人就不会选择相同的问题。
3. 分叉此仓库!
4. 在handbook/文件夹中为问题创建一个新的markdown文件。请避免在文件名中使用空格。使用-作为分隔符。所有字符均为小写。
5. 完成markdown文件的编写后，通过pull request（PR）提交。

如果由于某些原因无法发送PR，可以在相关问题的评论中写下文档。请使用markdown。我们将手动复制您的评论！

更新现有文档

您可以通过两种方式帮助文档更新

1. 英语不是任何核心团队成员的主要语言。所以如果您可以改善文档的语言，使其更容易理解，那将非常有帮助。
2. 发送更新以改进准确性，添加更多信息或甚至修复错别字！

文档托管

我们不在使用Github pages或任何静态网站生成器。相反，rtCamp的另一团队正在开发一个解决方案，将无缝将这些markdown文件发布为WordPress站点上的页面。

他们的WordPress自定义代码将负责所有文档站点需要的铃声和哨声，例如

• 样式（主题），
• 目录
• 列出子页面
• 面包屑导航
• 搜索
• 相关页面
• 元数据，如标题、描述、slug

我们将开源WordPress自定义代码，以便任何希望使用此类文档流的项目都能从中受益。我们使用了一些来自wp-cli的代码。wp-cli项目文档也是这样构建的。

一旦我们准备好了文档网站，我们将在这里添加其URL。

好事是 - 我们正在使用Markdown文件编写，如果没有其他办法的话（截至2018年11月15日），可以快速将其转换为Github Pages！😉

建议的构建过程

1. 所有EasyEngine命令仓库以及这个文档仓库都将设置CI/CD。
2. 每当有变化时，就会运行一个构建过程，该过程将调用一个wp-cli命令（WordPress自定义代码）。
3. 那个wp-cli命令将负责以适当的方式更新WordPress站点。

传统流程

文档位于GitHub上，以启用基于拉取请求的编辑工作流程。长篇文档可以直接编辑。命令页面是通过使用ee handbook gen_commands系列命令从EasyEngine代码库动态生成的。ee handbook gen-all将重新生成所有命令页面和手册页面。

所有文档都通过两步过程自动导入到docs.easyengine.io

1. WordPress读取commands-manifest.json和handbook-manifest.json以了解需要创建的所有页面。
2. 每个WordPress页面都有一个markdown_source属性，指定要获取、转换为HTML并保存到数据库中的Markdown文件。

对于docs.easyengine.io，导入过程是在每次向github仓库推送时运行一个WP Cron作业。