Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit c3ed938

Browse filesBrowse files
authored
Add a newsletter template and document the workflow (rust-gamedev#21)
* Add newsletter-template.md * README: Add a 'Newsletter Creation Workflow' section
1 parent 248888d commit c3ed938
Copy full SHA for c3ed938

File tree

2 files changed

+112
-0
lines changed
Filter options

2 files changed

+112
-0
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+16Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# rust-gamedev.github.io
22

3+
## Newsletter Creation Workflow
4+
5+
* At the beginning of the month, a draft of the newsletter is created
6+
from a [template](./newsletter-template.md).
7+
* During the month PRs with the month's news, meeting notes, etc
8+
are reviewed and merged into the draft.
9+
* All images are supposed to be placed into `assets/newsletter-{index}` dir.
10+
* Check the comments in the draft file.
11+
* At the end of the month, the draft is reviewed as a whole
12+
and polished if needed.
13+
* On the first working day of the next month, the final PR
14+
(that renames and moves the draft file into the `_posts` dir) is sent.
15+
* The link to the newsletter is shared on social networks, etc.
16+
* A small PR that adds links to Reddit, Twitter, etc discussions
17+
(see the comment at the bottom of the draft) is made.
18+
* A new draft for the next month is created from the template, goto 1.
319

420
## License
521

‎newsletter-template.md

Copy file name to clipboard
+96Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
---
2+
title: "This Month in Rust GameDev #{TODO} - {TODO} {TODO}"
3+
---
4+
5+
<!-- Check the post with markdownlint-->
6+
7+
Welcome to the {TODO}th issue of the Rust GameDev Workgroup’s
8+
monthly newsletter.
9+
10+
[Rust] is a systems language pursuing the trifecta:
11+
safety, concurrency, and speed.
12+
These goals are well-aligned with game development.
13+
14+
We hope to build an inviting ecosystem for anyone wishing
15+
to use Rust in their development process!
16+
Want to get involved? [Join the Rust GameDev working group!][join]
17+
18+
[Rust]: https://rust-lang.org
19+
[join]: https://github.com/rust-gamedev/wg#join-the-fun
20+
21+
## News and Blog Posts
22+
23+
<!--
24+
8-12 important news with their own sections.
25+
Ideal section structure is:
26+
27+
```
28+
### [Title]
29+
30+
![image/GIF description](image link)
31+
32+
A paragraph or two with a summary and [useful links].
33+
34+
_Discussions:
35+
[/r/rust](https://reddit.com/r/rust/todo),
36+
[twitter](https://twitter.com/todo/status/123456)_
37+
38+
[Title]: https://first.link
39+
[useful links]: https://other.link
40+
```
41+
42+
If needed, a section can be split into subsections with a "------" delimiter.
43+
-->
44+
45+
### Other News
46+
47+
<!--
48+
Special section for other news (up to 15) in a one-liner format:
49+
- Main link,
50+
- short summary,
51+
- optional discussion links (in square brackets),
52+
- optional small image.
53+
-->
54+
55+
## Popular Workgroup Issues in Github
56+
57+
<!-- Up to 10 links to interesting issues -->
58+
59+
## Meeting Minutes
60+
61+
<!-- Up to 10 most important notes + a link to the full details -->
62+
63+
[See all meeting issues][label_meeting] including full text notes
64+
or [join the next meeting][join].
65+
66+
[label_meeting]: https://github.com/rust-gamedev/wg/issues?q=label%3Ameeting
67+
68+
## Requests for Contribution
69+
70+
<!-- Links to "good first issue"-labels or direct links to specific tasks -->
71+
72+
## Bonus
73+
74+
<!-- Bonus section to make the newsletter more interesting
75+
and highlight events from the past. -->
76+
77+
------
78+
79+
That's all news for today, thanks for reading!
80+
81+
Want something mentioned in the next newsletter?
82+
[Send us a pull request][pr].
83+
84+
Also, subscribe to [@rust_gamedev on Twitter][@rust_gamedev]
85+
or [/r/rust_gamedev subreddit][/r/rust_gamedev] if you want to receive fresh news!
86+
87+
<!--
88+
TODO: Add real links and un-comment once this post is published
89+
**Discussions of this post**:
90+
[/r/rust](TODO),
91+
[twitter](TODO).
92+
-->
93+
94+
[/r/rust_gamedev]: https://reddit.com/r/rust_gamedev
95+
[@rust_gamedev]: https://twitter.com/rust_gamedev
96+
[pr]: https://github.com/rust-gamedev/rust-gamedev.github.io

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.