Convert installation notes to markdown
The NetBSD Project
Status: Closed
Time to complete: 48 hrs
Mentors: Radoslaw Kujawa, Julian Coleman, Julian Fagir
Currently, the installation notes are constructed with mdoc from distrib/notes: http://ftp.netbsd.org/pub/NetBSD/NetBSD-5.1.2/i386/INSTALL.html
The task is to research whether it is possible to convert these articles to markdown, and, if possible, do so.
There might be many inclusions etc. to get the original structure, but even the result of what has to be done without the actual conversion would be neat.
Uploaded Work
| File name/URL | File size | Date submitted | |
|---|---|---|---|
| Conversion.odt | 23.8 KB | November 28 2012 23:54 UTC | |
| OnlineTool.md | 2.5 KB | November 29 2012 02:25 UTC | |
| Combo.md | 2.5 KB | November 29 2012 02:25 UTC | |
| Script_Python.md | 130.3 KB | November 29 2012 03:59 UTC | |
| Conversion.odt | 25.8 KB | November 29 2012 14:16 UTC | |
| html2text.py | 31.4 KB | November 29 2012 14:17 UTC |
I would like to work on this task.
This task has been assigned to Spencer Neitzke. You have 48 hours to complete this task, good luck!
I have found a way to convert the documentation to markdown, the only catch is that it is fairly manual. I have about half of the file converted already.
That's okay, but remember that your main job here is not converting the document, but researching how to do it. So we'd like to have a short document explaining the possible conversion ways (and why did you choose one of them).
The work on this task is ready to be reviewed.
Looks good so far. But I still have some questions :-).
You've mentioned that you already have got some part of the documentation converted to markdown. Can you attach an example? It would be nice to have an example of each tool, so we can see how good/bad job they do.
Also, I think that all tools you've described are interactive. Are there any scriptable tools available for this task? We have a lot of documents that would need conversion, so using scripts instead of interactive tools would be preferred.
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.
Looking into some scripting options and seeing what they produce.
I did find a script that worked, after some modifications. I do have one concern, the source of the installation documentation seems to have unnecessary tags. This is throwing off the converters.
To get rid of these extra tags we would have to manually fix each file.
The work on this task is ready to be reviewed.
Melange has detected that the deadline has passed and no more work can be submitted. The submitted work should be reviewed.
The deadline of the task has been extended with 1 days and 0 hours.
Ok, I see that you did attach and example of Markdown generated by Python script. But you didn't attach this script or any information on where to find this script. Please update Conversion.odt and attach this script.
I've extended the deadline (+1 day).
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.
The work on this task is ready to be reviewed.
Congratulations, this task has been completed successfully.