forked from q04/docs.trr379.de
48 lines
1.9 KiB
Markdown
48 lines
1.9 KiB
Markdown
---
|
|
title: Contribute to the docs
|
|
weight: 10
|
|
---
|
|
|
|
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](#suggest-improvements) or [editing the docs](#edit-the-docs) directly.
|
|
|
|
The sources for [this documentation]({{% ref "references/services/documentation" %}}) live on the [TRR379 Hub]({{% ref "references/services/collaboration-platform" %}}) at https://hub.trr379.de/q04/docs.trr379.de/src/branch/main.
|
|
|
|
## Suggest improvements
|
|
|
|
Please have a look at the [open issues](https://hub.trr379.de/q04/docs.trr379.de/issues) to see if your question/comment/discussion point has been brought up before.
|
|
If not, please [create a new issue](https://hub.trr379.de/q04/docs.trr379.de/issues/new) for discussion.
|
|
|
|
## Edit the docs
|
|
|
|
The documentation site is built with [Hugo](https://gohugo.io/) and stored as a [DataLad](https://www.datalad.org/) dataset.
|
|
|
|
1. [With DataLad installed](https://www.datalad.org/#install), 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:** {{% expand title="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.
|
|
|
|
{{% /expand %}}
|
|
|
|
{{% notice style="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]({{% ref "/references/resources/projects/q02/" %}}) and [Q04]({{% ref "/references/resources/projects/q04/" %}}) teams.
|
|
{{% /notice %}}
|