Skip to content

Commit e9bc7d4

Browse files
committed
Update contributing guide for newsletter
1 parent af27b53 commit e9bc7d4

File tree

1 file changed

+63
-30
lines changed

1 file changed

+63
-30
lines changed

contribute/newsletter.md

Lines changed: 63 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,79 @@
1-
# Monthly blog newsletter
1+
# Guide to the monthly newsletter
22

3-
Once a month we send a newsletter to our mailing list summarizing the most important topics in the blog. This gives people a higher-signal place to find out what we've been up to.
3+
This is a guide to creating the monthly 2i2c community update. We frame this update as a "dispatch": a short, proactive, and curated update on our most important work. It should not be exhaustive - only cover the most important points.
44

5-
Here's the rough structure that our newsletter should follow:
5+
## Guiding principles
66

7-
```
8-
# [Most important benefit, outcome, or takeaway for readers] | 2i2c [Month Year] Community Update
7+
Our goal is to **be transparent**, **demonstrate expertise**, and **demonstrate impact** with our community by proactively sharing our work. Here are some guiding principles we follow:
98

10-
[Intro]
11-
[1-2 sentences: what it is + why it matters, in plain language, conversational tone]
12-
In [Month] we focused on [big theme that stands out and major takeaways]. We [accomplishment with link], [accomplishment with link], and [accomplishment with link]. Here's what stood out:
13-
[/Intro]
9+
* **Mission-driven:** We are a non-profit, not a SaaS company. Our updates reflect this "partnership" model. We celebrate sustainability (like new members) as a community win.
10+
* **Blog-first:** Our blog is the content engine. We write individual posts there first. The monthly email *curates and distributes* this content; it doesn't create new content from scratch.
11+
* **Human-centered:** Use a personal, direct voice (e.g., `From: Chris from 2i2c`).
12+
* **Utility-focused:** Be useful and scannable. Respect our reader's time.
13+
* **Consistent:** A "good enough" update sent on schedule is better than a "perfect" one sent late. This and our blog are our community "heartbeat."
1414

15-
[Highlights]
16-
## [Category]
15+
## Monthly workflow
1716

18-
### [Title of Featured Post in category (1-3 total)]
17+
Follow this to create the newsletter each month.
1918

20-
[Description - 1-3 sentences describing what happened, why it matters, and any important information a user would want to know.]
19+
### Curate
2120

22-
[IF image]
21+
* Gather all blog posts from the last 30 days.
22+
* Define the **Monthly Theme** in one sentence (e.g., "This month was all about sustainability.").
23+
* Select the **"Lead Story"** (our biggest win).
24+
* Select 2-4 **"Featured Stories"** that map to our [core value proposition](https://compass.2i2c.org/organization/value-proposition/) and [strategy](https://compass.2i2c.org/organization/strategy/). Here are a few key areas, each with their own `category:` in blog metadata:
25+
* **Community Impact:** (e.g., A research group's success, a great workshop).
26+
* **Upstream Impact:** (e.g., A fix for Jupyter, a Binder report).
27+
* **Service Enhancements:** (e.g., A new hub feature, a support story).
28+
* **Organization Updates:** (e.g., major new announcements or updates on our strategy).
29+
* Find a **"Community Spotlight"** (e.g., a new contributor to thank).
30+
31+
### Write the newsletter
32+
33+
* Use [the template in the next section](#template) to write the full email.
34+
* Review to make sure it makes sense as a holistic newsletter.
35+
36+
### Send
37+
38+
* Send the email to our mailing list via [MailChimp](https://compass.2i2c.org/marketing/mailinglist/).
39+
* Copy the campaign from the previous month
40+
* Update the **Subject** and **Content** with the newsletter we just wrote.
41+
42+
## Template
43+
44+
*This is the short, 300-500 word email for our mailing list.*
45+
46+
**From:** `Chris from 2i2c`
47+
**Title:** `[2i2c Update] <A brief, specific hook, e.g., "Our first premier member & a 400-person NASA workshop">`
48+
49+
*[Intro summary. Example: "October was a milestone month for us in building out our new membership model towards organizational sustainability. We’ve spent the last few months designing the basic structure of membership, and this month welcome our first premier member: the Berkeley Institute for Data Science! We think this is a key foundational step towards refining and building out this member network. Along the way, we’ve been hard at work to highlight all the work our community members and collaborators are doing. Check out a few highlights from last month below from our blog.”]*
50+
51+
### [Lead story headline, e.g., "BIDS Joins as Our First Premier Member"]
52+
53+
*[1-2 sentence teaser for the lead story.]*
54+
55+
[**Read the full announcement**](https://www.google.com/search?q=link-to-individual-blog-post)
56+
57+
[feature image from blog post, example below.]
2358
<figure>
24-
<img src="[src]" alt="[one-sentence description]">
25-
<figcaption>[one or two sentences explaining the figure]</figcaption>
59+
<img src="[featured_image_url]" alt="[description]">
60+
<figcaption>[1-2 sentences explaining the figure]</figcaption>
2661
</figure>
27-
[/IF]
2862

29-
Read more 👉 [url-without-https://](url)
63+
### This Month's Highlights
64+
65+
[A list of highlights taken from blog posts. Use the `category:` to categorize each and add a label before each list item. See below for example:]
66+
67+
* **Community Impact:** [1-2 sentence teaser for a community story...] [**Read more**](https://www.google.com/search?q=link-to-post)
68+
* **Upstream Impact:** [1-2 sentence teaser for an open-source contribution...] [**Read more**](https://www.google.com/search?q=link-to-post)
69+
* **Service Enhancement:** [1-2 sentence teaser for a new feature or infrastructure update...] [**Read more**](https://www.google.com/search?q=link-to-post)
3070

31-
## [Title of Featured Post N+1 etc]
32-
[/Highlights]
71+
### Community spotlights
3372

34-
[Community]
35-
## From the community
73+
*[A bulleted list of 1-2 sentence "Thank You"s to a new contributor, a partner, or a great forum question. Or updates from communities we've blogged about. This makes the communities feel seen, signal-boosted, and appreciated.]*
3674

37-
- [community] did [thing with link to their post]
38-
- [open source project] released [link to release of version NN]
39-
[/Community]
40-
---
75+
Thanks for being a part of the 2i2c community,
4176

42-
_Here's a list of all the blog posts we published in [Month Year]._
77+
— Chris and the 2i2c Team
4378

44-
- [MMM, DD YYYY] - [post name](link)
45-
- [MMM, DD YYYY] - [post name](link)
46-
- [reverse chronologically ordered for all posts]
79+
*P.S. For more updates and to see all of our posts, visit [our blog](https://2i2c.org/blog).*

0 commit comments

Comments
 (0)