Convert internals guide to markdown The NetBSD Project
Status: Closed Time to complete: 96 hrs Mentors: Iain Hibbert, Julian Coleman, Julian Fagir Tags: wiki

NetBSD has its internals guide: http://netbsd.org/docs/internals/en/index.html

It is currently written in Docbook, but we want it in the wiki. You can find its sources here: http://cvsweb.netbsd.org/bsdweb.cgi/htdocs/docs/internals/en/?only_with_tag=MAIN (only the XML files, the HTML files are just generated from that!).

Though this work could also partially be done by a tool like pandoc, there might be great difficulties, especially in embedding images. You could automatically convert the articles and then review the results by hand to be correctly converted.

For this task, we want you to create a wiki page in our wiki on http://komkon2.de/nbwiki/

We need your e-mail address and a username to create an account for you in our wiki, such that you can work on the task.

Uploaded Work
File name/URL File size Date submitted
http://komkon2.de/nbwiki/doku.php?id=netbs... n/a December 06 2012 04:56 UTC
https://github.com/mikhail-j/xml2md n/a December 06 2012 04:58 UTC
https://github.com/mikhail-j/gci2012-13/tr... n/a December 06 2012 05:31 UTC
internals_netbsd.zip 190.1 KB December 06 2012 22:49 UTC
Comments
John Grosen on December 2 2012 18:50 UTC Task Claimed

I would like to work on this task.

Aleksej Saushev on December 2 2012 19:26 UTC Task Assigned

This task has been assigned to John Grosen. You have 96 hours to complete this task, good luck!

John Grosen on December 2 2012 19:50 UTC Claim Removed

The claim on this task has been removed, someone else can claim it now.

John Grosen on December 2 2012 19:50 UTC Reason behind claim removing

I was recommended against this task in the IRC channel.

Michael Jin on December 4 2012 01:28 UTC Task Claimed

I would like to work on this task.

Michael Jin on December 4 2012 03:34 UTC I will start this task in the afternoon.

During the day, I have school to attend.

Aleksej Saushev on December 4 2012 04:39 UTC Task Assigned

This task has been assigned to Michael Jin. You have 96 hours to complete this task, good luck!

Michael Jin on December 6 2012 05:31 UTC Ready for review

The work on this task is ready to be reviewed.

Iain Hibbert on December 6 2012 12:18 UTC nice

Hi


this looks very nice, thank you!


my only concern is with the xref links.. I dont see how you did them with your script, did you do them manually? They currently point back to the copy on the www.netbsd.org server which is probably ok, since that is where the document would be hosted.. also, I don't think you should worry too much about section numbers in the markdown, since these are subject to change


so I don't think these links should be hard-coded in the markdown though for the purposes of the code-in, that might be acceptable.. is there a better way to do references to other parts of the document itself?

Aleksej Saushev on December 6 2012 13:10 UTC External references

Please, upload all files that constitute your work relevant to this task. You can upload tar or zip archive, if necessary.

Aleksej Saushev on December 6 2012 13:10 UTC Task Needs More Work

One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.

Michael Jin on December 6 2012 22:48 UTC references

I had to add each link by hand. Referencing another section in the document is possible, but it won't work if the wiki names subsections differently (in the case that you put this markdown on another wiki). I have attached all the files in a zip.

Michael Jin on December 6 2012 22:49 UTC Ready for review

The work on this task is ready to be reviewed.

Julian Fagir on December 6 2012 23:46 UTC Thank you!

The work is good. For the links: We have to see anyway how we commit this into the wiki and how we reference it on the main page, so eventually, we will have to do something about it anyway.


Thank you! 

Julian Fagir on December 6 2012 23:46 UTC Task Closed

Congratulations, this task has been completed successfully.