Contributing

TRR379 infrastructure and its documentation and content are developed collaborately. You can contribute by suggesting improvements and/or updating documentation and website content.

Subsections of Contributing

Contribute to the docs

Have you noticed that something in the documentation is missing or out-of-date? If so, then we welcome your contributions, be it by suggesting improvements or editing the docs directly.

The sources for this documentation live on the TRR379 Hub at https://hub.trr379.de/q04/docs.trr379.de/src/branch/main.

Suggest improvements

Please have a look at the open issues to see if your question/comment/discussion point has been brought up before. If not, please create a new issue for discussion.

Edit the docs

The documentation site is built with Hugo and stored as a DataLad dataset.

  1. With DataLad installed, clone the repository and then enter it:

datalad clone https://hub.trr379.de/q04/docs.trr379.de.git

cd docs.trr379.de

  1. Download all content, including the theme:

datalad get -r .

  1. Start the local preview server:

hugo server

  1. After editing, push your changes:

datalad push

    1. Alternatively:
      Make small edits directly on the collaboration hub.
Note

Once a change has been submitted, it is not reflected on the website immediately. All changes are reviewed and possibly adjusted by members of the Q02 and Q04 teams.

Edit the website

The main TRR379 website is updated on a regular basis. Much of the content, including contributor and publication lists, updates automatically whenever member submit information through the knowledge pooling tool. Website updates should therefore happen through the metadata pooling system wherever possible.

If you would like to report an error, request an update, or start any other discussions related to the website, browse the open issues; if your discussion point is not already listed, please open a new issue.

For those who need to edit the website directly (e.g., to add news items), the site is built with Hugo and stored as a DataLad dataset, meaning all changes are version-controlled. The repository README contains instruction on how to obtain a clone of the website for working on it, and testing it locally.

  1. Clone the repository and then enter it:

datalad clone https://hub.trr379.de/q04/www.trr379.de.git

cd www.trr379.de

  1. Download all content, including the theme:

datalad get -r .

  1. Start the local preview server:

hugo server

  1. After editing, push your changes:

datalad push

Important

Image requirements: All images must be added using DataLad (datalad save -m "message") or git-annex (git annex add <file>), and never with a plain git add. Page thumbnails should be a minimum of 320 by 240 pixels with an aspect ratio of 4:3.

  1. Alternatively:
    Make small edits directly on the collaboration hub.
Note

Once a change has been submitted, it is not reflected on the website immediately. All changes are reviewed and possibly adjusted by the website editor team of the Q04.