doc: update readme and merge in blog author guide #209
Conversation
README.md
Outdated
| - `title` is your news in a short phrase | ||
| (if you're writing a TeraSaturday post, please prefix it with `TeraSaturday #<id>: ` where "\<id\>" is the last TeraSaturday post ID + 1) |
There was a problem hiding this comment.
Worth noting: The title will define the path under which the blog is being published. For the example above this would be: blog/my-first-terasology-blog/, I think.
Observation: we can easily have a duplication in the title, and it is not obvious that there is a uniqueness constraint on it (nor does it make sense, I think). We should think about using the date in combination with the title, for instance.
There was a problem hiding this comment.
Note added.
Also created an issue for the uniqueness topic: #213
| - `cover` should always be `"./cover.jpg"` | ||
| - `description` is a short one or two line summary of your blog post | ||
| - `author` is your name / nickname / alias - we recommend using either your GitHub or Discord name | ||
| - `date` is the date you want your blog post to be published aka. go online (in ISO form: `YYYY-MM-DD`) |
There was a problem hiding this comment.
I'm not sure this still works the same 🤔
Maybe we should also explain that the folder name <date>-<title> is just a convention and has nothing to do with the date and title from the metadata, although those should match...
There was a problem hiding this comment.
Nope, this no longer works - the date is purely cosmetic, it seems 🙄
There was a problem hiding this comment.
Note on the convention added (further above where the directory name is introduced).
Also created #215 to track re-integrating the scheduling feature.
README.md
Outdated
| - `posttype` should always be `blog` (without quotation marks) | ||
| - `title` is your news in a short phrase | ||
| (if you're writing a TeraSaturday post, please prefix it with `TeraSaturday #<id>: ` where "\<id\>" is the last TeraSaturday post ID + 1) | ||
| - `cover` should always be `"./cover.jpg"` |
There was a problem hiding this comment.
We should state the aspect ratio that should be used for the cover images here.
| - `title` is your news in a short phrase | ||
| (if you're writing a TeraSaturday post, please prefix it with `TeraSaturday #<id>: ` where "\<id\>" is the last TeraSaturday post ID + 1) | ||
| - `cover` should always be `"./cover.jpg"` | ||
| - `description` is a short one or two line summary of your blog post |
There was a problem hiding this comment.
I have no idea where this is used, to be honest o.O I thought it might be used for the preview in the tiles, but I think that just uses the first paragraph or something like that 🤔
There was a problem hiding this comment.
Created an issue to track this: #214
Created an issue to track this: #216 |
|
Kudos, SonarCloud Quality Gate passed!
|
docs/blog-documentation.mddocs/blog-documentation.mddocs/blog-documentation.mdtodocs/blog-cover-generation.md