Skip to content

How to contribute?

This website has been designed to be built collaboratively.
We need your help to maintain up-to-date sections such as publications, projects and events.

There are 3 ways you can contribute:

1. Adding new content

  • To contribute new projects, please fill the form at this link.
    It will automatically add your project to the relevant page during the next website build (every Sunday).

  • To contribute new PhD theses, please fill the form at this link.
    It will automatically add the thesis to the relevant page during the next website build (every Sunday).

  • To contribute a new publication, please fill the form at this link.
    We will manually add it to the bibtex file in the repository.

2. Reporting an issue or requesting a modification in the website

To report an issue or propose a modification in the pages, you may open an issue with all the needed information to be added to the website (check the current pages to know what you need to provide).

To do so, you will need to connect to the GitLab platform using your eduGAIN credentials.

3. Propose changes yourself

If you want to propose important changes to the pages, please start a discussion first by opening an issue and tag @vuillaume.

Smaller changes can be proposed directly through merge requests:

  1. Request to join the project on GitLab (up top, near the project ID).
  2. Create a new branch
  3. Modify the markdown files in the /docs directory or the in2p3ml_publications.bib
  4. Test locally (see below)
  5. Open a merge request and assign it to @vuillaume

If you include new markdown pages, make sure they are listed in the nav section of the [mkdocs.yml] file in the root directory.

To develop and test the webiste, please follow the instructions below.

Website development

The static website is build with Python and mkdocs.

The list of publications is build with bibtex2html and included in the website a posteriori using a Python script.

Local setup

  • Create a virtual environment (optional but recommended) python -m venv venv source venv/bin/activate
  • Install the dependencies python -m pip install -r requirements.txt
  • Install bibtex2html (instructions here)

Local testing

  • Build website with live-reloading server for development mkdocs serve
  • Strict building of the website (check) make test-site
  • Build publication list (check) make test-biblio
  • Build website with publication list make build
  • Change the bibliography style make build bibstyle=<mystyle> # e.g. to use a <mystyle>.bst file in the current directory