Skip to content

Commit 4e9271f

Browse files
authored
doc: update readme and merge in blog author guide (#209)
- merge former "getting started", "prerequisites", and "development" sections - remove old "contributing section" - merge-in blog post authoring information from former `docs/blog-documentation.md` - remove blog post authoring except cover image generation information from former `docs/blog-documentation.md` - rename former `docs/blog-documentation.md` to `docs/blog-cover-generation.md` - add "communtiy" section with links to social media - slightly adjust readme navigation line
1 parent 83f5f51 commit 4e9271f

3 files changed

Lines changed: 123 additions & 115 deletions

File tree

README.md

Lines changed: 91 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
<h1 align="center">Module Showcase Website</h1>
2-
3-
<h5 align="center">Keeping track of Terasology's modules since 2019.</h5>
1+
<h1 align="center">Terasology Website</h1>
42

53
[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/MovingBlocks/ModuleSite)
64
[![status](https://img.shields.io/badge/status-pre--alpha-red.svg)](https://github.com/MovingBlocks/ModuleSite)
@@ -9,39 +7,111 @@
97

108
---
119

10+
<h3 align="center"><b>
11+
<a href="#community">Community</a> |
12+
<a href="#authoring-blog-posts">Authoring Blog Posts</a> |
13+
<a href="#development">Development</a> |
14+
<a href="#license">License</a>
15+
</b></h3>
16+
17+
This repository contains the codebase of the Terasology website hosted at https://terasology.org/. The website provides easy access to news blog posts and impressions of the game as well as module and contribution information. Terasology and related projects are developed by a group of software enthusiast volunteers under the organization name [MovingBlocks][github movingblocks].
18+
19+
## Community
20+
21+
If you want to get in contact with the **Terasology** community and the whole **MovingBlocks** team, you can easily connect with us, share your ideas, report and solve problems.
22+
We are present in nearly the complete round-up of social networks. Follow/friend us wherever you want, chat with us and tell the world.
23+
24+
&nbsp;
25+
1226
<p align="center">
13-
<a href="#about">About</a>&nbsp;&nbsp;
14-
<a href="#setup">Setup</a>&nbsp;&nbsp;
15-
<a href="#contributing">Contributing</a>
27+
<a title="Discord" href="https://discord.gg/terasology"><img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/discord.svg" width="50" height="50" /></a>
28+
&nbsp;&nbsp;&nbsp;&nbsp;
29+
<a title="Twitter" href="https://twitter.com/Terasology"><img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/twitter.svg" width="50" height="50" /></a>
30+
&nbsp;&nbsp;&nbsp;&nbsp;
31+
<a title="Facebook" href="https://www.facebook.com/Terasology"><img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/facebook.svg" width="50" height="50" /></a>
32+
&nbsp;&nbsp;&nbsp;&nbsp;
33+
<a title="Reddit" href="http://www.reddit.com/r/Terasology"><img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/reddit.svg" width="50" height="50" /></a>
34+
&nbsp;&nbsp;&nbsp;&nbsp;
35+
<a title="Youtube" href="https://www.youtube.com/user/blockmaniaTV"><img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/youtube.svg" width="50" height="50" /></a>
36+
&nbsp;&nbsp;&nbsp;&nbsp;
37+
<a title="Patreon" href="https://www.patreon.com/Terasology"><img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/patreon.svg" width="50" height="50" /></a>
38+
&nbsp;&nbsp;&nbsp;&nbsp;
39+
<a title="GitHub Issues" href="https://github.com/MovingBlocks/movingblocks.github.com/issues"><img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/github.svg" width="50" height="50" /></a>
40+
&nbsp;&nbsp;&nbsp;&nbsp;
41+
<a title="Terasology Forum" href="https://forum.terasology.org"><img src="./static/logos/gooey_gray.png" width="48px"/></a>
1642
</p>
1743

18-
---
1944

20-
<h2 id="about">About The Project</h2>
45+
## Authoring Blog Posts
2146

22-
Terasology’s basic engine can be extended by a huge amount (201 right now!) of modules. Keeping track of them is not the easiest task. This is why this gatsby framework provides an automated generator for a website, listing all of them. This showcase website will increase discoverability by allowing to filter and search for modules by keywords and categories.
47+
Terasology blog posts are authored in [GitHub markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). They typically cover relatively neutral news related to releases, recent contributions or contributor programs; however, we also value your personal project-related opinions, thoughts, and insights.
2348

24-
---
49+
> **⚠️ NOTE:** If you write an opinionated post about your personal experiences and views on Terasology or related topics, please add a disclaimer at the top of your blog post indicating this.
2550
26-
<h2> Getting Started </h2>
51+
All blog posts are stored in the `/blog` directory with a dedicated subdirectory for each of them.
52+
Every blog post directory name consists of the publish date and blog post title: `<date>-<title>`, e.g. `2017-07-14-gsoc-2017-an-overview`
53+
Blog post directory names should not contain non-alphanumeric characters other than dashes (`-`)
2754

28-
The module website development environment can be installed on macOS, Windows, and Linux (Debian or Ubuntu recommended). You’ll need at least 1GB of available RAM.
55+
> **⚠️ NOTE:** The directory name is, on a technical level, not related to the date and title in the blog post metadata. However, we ask you to comply with our convention and ensure that date and title match the blog post metadata.
2956
57+
Blog post directories should always contain a markdown file named `index.md` which will hold the blog post content and metadata.
58+
Additionally, you can provide a cover image in jpg format named `cover.jpg`.
59+
Optionally, any images you want to include into the blog post should be in jpg format and included in the blog post directory.
60+
61+
### Blog Post Template
62+
63+
To allow your blog post to show up properly on the website and search results, you'll need to use the following template in your `index.md`:
64+
65+
```
66+
---
67+
posttype: blog
68+
title: "My first Terasology blog!"
69+
cover: "./cover.jpg"
70+
description: "This blog is about my latest experience with Terasology"
71+
author: "It's me, Mario!"
72+
date: "2023-04-08"
73+
tags: ["Announcement"]
3074
---
3175
32-
## Prerequisites
76+
Hello world, this is my newest blog post for Terasology!
77+
I'm so excited to share this with you!
3378
34-
This website is built with [Gatsby](https://www.gatsbyjs.org/).
35-
The following tools must be installed to build and serve the website locally:
79+
See below the two wonderful screenshots I took.
80+
<div class="row">
81+
<div class="col-md-6"> <img src="./image-1.jpg" width="40%" /> </div>
82+
<div class="col-md-6"> <img src="./image-2.jpg" width="40%" /> </div>
83+
</div>
84+
85+
```
86+
87+
The upper part is metadata that will processed for nicely displaying your blog post on the website.
88+
THe lower part is your blog post content. You'll also see an example of how to include multiple images side-by-side there.
89+
90+
> **⚠️ NOTE:** All the metadata fields are required.
91+
92+
- `posttype` should always be `blog` (without quotation marks)
93+
- `title` is your news in a short phrase and also the path your blog will be published under, e.g. `blog/my-first-terasology-blog`
94+
(if you're writing a TeraSaturday post, please prefix it with `TeraSaturday #<id>: ` where "\<id\>" is the last TeraSaturday post ID + 1)
95+
- `cover` should always be `"./cover.jpg"` and the cover a JPG image with ratio 16:9
96+
- `description` is a short one or two line summary of your blog post
97+
- `author` is your name / nickname / alias - we recommend using either your GitHub or Discord name
98+
- `date` is the date you want your blog post to be published aka. go online (in ISO form: `YYYY-MM-DD`)
99+
(this feature is no longer supported, your blog post will always be visible irrespective of the date you set)
100+
- `tags` should always be an array, multiple values are possible
101+
(please tag TeraSaturday posts with "TeraSaturday")
36102

37-
* [Node.js](https://nodejs.org/en/)
38-
* [Yarn](https://yarnpkg.com/en/)
39103

40-
---
41104

42105
## Development
43106

44-
Make sure that you fulfill the [prerequisites](#prerequisites) for building the website locally
107+
The Terasology website is built with [Gatsby](https://www.gatsbyjs.org/).
108+
A respective development environment can be installed on macOS, Windows, and Linux (Debian or Ubuntu recommended).
109+
You’ll need at least 1GB of available RAM.
110+
111+
Make sure that you install the following tools to be able to build and serve the website locally:
112+
* [Node.js](https://nodejs.org/en/)
113+
* [Yarn](https://yarnpkg.com/en/)
114+
45115

46116
To install all dependencies, run
47117

@@ -83,25 +153,9 @@ To clean up built assets and caches, run
83153
yarn run clean
84154
```
85155

86-
---
87-
88156
> To learn more about the project structure and working of the project please refer to our [docs](docs/project-structure.md).
89157
90-
<h2 id="contributing">Contributing</h2>
91-
92-
To add a new feature or fix a bug follow the steps -
93-
94-
- Make sure your local workspace is up-to-date with the main repository.
95-
- Fetch the latest code `git fetch upstream`
96-
- Checkout to your local master branch `git checkout master`
97-
- Merge changes from `upstream/master` to sync `git merge upstream/master`
98-
- Create a new branch to work on the new feature or bug via the updated master branch `git checkout -b "branch_name"`
99-
- Work on feature/bug and stage all the files to commit it on that branch `git add .` > `git commit -m "Commit Message"`
100-
- Push the branch to your fork `git push -u origin branch_name`
101-
- Create a pull request.
102-
103-
---
104158

105-
## Contributors
159+
## License [![](https://img.shields.io/github/license/MovingBlocks/movingblocks.github.com)](https://opensource.org/licenses/MIT)
106160

107-
A list of contributors can be found [here](https://github.com/MovingBlocks/ModuleSite/graphs/contributors).
161+
The _Terasology website_ is licensed under the [MIT License](https://opensource.org/licenses/MIT).

docs/blog-cover-generation.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
## Generating Blog Post Covers
2+
3+
Generating images for TeraSaturday, TeraSpotlight and custom logo on a image require some extra arguments to be added in frontmatter
4+
5+
For `TeraSaturday` and `TeraSpotlight` blog
6+
7+
```
8+
imageTag: "TeraSaturday"
9+
postNumber: "#15"
10+
mainImage: "./static/images/15.jpg"
11+
```
12+
13+
`imageTag` can be TeraSaturday or TeraSpotlight, any other text will be not valid. `postNumber` is TeraSaturday or TeraSpotlight post number followed by "#" and number. `mainImage` is a path of a background in which blog writter want to overlay the TeraSaturday or TeraSpotlight text
14+
15+
> **⚠️ NOTE:** Their should be a dummy `cover.jpg` image in blog directory so that it can be replaced during generation and also cover image path should be `cover: "./cover.jpg"`.
16+
17+
For custom logo on image
18+
19+
```
20+
imagetag: "Other"
21+
customLogo: "./static/logos/gsoc.png"
22+
mainImage: "./static/images/14.jpg"
23+
position: "end"
24+
```
25+
26+
`imageTag` will be `other` for custom logo on a image, any other text will be not valid. `customLogo` is path of the logo
27+
.`mainImage` is a path of a background in which blog writter want to overlay the logo. `position` can be start, center or end.
28+
29+
After all the above setup for generating images it should be followed by command
30+
``yarn run generate-images`
31+
32+
> **⚠️ NOTE:** For generating images development server should be running on different terimnal

docs/blog-documentation.md

Lines changed: 0 additions & 78 deletions
This file was deleted.

0 commit comments

Comments
 (0)