编辑和同步课程内容¶
ZJUI-Learn 中的所有课程内容都位于 Git 存储库中,通常托管在 GitHub 上。该存储库与 ZJUI-Learn 同步。
有两种方法可以编辑内容:通过 ZJUI-Learn 中的浏览器内编辑器,以及直接与存储库交互。
浏览器内编辑器¶
如果您不想在计算机上设置 Docker 并直接使用 Git/GitHub,则可以通过支持页面上显示的“文件”选项卡直接访问和编辑 ZJUI-Learn 中的所有内容。当您保存对文件的编辑时,您的更改会自动同步到您的 GitHub 存储库。请注意,您必须在课程中拥有“编辑者”或“所有者”权限才能编辑文件。
浏览器内编辑器非常适合 ZJUI-Learn 入门,并且可以很好地管理少量讲师的内容。然而,由于课程人员众多,您可能希望通过软件工程最佳实践(例如代码审查或持续集成)对变更进行更多控制。为此,您可以使用 Git 和 GitHub,如下一节所述。
git/GitHub¶
由于您的课程内容是托管在 GitHub 上的 Git 存储库,因此您可以直接使用计算机上的底层存储库。这样做有很多好处:
- 您可以在本地开发和测试内容,而不会影响您的实时问题或评估。
- 您可以要求进行代码审查,以确保更改得到课程工作人员中多个人员的验证。
- 如果您愿意,您可以使用持续集成服务来自动测试和验证对内容的更改。
首先,请确保您有权访问课程的存储库。您可能需要向存储库的所有者请求访问权限。接下来,按照本地安装说明,让ZJUI-Learn在您的计算机上运行。从那里,您可以在首选文件编辑器中编辑课程内容并在本地预览更改。
我们推荐 GitHub 流程:用户应该克隆课程存储库,签出新分支,将更改推送到分支,然后打开拉取请求。一旦他们的更改经过审核、批准和合并,课程中具有“编辑者”权限的讲师就可以导航到课程的“同步”页面,并使用“从远程 git 存储库拉取”按钮将更改同步到 ZJUI-Learn。请注意,您必须在课程中拥有“编辑者”或“所有者”权限才能同步存储库。
如果您是 Git 新手,以下资源可以帮助您入门:
您可以在计算机上使用任何您喜欢的 Git 客户端。 git CLI 可在所有平台上使用。一些流行的图形客户端是 GitHub Desktop 和 SourceTree。