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, events and news.
There are 3 ways you can contribute:
1. Adding new content¶
- To contribute new projects, please send us an email to computeops-l-request@in2p3.fr
-
To contribute a new publication, the preferred method is to update the bibtex file through a merge request (see below in section 3). The entry should look like this
-
To contribute a news item (workshop, school, call, announcement...), add a Markdown file in
docs/news/posts/through a merge request (see section 3), namedYYYY-MM-short-title.md. The easiest is to copy an existing post. A post is made of :- a header with the
dateand thecategories(Workshop,School,Conference,CommunityorCall, which sets the colour of the card). Addpin: trueto keep a news at the top of the list; - a
# Titleline; - a short text shown in the news list, optionally with a preview image displayed on the right (put the image in
docs/img/; wide banners are cropped to their top); - a
<!-- more -->line, followed by an optional longer text only shown on the news page itself.
If you are not at ease with GitLab, open an issue with the text, date and a link, and we will add it.
- a header with the
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 mention @randriatoamanana.
Smaller changes can be proposed directly through merge requests:
- Request to join the project on GitLab (up top, near the project ID).
- Create a new branch
- Modify the markdown files in the
/docsdirectory or thein2p3cops_publications.bib - Test locally (see Website development)
- Open a merge request and assign it to
@randriatoamanana
If you include new markdown pages, make sure they are listed in the
navsection of themkdocs.ymlfile in the root directory.
To develop and test the website, please follow the instructions below.
Website development¶
The static website is build with Python and mkdocs.
The list of publications is rendered directly from the BibTeX file by the mkdocs-bibtex plugin.
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
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