Skip to content

Commit ab812b9

Browse files
committed
Wrap text consistently
Yes, I know about the hobgoblins
1 parent 3c7bddb commit ab812b9

File tree

1 file changed

+39
-17
lines changed

1 file changed

+39
-17
lines changed

src/core/blogs.md

Lines changed: 39 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22

33
## Context
44

5-
The Rust project maintains two blogs. The “main blog” (blog.rust-lang.org) and a “team blog” (blog.rust-lang.org/inside-rust). This document provides the guidelines for what it takes to write a post for each of those blogs, as well as how to propose a post and to choose which blog is most appropriate.
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.
69

710
## How to select the right blog: audience
811

9-
So you want to write a Rust blog post, and you’d like to know which blog you should post it on. Ultimately, there are three options:
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:
1014

1115
- The main Rust blog
1216
- Suitable when your audience is “all Rust users or potential users”
@@ -22,36 +26,53 @@ There are two key questions to answer in deciding which of these seems right:
2226
- Are you speaking in an “official capacity” or as a “private citizen”?
2327
- Who is the audience for your post?
2428

25-
In general, if you are speaking as a “private citizen”, then you are probably best off writing on your own personal blog.
29+
In general, if you are speaking as a “private citizen”, then you are probably best off writing on
30+
your own personal blog.
2631

27-
If, however, you are writing in an **official capacity**, then one of the Rust blogs would be a good fit. Note that this doesn’t mean you can’t write as an individual. Plenty of the posts on Rust’s blog are signed by individuals, and, in fact, that is the preferred option. However, those posts are typically documenting the official position of a team — a good example is Aaron Turon’s classic post on [Rust’s language ergonomics initiative](https://blog.rust-lang.org/2017/03/02/lang-ergonomics.html). Sometimes, the posts are describing an exciting project, but again in a way that represents the project as a whole (e.g., Manish Goregaokar’s report on [Fearless Concurrency in Firefox Quantum](https://blog.rust-lang.org/2017/11/14/Fearless-Concurrency-In-Firefox-Quantum.html)).
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)).
2841

29-
To decide between the main blog and the team blog, the question to ask yourself is **who is the audience** for your post. Posts on the main blog should be targeting **all** Rust users or potential users — they tend to be lighter on technical detail, and written without requiring as much context. Posts on the team blog can assume a lot more context and familiarity with Rust.
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.
3046

3147
## Writing for the Main Rust blog
3248

3349
The core team ultimately decides what to post on the main Rust blog.
3450

35-
Post proposals describing exciting developments from within the Rust org are welcome, as well as posts that describe exciting applications of Rust. We do not generally do “promotional cross-posting” with other projects, however.
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.
3654

37-
If you would like to propose a blog post for the main blog, please reach out to a [core team member](https://www.rust-lang.org/governance/teams/core). It is not suggested to just open PRs against the main Rust blog that add posts without first discussing it with a core team member.
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.
3858

3959
### Release note blog posts
4060

41-
One special case are the regular release note posts that accompany
42-
every Rust release. These are managed by the release team and go on
43-
the main blog.
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.
4463

45-
The blog posts are published on the same day as the release
46-
by the same person in the release team running the release.
47-
Releases always happen on Thursdays.
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.
4866

4967
Before publishing a release post, it goes through a drafting process:
68+
5069
1. The milestone (e.g. for [1.39.0]) for the release is consulted.
5170
2. PRs that we think are sufficiently important are included, and some items are headlined.
52-
The writing of a blog post typically happens through a [hackmd](https://hackmd.io/) document.
53-
3. Headlined items are sometimes written by different people, and we try to peer-review each subsection.
54-
4. The blog post draft is submitted as a PR on the blog repo for final review a few days before the release.
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.
5576

5677
[1.39.0]: https://github.com/rust-lang/rust/milestone/66?closed=1
5778

@@ -65,4 +86,5 @@ Typical subjects for team Rust blog posts include:
6586
- Updates and status reports from ongoing work
6687
- Design notes
6788

68-
To propose a blog post for the team blog of a particular team, reach out to the team lead or some other team representative.
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)