Skip to content

Advanced edition and addition of pages#

1. Install mkdocs and clone the repo#

Do it only once of course !

git clone https://gitlab.cern.ch/alice-run-coordination/alice-qc-shifters-documentation.git
cd alice-qc-shifters-documentation
pip install mkdocs
for p in $(cat requirements.txt); do pip install $p; done

2. Launch the website locally#

mkdocs serve

It will tell you the url to see the site locally, something like http://127.0.0.1:8000/alice-qc-shifter.docs.cern.ch/.

3. Modify the site#

Add files, modify others, create directories as you please. If you want to modify the menu on the left, edit mkdocs.yml. In case of needs contact us.

4. Commit your changes#

cd alice-qc-shifters-documentation

# FIRST MAKE SURE A LAST TIME THAT IT IS WORKING 
mkdocs serve

# if all is good
git status # review your changes
git add myfile1.md mydir # your changes
git commit -m "Explain your changes"
git push