diff --git a/README.md b/README.md index 6a0fe10..666a785 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,8 @@ To build the website and run a development webserver, execute: hugo server --buildFuture --buildDrafts ``` -Note: the flags `--buildFuture --buildDrafts` makes Hugo process all content, even if the `publishDate` is still in the future, or the content is marked as `draft: true` in the frontmatter. You usually want these flags, especially if you are preparing content that should only be shown after a certain date. +Note: the flags `--buildFuture --buildDrafts` makes Hugo process all content, even if the `publishDate` is still in the future, or the content is marked as `draft: true` in the frontmatter. +You usually want these flags, especially if you are preparing content that should only be shown after a certain date. Also see [Submitting Your Content](#submitting-your-content) below. @@ -63,7 +64,8 @@ You should always set these frontmatter fields: #### 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 for a few days on the home page. The [blog page](https://hamburg.ccc.de/blog/) shows all posts, newest first. +Articles will be shown for a few days on the home page. +The [blog page](https://hamburg.ccc.de/blog/) shows all posts, newest first. 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: @@ -102,15 +104,20 @@ Blog posts from before 2024-01-22 were imported from the previous website and ha #### Submitting Your Content -After creating the new content, or making changes to existing content, please commit your changes with a meaningful commit message to a fresh branch. Name the branch in a way that makes it easy to understand what the changes are, for example, the title of your new blog post. +After creating the new content, or making changes to existing content please commit your changes with a meaningful commit message to a fresh branch. +Name the branch in a way that makes it easy to understand what the changes are, for example, the title of your new blog post. -Push the branch to git.hamburg.ccc.de, and create a new pull request. Invite reviewers, or post the link to the PR to the [#infrastruktur:hamburg.ccc.de](https://matrix.to/#/#infrastruktur:hamburg.ccc.de) Matrix channel. +Push the branch to git.hamburg.ccc.de, and create a new pull request. +Invite reviewers, or post the link to the PR to the [#infrastruktur:hamburg.ccc.de](https://matrix.to/#/#infrastruktur:hamburg.ccc.de) Matrix channel. -The changes you have made will be deployed to the staging website automatically (this might take a minute or two). See the comments in the PR for the link to your preview. You and the reviewers can use the link to preview the changes. +The changes you have made will be deployed to the staging website automatically (this might take a minute or two). +See the comments in the PR for the link to your preview. +You and the reviewers can use the link to preview the changes. If you have set a `publishDate` to a date and time in the future, the preview will show the content as it would appear then. -Once at least one reviewer approves the PR, it will be merged and pushed to production. This usually takes less than five minutes. +Once at least one reviewer approves the PR, it will be merged and pushed to production. +This usually takes less than five minutes. #### Populate the Event Calendar