Skip to content

Commit 9289c09

Browse files
authored
Merge pull request #266 from nikomatsakis/blog-policy
Document the blog policy
2 parents 0547147 + ab812b9 commit 9289c09

File tree

3 files changed

+97
-0
lines changed

3 files changed

+97
-0
lines changed

src/SUMMARY.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Rust Forge
22

33
[Overview](./README.md)
4+
- [Core](./core/README.md)
5+
- [Rust Blog Guidelines](./core/blogs.md)
46
- [Compiler](./compiler/README.md)
57
- [Bug Fix Procedure](./compiler/bug-fix-procedure.md)
68
- [Cross Compilation](./compiler/cross-compilation/README.md)

src/core/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Core
2+
3+
This section documents policies established by the core team. These
4+
policies tend to apply for "project-wide resources", such as the Rust
5+
blogs.

src/core/blogs.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Rust Blog Guidelines
2+
3+
## Context
4+
5+
The Rust project maintains two blogs. The “main blog” (blog.rust-lang.org) and a “team blog”
6+
(blog.rust-lang.org/inside-rust). This document provides the guidelines for what it takes to write
7+
a post for each of those blogs, as well as how to propose a post and to choose which blog is most
8+
appropriate.
9+
10+
## How to select the right blog: audience
11+
12+
So you want to write a Rust blog post, and you’d like to know which blog you should post it on.
13+
Ultimately, there are three options:
14+
15+
- The main Rust blog
16+
- Suitable when your audience is “all Rust users or potential users”
17+
- Written from an “official position”, even if signed by an individual
18+
- The team Rust blog
19+
- Suitable when your audience is “all Rust contributors or potential contributors”
20+
- Written from an “official position”, even if signed by an individual
21+
- Your own personal blog
22+
- Everything else
23+
24+
There are two key questions to answer in deciding which of these seems right:
25+
26+
- Are you speaking in an “official capacity” or as a “private citizen”?
27+
- Who is the audience for your post?
28+
29+
In general, if you are speaking as a “private citizen”, then you are probably best off writing on
30+
your own personal blog.
31+
32+
If, however, you are writing in an **official capacity**, then one of the Rust blogs would be a
33+
good fit. Note that this doesn’t mean you can’t write as an individual. Plenty of the posts on
34+
Rust’s blog are signed by individuals, and, in fact, that is the preferred option. However, those
35+
posts are typically documenting the official position of a team — a good example is Aaron Turon’s
36+
classic post on [Rust’s language ergonomics
37+
initiative](https://blog.rust-lang.org/2017/03/02/lang-ergonomics.html). Sometimes, the posts are
38+
describing an exciting project, but again in a way that represents the project as a whole (e.g.,
39+
Manish Goregaokar’s report on [Fearless Concurrency in Firefox
40+
Quantum](https://blog.rust-lang.org/2017/11/14/Fearless-Concurrency-In-Firefox-Quantum.html)).
41+
42+
To decide between the main blog and the team blog, the question to ask yourself is **who is the
43+
audience** for your post. Posts on the main blog should be targeting **all** Rust users or
44+
potential users — they tend to be lighter on technical detail, and written without requiring as
45+
much context. Posts on the team blog can assume a lot more context and familiarity with Rust.
46+
47+
## Writing for the Main Rust blog
48+
49+
The core team ultimately decides what to post on the main Rust blog.
50+
51+
Post proposals describing exciting developments from within the Rust org are welcome, as well as
52+
posts that describe exciting applications of Rust. We do not generally do “promotional
53+
cross-posting” with other projects, however.
54+
55+
If you would like to propose a blog post for the main blog, please reach out to a [core team
56+
member](https://www.rust-lang.org/governance/teams/core). It is not suggested to just open PRs
57+
against the main Rust blog that add posts without first discussing it with a core team member.
58+
59+
### Release note blog posts
60+
61+
One special case are the regular release note posts that accompany every Rust release. These are
62+
managed by the release team and go on the main blog.
63+
64+
The blog posts are published on the same day as the release by the same person in the release team
65+
running the release. Releases always happen on Thursdays.
66+
67+
Before publishing a release post, it goes through a drafting process:
68+
69+
1. The milestone (e.g. for [1.39.0]) for the release is consulted.
70+
2. PRs that we think are sufficiently important are included, and some items are headlined.
71+
The writing of a blog post typically happens through a [hackmd](https://hackmd.io/) document.
72+
3. Headlined items are sometimes written by different people, and we try to peer-review each
73+
subsection.
74+
4. The blog post draft is submitted as a PR on the blog repo for final review a few days before the
75+
release.
76+
77+
[1.39.0]: https://github.com/rust-lang/rust/milestone/66?closed=1
78+
79+
## Team Rust blogs
80+
81+
Teams can generally decide for themselves what to write on the team Rust blog.
82+
83+
Typical subjects for team Rust blog posts include:
84+
85+
- New initiatives and calls for participation
86+
- Updates and status reports from ongoing work
87+
- Design notes
88+
89+
To propose a blog post for the team blog of a particular team, reach out to the team lead or some
90+
other team representative.

0 commit comments

Comments
 (0)