Better explain content types #165
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "explain-content-types"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
You can view your changes at https://staging.hamburg.ccc.de/pr165/
Inhalt ist OK, aber bitte nur einen Satz pro Zeile
@ -47,0 +55,4 @@#### Add a Blog EntryBlog 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.Not 100% correct. They will be shows for some days since we don't want to clutter the front page with "old" blog posts. If people are interested in all posts they should use an RSS reader.
@ -47,0 +64,4 @@```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:`.Wrong:
datealways needs to be there.publishDatecan (and should) be omitted on articles.@ -47,0 +65,4 @@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.I don't see a use case for a separate publish date on blog posts. We can still schedule them by using the
datefield, but why should there be a different publication date from the date that's shown in the post?@ -48,3 +71,2 @@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 and shall be used for things which happen at a certain date.Events will be shown on the home page from the frontmatter `publishDate` until the `date:`.Not 100% correct, they will also be shown up to 6 hours after the
dateso that events that are currently running are still present on the home page.This time frame was enough for the usual event we host which last an evening.
@ -68,2 +82,2 @@hugo new content --kind article blog/yyyy/yyyy-mm-dd-your-article-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).Events should also have a
publishDatesince the post should usually be published before the event is happening.@ -47,0 +50,4 @@Hugo and the template set distinguish between these two types based on frontmatter information.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.nit-pick: I would put this line in a separate paragraph so that it stands out. And maybe even make it also bold.
Because the easiest and least error-prone way to add new content is to use the Hugo command.
just some editorial comments
@ -47,0 +56,4 @@* `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.I don't understand what this sentence should tell me, especially with the explicit time of "24 hours longer".
When a publish date is set, the post will be visible on the deployed site at this date and time (or up to 20 minutes later in the worst case, because the deployment only runs every 20 minutes).
The deployed pull request however will also show posts which are in the future.
So I would rather say something like this:
I thought auto deploy only runs once a day. If it's running multiple times each hour, there is no need to explain this in more detail. I'll add more explanation to the preview section.
@ -47,0 +64,4 @@#### Add a Blog EntryBlog 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, and in chronological order on the [blog main page](https://hamburg.ccc.de/blog/), until newer posts push them down.nit-pick: no comma before the "and" (because an Oxford comma is only used for lists with at least 3 items AFAIK).
And it's not really clear if the last phrase "until newer posts push them down" applies to the home page or the blog page.
dca8a2afb4d0785aaa81I allowed myself to add some line breaks between sentences (only affects the markdown source, but not the HTML output) and squash everything into one commit.