Skip to content

How to Contribute to This Page

We welcome any interesting modifications to this website!

To contribute, you need a CERN GitLab account and developer permissions from a group member with maintainer permissions (usually senior members).

Clone the repository on your local machine, and create a new branch for your changes.

git clone ssh://git@gitlab.cern.ch:7999/cms-cmu/documentation.git
git checkout -b changes_$USER ## or whatever name you want your branch to be called

All website content is under the docs/ folder.

  • Optional:
    • You can preview the website locally before publishing changes by running the script at the repository root: bash serve.sh (requires docker installed).
    • To maintain text uniformity, run the linting test with bash lint.sh.

After adding and committing your changes to the new branch (not master), push the branch to the repository. For example, if the new branch is called changes_$USER:

git push origin changes_$USER

When satisfied with the changes and the branch passes the automatic pipelines, create a merge request.