Skip to content
This repository has been archived by the owner on Sep 24, 2022. It is now read-only.

RFC-011: news announcements #29

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
165 changes: 165 additions & 0 deletions Accepted-RFCs/RFC-011-news-announcements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
# RFC-011: News & announcements on site

## Proposed by

Ryan Macklin ([@macklin](https://thegooddocs.slack.com/team/U01DYRWG43X))

Initially submitted on 24 Aug 2022

## Current status

- [x] Draft
- [x] Under discussion
- [ ] Final comment and voting (until YYYY-MM-DD) {{Add date after selecting this status.}}
- [ ] Accepted
- [ ] Rejected
- [ ] Implemented
- [ ] Deferred
- [ ] Withdrawn

## Proposal overview

We could use a place on our site where we announce news about the project as warranted. This has been talked about a bit over the last year, as part of blog conversations, then social media conversations, and some content strategy conversations. So here's a RFC that's about how we can approach it.

## Motivation

We could use a place where we host announcements about the project. For instance, we want to get more people from EMEA into our Community Docs working group. There was a comment about announcing that on Twitter. It would be great if there was a link to a page on the site about it—one that is temporally relevant about this initiative, beyond just linking to a general working group page.

## Organizational dependency: Content Strategy

This is ultimately intertwined with Content Strategy (and related social media efforts), and needs to be intentionally a part of that. Thus, at the time of drafting this RFC, it's a placeholder that needs the Content Strategy team to vet and determine various elements before it fully goes to the PSC for debate and approval.

## Proposal

We have a place on the site, such as thegooddocsproject.dev/news, that holds our news posts. We'd use a format *similar to* but not the same as the blog—similar because unified branding is important, but not the same so as to differentiate the content appearance.

[That gets into defining what our unified visual branding *is*. Which is a conversation beyond the scope of this RFC.]

We'd use the same system for publishing news posts as blog posts: pushing a markdown file to a folder, and the Hugo site handling the rendering of changes.

### Types of content

The news site would handle two types of content: announcements and heartbeats.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with these types of content.


Announcements are straightforward: they're announcements from our community to the wider interested-in-documentation community (whether other tech writers, developers interested in docs, or whoever else subscribes to us). This could be calls to action (such as recruitment or activity drive), or community celebration (such as talking up a GDP member speaking elsewhere).

Heartbeats are periodic posts where we talk about the states of different working groups, as relevant to our wider audience of users or prospective contributors. These would be ideally no more than every two or three months, and drafted from a perspective of PR to keep showing in between release cycles that we're passionate about our work.

Heartbeats could also possibly showcase an individual contributor, like a "meet the team" sort of vibe. This has been declined as a blog post topic, as that doesn't fit the purpose of the blog, but it could fit here at the tail end of heartbeat posts.

(That also gives those individual contributors featured a different sort of call to action on publicizing their related post, as friends/colleagues of that contributor may be interest in the post for relationship reasons, then find the other content or project in general interesting enough to follow on its own.)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love the social engineering aspect hehe.


#### What this isn't

This wouldn't be a place for internal communications, meeting notes, etc.

This also wouldn't be a "second blog" or similar.

### Why not use the blog?

The blog is about "docs advocacy & education," so if peopple subscribe to the blog/look out for new posts, they should expect material that's education, not that's purely about our group marketing.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The blog is about "docs advocacy & education," so if peopple subscribe to the blog/look out for new posts, they should expect material that's education, not that's purely about our group marketing.
The blog is about "docs advocacy & education," so if people subscribe to the blog/look out for new posts, they should expect material that's education, not that's purely about our group marketing.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

100% agree with this.


The other elements of the blog, like its particular formatting/visual branding, focus on author, everything about CC licensing, etc. do not and should not apply to this content bucket.

### Specifics

The main page should show the most recent post, so when one clicks on "News" in the header, they don't have to click on a second link to see what's the most recent.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with this sort of implementation.
For reference, this is how our implementation could look like:
image
You can check it out at Netdata Documentation


The sidebar would have the most recent 5 or so posts, with a "see all" that would just show a list with short versions, akin to what is seen in the [Write the Docs newsletter archive page](https://www.writethedocs.org/blog/archive/tag/newsletter/).

The posts should be short: 500 words or so. Something that would take on average less than 5 minutes to read. We may deviate from this as needed, but the core concept is that our newsletters shouldn't take significant resources to craft and review, and we shouldn't demand significant time expenses from our audience in this manner.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm starting to think of a micro-blogging format, or something with a significantly reduced character count. Like the newest Tweet length (280 chars) on Twitter. Enough to give a quick update about something and then link to more information, etc. One advantage of using a shorter char count would be the ability to take the syndication feed from these posts and automatically send them out to channels on Twitter, Facebook, etc., without rewriting them to fit.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like it to not be that stringent. If the news has needs beyond micro-blogging, like (and hopefully this never happens) a public apology for a key member's conduct, we should make sure we can support that.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think it need some kind of hard coded limit, but I would think that the use of this 'news' stream is for small, quick 'pings' of information from the team to remind people we are doing things and bring them up to speed. If we go over 280 chars, the content cannot be 'retweeted' so to speak without a bit of manual rewrite or truncation.


Unlike how we handle the blog, authors wouldn't link to "about the author" pages as we do in the blog—and in fact we may decide there are no listed individual authors, to keep the news to appear to always be from the community.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This follows, I don't think there's a compelling reason to attach authors to these items, and them coming from the "community at large" has some benefits.


Unlike how we handle the blog, there wouldn't be any commenting feature.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we can add some buttons to make it easy for people to share the posts on their own social media channels as needed.


Unlike how we handle the blog, there wouldn't be any banner or hero images.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm thinking of something small like twitter cards for the layout.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One thing to consider: we could have a V1 and V2 plan, with the V2 being "fancier" as we end up feeling out this in practice, and V1 being what the CS team feel comfortable with when the new site is launched

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One of the drafts I've seen from CS (seen today) has Twitter on the sidebar, so we might not want to use the same layout for two different elements. Though there are plenty of ways to implement "Twitter-like" that looks significantly different.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the styles can be different, while conceptually the same. Small bits of information to inform viewers of project activities. With some clear visual separation from one to another.


Because news is timely, the individual post URLs would use the date rather than a title.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would not allow more than 1 post a day, unless we also add the time to the url. We could just generate an ISO datetime string for the slug. ISO datetime would probably be easiest and would provide some information in the string that would mean something about when the post was created.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point!
Ideally we don't want more than one news post a day, but to my earlier point about the potential need for a public apology (or something like an emergency rollback or whatever, should we for some reason need that—like if we get into doc tooling), we should make sure we can support multiple posts per day.

Better to support and never need than kick ourselves for not having it, right? As long as it doesn't turn into overengineering. (I'm okay to engineer for contingencies we need to support as the org grows, as long as they're reasonable to consider, and it's less costly to implement them now than later.)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have to name the files something, might as well be a date/time code if we aren't using text slugs.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's probably other valid reasons for multiple posts per day, e.g. what we're doing/have done during WTD conferences. I'd argue that just appending a "-2" or similar would be sufficient, but using a timestamp works too.


### Why not use the blog?

Two reasons: First, it would split the purpose and publishing resources of the blog. The blog's purpose is supporting docs advocacy and education.

Second, while the framework might be similar, it isn't exactly the same. So we can reuse a lot of the work on the blog, but it has different content needs.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see a different 'content type' for the markdown files, and new layouts for this section of the site. Something like a 'twitter feed' with a card for each one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Totally. I'll leave the markdown implementation as a post-RFC phase, since I'm sure like with the blog, we'll discover nuances as we build it out. But I'm def picking up what you're putting down.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could also all be stored in a structured JSON data file, with a nice little editor for each entry in the file.


### "Creating" the News Team

The team that would handle this would be the "News team," and essentially be our PR team. But functionally, that doesn't end up being a new team, as we already have a de facto PR team between those who run our social media (namely Felicity and Carrie), people planning Content Strategy, and the co-chairs.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 on Alyssa's comments here.


This team would just be a formalization of who vets news posts before going on, to make sure news is on message. The ideal people for this are journalism and communication studies nerds. We happen to already be well stocked in that regard. :)

### Forward facing: emailing newsletters

If we want to get to a point of having a mailing list to keep our users informed, this is the content we'd use. And by having two categories, people could opt into different types of content. However, that isn't a requirement to execute on this idea.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be easy to create a 'filtered' set of posts from this data/file set for automated collection of updates in a newsletter.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could also and probably should syndicate this to an RSS/Atom feed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the time cost of that? And does the time cost change if we decide that's a "1.1" version of news?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't much more time or effort, much easier than setting up a new content section and layouts for the website.


## Consequences

This allows us a space to write about upcoming changes for users to experiment with (such as if we start playing in the space of having "dev branches"), announcements for recruiting, celebrating our contributors' efforts elsewhere (like announcing them being Write the Docs speakers), and upcoming meetups (like holding writing days at Write the Docs).

This would be an additional effort set for the Tech Team, to take the blog and tweak it for another subfolder. That might involve refactoring material to be shared, or not—details on the code execution part of this effort is beyond the scope of the RFC, barring noting any concerns, issues, or plans that the Tech Team might share upon reviewing this.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding a new content type section or data file would be fairly simple, and making new layouts for the pages and content is fairly straightforward.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yay! I figured that was the case, since my initial experience with Hugo working on the blog with you. I'm very thankful you commented to confirm that! :D


This could also play into future endeavors as we potentially expand, such as announcing Good Docs-hosted talks (which are themselves ways of passive recruiting).

And this would be some additional ongoing effort on the part of the News team, though the effort should be light, and the payoff for that effort well worth it.

## Links and prior art

[How Write the Docs does their newsletters](https://www.writethedocs.org/blog/archive/tag/newsletter/), which as an index page feels like it works as email-delivered newsletters first, site-formatted news second.

## Open questions

{This section is optional and is where you can list questions that won't be resolved by this RFC, including those raised in comments from community members.}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would this be text/links only, or allow for media assets like images, videos, embeds, etc.?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's assume embeds, and have some guidelines for what those embeds should look like/size of them/etc.

But turning that around: what logistics do we need to consider on the tech side for that? (I believe I know, but I'd rather get specifics from you than silently assume)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some built in Hugo shortcodes that could come in handy here. https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcodes


## Decisions deferred
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel like the first three bullet points below are in fact the "next steps" rather than "deferred decisions." It's an arbitrary distinction, but these are things that need to be addressed in order to take the implementation described in an approved RFC into production.


* Code execution (beyond anything the Tech Team wishes included in this proposal, as notes or requirements)
* News team composition
* Content moderation policies
* Future news efforts (like mailing lists)

## Feedback

{If you accept feedback from a community member, you will incorporate it into your RFC before it is accepted.
If you reject feedback, note that rejected feedback here before resolving the conversation.}

## Organizational dependencies

* Content strategy in involved in such decisions & nuance
* The tech team would be involved in implementation

## Implementation checklist

If this proposal is accepted, the following tasks must be completed:

- [ ] Set up the site folder
- [ ] Document process for posting
- [ ] Document the subsite's purpose and content guidelines

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Define a new 'content type' that would have the necessary data structure for this kind of information object.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll make a task category of "technical implementations" and add this (and move "set up folder" etc.) in that. And make "Create process" as a task category.


## Votes

Votes as per our [decision process](https://thegooddocsproject.dev/decisions/):

Project steering committee (listed alphabetically by first name):

- Aaron Peters:
- Alyssa Rock:
- Ankita Tripathi:
- Bryan Klein:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

- Cameron Shorter:
- Carrie Crowe:
- Erin McKean:
- Deanna Thompson:
- Felicity Brand:
- Gayathri Krishnaswamy:
- Morgan Craft:
- Nelson Guya:
- Ryan Macklin:
- Tina Lüdtke:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1



Community members who voted (non-binding):

- {Your name}: {Your vote}