From 4efb689d93b2b6c55c9a86703aafb33e5bb80831 Mon Sep 17 00:00:00 2001 From: jtbx Date: Wed, 24 Jan 2024 21:29:57 +0100 Subject: [PATCH] Docs: Improve readme --- README.md | 33 +++++++++++++++++++++++++++------ 1 file changed, 27 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 43c8926..8bf8426 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ All other information like details on groups, projects and recurring events shou - start page (onepager) * who we are * announcements aka current blog entry (if in the future) - * visit us -> open chaos + link to wiki for all recurring events * event calendar + * visit us -> open chaos + link to wiki for all recurring events * groups, e.g. CTF team, CMS, freifunk, etc. * directions (map) - blog, split into: @@ -24,7 +24,7 @@ All other information like details on groups, projects and recurring events shou ### Build and Deploy -To populate the calendar data, please run `fetch-calendar.sh` before running hugo. +To populate the calendar data, please run `./fetch-calendar.sh` before running hugo. Running the hugo command without and parameters will re-generate the site in the `public` directory. To deploy the website, just copy the whole folder to a directory which is servered by the webserver of your preference. @@ -47,26 +47,47 @@ hugo server -D #### Add an Event Announcement There are two basic types of posts: Events and articles. -Events will be shown on the home page from their publishing date until they have happened. +Events will be shown on the home page from their publishing date until they have happened and shall be used for things which happen at a certain date. +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. To create a new event blog post, run a command like this: ```shell -hugo new content --kind event blog/your-event-title.md +hugo new content --kind event blog/yyyy/yyyy-mm-dd-your-event-title/index.md ``` #### Add a Blog Entry As mentioned before, you can also create blog posts for things which aren't events. -They will only be shown in the "blog" section and posted to the RSS feeds. +They will only be shown in the "blog" section and posted to the RSS feeds and shall be used for things which are relevant for a longer time. + +As we have much more event announcements than articles, finding articles in all blog posts can be quite a challenge. +But using these two categories enables filtering, so that the history of articles is in one list. To create a new general blog post, run a command like this: ```shell -hugo new content --kind article blog/your-article-title.md +hugo new content --kind article blog/yyyy/yyyy-mm-dd-your-article-title/index.md ``` +#### Additional Notes on Events and Articles + By default the first 70 words are shown as a summary on list pages. Please use `` to manually separate the summary from other post content. +Please prefix your folder name with a date to make browsing the content in the source code easier. +The date in the URL will be taken from the `date` field in the front matter. + +Blog posts from before 2024-01-22 were imported from the previous website and have additional front matter data which is not usually needed (e.g. the lastmod value). +When using the commands above, the template shall have evenything you need. + +#### Populate the Event Calendar + +The event calendar table is filled from the Nextcloud iCal feed. +To add a link on the title text, just add some link to the event's description field. +The first link (something starting with `https://` or `http://`) from anywhere in the text will be taken. + +(iCal has a link attribute, but that is not supported by the Nextcloud web UI. So we use the description instead.) + + ### Icons You can use solid and brand icons from https://fontawesome.com/icons version 6 in your posts like this: