CCCHH/ccchh-website
CCCHH/ccchh-website
3
3
Fork 4
Code Issues 5 Pull requests 10 Activity Actions

Improve explanations further
All checks were successful
/ build (pull_request) Successful in 41s
Details

Browse source
This commit is contained in:
Stefan Bethke 2026-06-13 21:49:51 +02:00
commit 6c73476ca6
1 changed files with 14 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -51,11 +51,20 @@ Hugo and the template set distinguish between these two types based on frontmatt
When manually creating content, you need to take extra care to use the correct frontmatter data.
See the link to the Hugo archetypes below for details.
If at all possible, use `hugo new content` with the appropriate parameters to create the new content file correctly.
You should always set these frontmatter fields:
* `categories`: must be either `article` or `event`; see below.
* `date`: the date displayed for this content.
For events, that should be when the event takes place; for blog posts, it is when the post was written.
* `publishDate`: the date and time the content should be published.
Note that the date is evaluated only during site generation, so if you pick a date in the future, it might take up to 24 hours longer before your content appears.
Also note that if you do not specify a `publishDate`, the value of `date` will be used.
* `title`: the headline of your content.
#### Add a Blog Entry
Blog posts (the archetype is called `article`) should be used for information that will be relevant for a longer period, for example explanations about technical, political or cultural topics.
Articles will be shown in chronological order on the [blog main page](https://hamburg.ccc.de/blog/), until newer posts push them down.
Articles will be shown for a few days on the home page, and in chronological order on the [blog main page](https://hamburg.ccc.de/blog/), until newer posts push them down.
In addition, the `tags:` can be used to find blog posts about certain topics.
To create a new general blog post, run a command like this:
@ -64,12 +73,12 @@ hugo new content --kind article blog/yyyy/yyyy-mm-dd-your-article-title/index.md
```
If you want to create a blog post from scratch, or convert an event into a blog post, see the frontmatter data in [themes/ccchh/archetypes/article.md](themes/ccchh/archetypes/article.md).
In particular, you need to set `categories: article` and remove any `date:` or `location:`.
Note that `publishDate:` is fine, as it determines when the content will start appearing on the the site.
In particular, you need to set `categories: article`.
You do not need to specify an explicit `publishDate`, as the value of `date` will be used as a fallback.
#### Add an Event Announcement
Events will be shown on the home page from the frontmatter `publishDate` until the `date:`.
Events will be shown on the home page from the frontmatter `publishDate:` until the `date:` (plus a few hours grace period).
Use them for information that is relevant for a specific event, like a talk or a meeting.
This is not limited to events organized by the CCCHH, but can also be a hint to other events which we think are related to our activities.
@ -80,7 +89,7 @@ hugo new content --kind event blog/yyyy/yyyy-mm-dd-your-event-title/index.md
```
If you want to create an event from scratch, or convert a blog post into an event, see the frontmatter data in [themes/ccchh/archetypes/event.md](themes/ccchh/archetypes/event.md).
In particular, you need to set `categories: event`, `date:` for the date of the event, and `location: Z9` (or whereever your event takes place).
In particular, you need to set `categories: event`, `date:` for the date of the event, `publishDate:` for the date the content should be published, and `location:` to whereever your event takes place.
#### Additional Notes on Events and Articles