Work out what information is stored where and reconcile as appropriate

[ineffyble]

From my understanding, we're storing the following information:

What	Where	Notes	Example factoid
Issues, tasks, feature requests	GitHub issues, GitHub projects	Stored across many repos, also managed with Huboard	There is a race-condition bug present in the admin service.
Public-facing generic info	rabblerouser.team		You can get a Rabble Rouser slack invite by emailing [email protected]
Blog posts(?)	rabblerouser.team	Only seems to be one	We tried weekly hack nights
Product-level documentation	GitHub wiki attached to docs repo	Not actually stored in repo... mostly	Rabble Rouser uses event streaming
Repo-level documentation	Files within various repos, possibly GitHub wikis on various repos?		The mailer won't work until you free yourself from the AWS SES sandbox

We should look at how we can have less sources of info, and a clear delineation between them.

Things to think about/options to look at:

• Once our public site (rabblerouser.team) is a static site being generated from Markdown in git, do we want to potentially merge our product-level documentation in to the same site?
• If not, do we want to keep GitHub Wiki, or look at a docs site generated from Markdown with something like mkdocs?
• Do we want blog posts ongoing?
• How in-depth should the docs in a particular repo be - should they be tech/dev focused, and user manuals sit elsewhere? Do we have any type of user manual? Do we potentially want to automatically pull in markdown docs from our various repos and compile them into a single site/source?

[camjackson]

This is awesome @ineffyble, thanks for enumerating all the places we have this info.

In my mind, when it comes to all this kind of stuff, there's a fairly clean division between info that's relevant to (potential) end users and (potential) contributors.

For end-user info, that seems like it belongs on rabblerouser.team. I wouldn't usually expect these people to end up on github for anything. Of course, the source code for the website might be on github, but end users shouldn't know that.

For contributor info, I can totally see there being a page on rabblerouser.team which is like /contribute or something. The question for me would then be whether we host technical docs right there, or whether that just says 'click here' and takes people directly the README files on github, or a github pages site, or something else.

So that's kind of my thoughts from a consumption point of view. From an authoring/maintenance point of view, I totally agree with your point that we should have less sources of info. It's too hard to keep track of what's where right now.

[ineffyble]

Chat with @tomsulston covered concept of a "public site for users" (which would likely be rabblerouser.cc) and a "site for contributors" (which is the current rabblerouser.team).