RE: Looking for an editor for FreeRADIUS documentation
Alan DeKok wrote:
Arran Cudbard-Bell wrote:
The problem with volunteer 're-factoring' work, is that although people mean well when they offer their assistance, it doesn't usually work out... They'll often spend a couple of weeks working on the task, get bored, figure they'll take a break and come back to it later, and it never gets completed.
I'd say the hard part is getting people to just write docs. It's not as sexy as programming, but it has arguably more *positive* impact on the end user.
I concede both points. Now it just gets down to showing that it won't happen this time. :-)
It looks like a good set of volunteers wanting to help. My suggestion is to convert the docs to "Restructured text":
Looks very straight forward. :) I'll be creating a github account for myself later this evening and will start getting my hands dirty after that. Best Regards, Johannes R-E PS. By the way; for the sake of not duplicating effort does Peter Nixon want to lead the way on this or is it just a simple free-for-all?
It looks like a good set of volunteers wanting to help. My suggestion is to convert the docs to "Restructured text":
Looks very straight forward. :)
I'll be creating a github account for myself later this evening and will start getting my hands dirty after that.
Best Regards, Johannes R-E
PS. By the way; for the sake of not duplicating effort does Peter Nixon want to lead the way on this or is it just a simple free-for-all?
Hi Johannes Please feel free to take the lead. While you may of course use the RST viewer built into github, its better if you install Sphinx (http://sphinx.pocoo.org/) as you will then be able to "build" the RST into html format locally on your machine with: make html Additionally, if you install rst2pdf you will be able to use: make pdf I would do the work in this order: 1) checkout freeradius 2) Rename existing files in doc dir to have a .rst extension (eg. git mv proxy proxy.rst) 3) make html (in doc dir) 4) Fix any warnings output by sphinx 5) make html 6) Check what the output looks like (eg. firefox _build/html/index.html) and clean up anything that needs it. 7) Repeat for the next file. Cheers -- Peter Nixon http://peternixon.net/
Hi, Peter Nixon wrote:
Hi Johannes
Please feel free to take the lead. While you may of course use the RST viewer built into github, its better if you install Sphinx (http://sphinx.pocoo.org/) as you will then be able to "build" the RST into html format locally on your machine with:
make html
Additionally, if you install rst2pdf you will be able to use:
make pdf
OK, thanks for the info and the advice. I'll go with that methodology. Sorry about being quiet lately - I've been extremely busy at work and in my personal life but in about 2-3 weeks time I'll finally have time to start digging in. Also, as Alan noted earlier - once I decide on a file I want to check out and convert I'll send a mail to the list and let you know. Last note; nice to see the discussions about Wiki editing. I'd like to join in there as well but I'll wait with that until after the RST conversions. :) Have a great weekend, J.
On Fri 11 Jun 2010, Ramm-Ericson, Johannes wrote:
Hi,
Peter Nixon wrote:
Hi Johannes
Please feel free to take the lead. While you may of course use the RST viewer built into github, its better if you install Sphinx (http://sphinx.pocoo.org/) as you will then be able to "build" the RST into html format locally on your machine with:
make html
Additionally, if you install rst2pdf you will be able to use:
make pdf
OK, thanks for the info and the advice. I'll go with that methodology. Sorry about being quiet lately - I've been extremely busy at work and in my personal life but in about 2-3 weeks time I'll finally have time to start digging in.
Also, as Alan noted earlier - once I decide on a file I want to check out and convert I'll send a mail to the list and let you know.
OK. In that case suggest that you dont let large amounts of time (days) pass between local work in your clone and pushes upstream to us so that no-one duplicates work. Regards -- Peter Nixon http://peternixon.net/
participants (2)
-
Peter Nixon -
Ramm-Ericson, Johannes