在本地环境开发文档¶
Note
在尝试此操作之前,您应该了解github的结构,更多信息可以在这里找到。
分叉存储库¶
一开始,您需要创建您自己的文档存储库分叉来跟踪您的更改。为此,请先导航到这个存储库。您需要创建这个存储库的分叉,这个教程可以在这里找到。
分叉所有分支¶
Warning
确保您正确执行此步骤,否则您以后会遇到问题。
点击分叉后,您将看到这个屏幕。您可以自定义存储库的名称和描述,但是您必须确保取消选中“仅复制 main
分支”。您需要 main
和 beta
分支才能做出贡献。
禁用github actions¶
您希望禁用github actions,以防止出现问题。您可以在设置菜单中这样做:
设置 --> Actions / General --> 禁用 actions --> 保存
删除 gh-pages
分支¶
您不需要 gh-pages
分支,所以您可以像这样删除它。
选择当前分支 --> 查看所有分支 --> 选择 gh-pages
分支旁边的删除图标
设置本地分支¶
现在,您需要导航到您的电脑上用于 HASS.Agent 的目录,我将使用 HASS.Agent
现在,请创建至少一个名为 hass-agent-docs-beta
的新文件夹。
将分支克隆到每个文件夹¶
在 HASS.agent
目录中打开命令提示符,并将您分叉存储库的 beta
分支克隆到 hass-agent-docs-beta
文件夹中。您可以使用 -b beta
标志来完成此操作。
设置本地环境¶
需要Docker
贡献文档需要Docker,您可以在这里获取它。您还需要在您想要编辑文档时运行docker引擎。
设置Docker¶
要设置本地docker环境,您只需要运行以下命令:
这将构建和设置本地docker,并激活实时重新加载编辑页面。您可以在 localhost:8000 查看此页面。
只要此页面成功显示文档,您就可以继续进行开发周期和编辑页面。
在main分支上进行热修复
如果您想在main分支上应用热修复,您可以重复这里的步骤。