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

2. Download all content, including the theme:

datalad get -r .

3. Start the local preview server:

hugo server

4. After editing, push your changes:

datalad push

5. 5. Alternatively:
      Make small edits directly on the collaboration hub.

      • The content of all pages can be browsed at https://hub.trr379.de/q04/docs.trr379.de/src/branch/main/content.
      • Each page provides an edit button (pencil icon) that enables editing content directly in the browser.