如何为 "第三运行期入门指南" 贡献内容
以下列出了为 "第三运行期入门指南" 贡献内容的说明,感谢您考虑参与贡献!
小幅度修改
要对现有课程进行小幅度修改(如修复失效链接、纠正拼写错误等),只需点击课程页面上的"编辑此页面" 按钮(铅笔图标)。这会直接带您进入GitLab,在那里您可以进行修改并提交。
较大幅度修改
一般来说,要对课程进行较大改动,首先需要克隆代码仓库:
git clone ssh://git@gitlab.cern.ch:7999/lhcb-dpa/wp7-training-and-documenation/starterkit-run3.git
之后,所做的任何修改都可以像往常一样提交到分支,并可以发起合并请求。
要在本地构建入门指南以查看您的修改在最终产品中的效果,可以使用附带的 build.sh
脚本。之后,可按照以下说明打开 public/index.html
文件。
Tip
要在虚拟环境中运行,您可以先执行 conda env create -f environment.yml
。但这并不能保证完全复现 CI 的构建方式。
课程内容存储在doc
文件夹中,其目录结构与入门指南中的课程/子课程结构一致。要编辑现有课程,只需找到对应的 .en.md 文件并直接在其中修改即可。
打开本地文档
文档构建完成后,如果是在本地机器上构建的,可以通过以下方式打开:
如果文档已在本地构建,只需运行:
python -m mkdocs serve
# 现在访问 http://127.0.0.1:8000/
如果不是在本地构建的,最好的方法是将public
文件夹复制到本地,然后运行以下命令:
cd public
python -m http.server 8000 & # 记得关闭网页后终止这个进程!
export serverjob=$!
python -m webbrowser http://[::]:8000/
之后可以通过运行kill $serverjob
来终止服务器进程。
添加新课程
要添加新课程,请在doc
文件夹中按照目录结构为其创建一个.en.md
文件。默认情况下,课程名称与文件名相同,若要更改,可在mkdocs.yml
中进行设置。
添加图片
要添加图片,请将图片放在课程所在目录的一个文件夹中(按照惯例,该文件夹名为 img ),然后按以下方式添加图片:
