RE: Kickstarting the documentation authoring effort


Just go ahead to rename the repository, and let me know once it is finished and I will sync up.


-----Original Message-----
From: Tobie Langel [] 
Sent: Wednesday, June 05, 2013 1:33 AM
To: public-test-infra; HU, BIN
Cc: Marcos Caceres; James Graham
Subject: Re: Kickstarting the documentation authoring effort

James rightfully pointed out that TTWF doesn't only mean Test the Web Forward (see urban dictionary). irrc, this is the reason why #testtwf was chosen as a twitter hashtag instead of #ttwf. 

The docs prefix is also a little silly given we'll be covering more than that in the repository.

I'll rename the repository to testtwf-website shortly.

As I know Bin is working on stuff at present, I'll wait for his go-ahead to do so, as renaming might break stuff.

Sorry for the inconvenience.


On Thursday, May 30, 2013 at 6:42 PM, Tobie Langel wrote:

> Hi folks, 
> I've set up a GitHub repository[1] to get started on the doc authoring effort.
> The goal of the effort is to have all our cross-WG documentation needs for testing stored in one place, easily editable by the community.
> In order to do this we need to centralize, update and improve existing documentation, and author new content when existing resources are lacking.
> To kickstart this project, the Resource Center TF has helped gather a list of existing related docs[2] along with a second list of docs that need to be written. I converted the latter into GitHub issues[3]. Bin Hu's been assigned most of the work here (he volunteered), but I'm sure he'll appreciate your help. Please sync up on the issues directly if you want to pick up some work. Generally, that'll imply looking at the existing docs[2] to find relevant content, using an online service[4] to convert it to markdown, copyediting it, adding YAML front-matter to it[5], and sending a pull request. More info in our contributors' guide[6].
> Note that we choose to go with Markdown files and a static site generator (Jekyll). This it has the advantages of being a highly portable solution and to be really well integrated with GitHhub making deployment and hosting trivial. (Don't worry, we'll still have our own domain name).
> Initially the project will happen in two phases[7]:
> 1) we'll get the basic documentation ready for launch along with layout and design (more on the latter more in a follow-up email), and,
> 2) where appropriate, we'll remove/redirect/amend exiting content to make sure all content points to the new canonical source.
> We'll work iteratively thereafter.
> Happy to answer questions.
> Best,
> --tobie
> ---
> [1]:

> [2]:

> [3]:

> [4]:

> [5]:

> [6]:

> [7]:

Received on Wednesday, 5 June 2013 13:51:40 UTC