docs.trr379.de/content/advanced/website-edit/index.md

45 lines
2 KiB
Markdown

---
title: Edit the website
weight: 10
---
The [main TRR379 website]({{% ref "/references/services/main-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]({{% ref "/references/services/knowledge-pooling/" %}}).
**Website updates should therefore happen through the metadata pooling system wherever possible.**
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](https://hub.trr379.de/q04/www.trr379.de#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`
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`
{{% notice style="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.
{{% /notice %}}
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/www.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 the website editor team of the [Q04]({{% ref "/references/resources/projects/q04/" %}}).
{{% /notice %}}