Audit of online documentation for Livepeer

[chrishobcroft]

Currently we have the following repositories of content for Livepeer:

• readthedocs
• wiki
• forum
• github
• livepeer.org
• livepeercommunity.org

It is unclear to me the distinct purpose of each of these repositories, and what content belongs where.

This issue proposes an audit of what content currently lives where (the "as is"), in order to inform some decision making about what content should live where (the "to be").

[dob]

Here's my take on the purpose of these platforms:

ReadTheDocs - official developer focused documentation for the Livepeer node. How to run the node to broadcast, to transcode, what the command line options means, how to run private networks, test networks, how to run local eth node vs remote node, etc. Needs to be maintained actively.

Wiki - Open community wiki for any reference content that needs to be maintained and updated and serve as a source of truth. Anyone can create a page on the wiki to share anything. The content can be formatted, linked to, and updated. It doesn't need to be official documentation. The SPEC and the FAQ are great examples. Content is likely not meant to solicit feedback or spur a discussion - if so it may better belong in the forum.

Forum - Discussion threads. Q&A. This is content that is likely temporal in nature and will likely be responded to with questions or suggestions. It is not necessarily maintained over time, so if the content is a tutorial that needs to be kept up to date, then put it on the wiki, since there's no expectation anyone go back and update their forum post.

Github - The code. README's for the code and development of a particular repo or project, but not necessarily for the product. For example, ReadTheDocs is how to use the node as a product, with documentation for all the features. The README may contain a little overlap, but largely should focus on how to develop the node.

Livepeer.org - web site for the project. I think we know what this is.

livepeercommunity.org - experimental content homepage for the livepeer community node. It's whatever the community wants it to be!

reddit - I actually think that this could be a great entrypoint for mainstream community members who want to engage in and discuss things around the project. But it would require us to actually participate actively by submitting content and engaging in discussion. And I don't think it's a priority to force this if no one here is doing it organically.

I think the most overlap/ambiguity is likely to come between ReadTheDocs and the Wiki. What is an example of a piece of content that someone is not sure what the proper home is?

[dob]

Closing this as out of date and non-actionable at the moment. Can revisit docs when productizing for scaled video developers.