当你需要新建或者修改某个 Handbook 页面的时候,可以按照本页面的流程来进行,只需要五个步骤就可以新建一个 Handbook 页面。
下面是新建一个 Handbook 页面的过程示例,以制作本页面(如何新建或修改 Handbook 页面)为例。
有几种办法可以开启第一步,你可以通过 新建一个议题 - 在议题下新建一个合并请求 - 从合并请求页面进入Web IDE 的方式来开始。(图例省略了具体的议题创建和合并请求创建过程)。
也可以从任意一个 Handbook 页面直接进入 Web IDE,在提交时再创建合并请求。总而言之,页面的编辑是通过 Web IDE 来实现的。
注意目标分支设置为 jh-staging,找到你想要添加或者修改的文件路径,在对应目录下新建目录,目录名为你想要创建的页面名称(英文),并在该目录下新建名为 index.html.md
的文件。
路径为 sites - handbook - source - handbook - 你想要添加的位置
Tips 为防止意外的识别错误,请使用英文为所有的目录和文件命名。
使用 Markdown 语言编写页面,通常每个页面都包括的内容有标题栏和目录,Markdown 使用方法参见 Markdown 指南,页面的具体编写要求和模板参见 Handbook 编写规范 和 Handbook 页面模板
当你新建了一个页面后,如果需要将它添加到首页形成链接,则在首页页面上对应位置进行编辑添加。(首页页面是 sites - handbook - source - handbook 下的那一个 index.html.md 文件)
编写好页面以后选择提交,填写提交信息,并提交。
Tips: 如果第一步采用的是第一种方法,这里则不用再新建分支和合并请求。如果第一步才用的是第二种方法,这里这需要新建新的分支和合并请求(请不要直接提交到 main)
等待流水线部署通过之后,点击查看最新应用,即可以看到修改的页面的临时渲染效果。如果涉及到在一个 MR 中修改或新建了多个页面,则点击右侧的下拉菜单,即可选择想要查看的临时渲染效果页面。这一 https://about1s.gitlab.cn/
开头的链接可直接分享给其他同事以查看审核。
等待审核通过,不要自行点击合并按钮进行合并。
审核通过后将正式发布。如果审核未通过可以再次通过合并请求页面的 代码 - 在 Web IDE 中打开(第一步第一种方法的第三个图的位置),进入编辑页面修改提交。
修改一个已有的 Handbook 页面只需要从那个页面进入 Web IDE(前文中的第一步的第二种方法),然后从第三步开始修改编辑好对应页面内容,后面的步骤同制作一个新的页面一样。
Web IDE beta 与旧版 Web IDE 功能上大同小异。升级后,可以在用户偏好设置中进行新旧版本的切换。偏好设置在右上角点击头像后进入。
Web IDE Beta 如图所示: