Eric S. Raymond
2009-Mar-16 19:13 UTC
[Nut-upsdev] My UPS has arrived, time to start working on documentation
Arnaud, my UPS arrived yesterday; thanks for your generosity. I'm using it to power the computer I'm typing on. This moves NUT up a few places on my priority list. In our last email exchange, I believe we agreed on a couple of major points. I want to confirm these before I start modifying the documentation heavily. 1. asciidoc is a good master format for the in-tree documentation. 2. We're going to go with making the website a branch of the Subversion repo, with the pages mainly pointing to HTMLized copies of the in-tree repo. 3. The exception is that we may retain the new wiki for the protocol library, since that is an area where we can expect substantial user contributions. Are there any more decisions we need to make or cautions you want to utter before I dive in and start work? Further note: I'll need shell access to the host for the SVN repo. One of my first tasks will be to write a hook that automatically publishes a web page when its repo master gets a commit. -- >>esr>>
Arnaud Quette
2009-Mar-17 10:35 UTC
[Nut-upsdev] My UPS has arrived, time to start working on documentation
Hi Eric, 2009/3/16 Eric S. Raymond <esr at snark.thyrsus.com>> Arnaud, my UPS arrived yesterday; thanks for your generosity.pleased to hear that it arrived ;-) Eaton is the new player here, and we have had some recent proof of its dedication to FLOSS... so if we can help, it's a pleasure ^_^> I'm > using it to power the computer I'm typing on. This moves NUT up a few > places on my priority list. > > In our last email exchange, I believe we agreed on a couple of major > points. I want to confirm these before I start modifying the > documentation heavily. > > 1. asciidoc is a good master format for the in-tree documentation. >right> 2. We're going to go with making the website a branch of the > Subversion repo, with the pages mainly pointing to HTMLized copies > of the in-tree repo. >right, though I'm still unsure about the exact details of the html generation and location. we'll discuss these kind of details later on.> 3. The exception is that we may retain the new wiki for the > protocol library, since that is an area where we can expect substantial > user contributions. >well, the wiki is interesting for the protocols (though I don't expect many contribs there), i18n and website mastering delegation. btw, if you have a better solution that fits the above criteria, I'm opened and it's the right time. Are there any more decisions we need to make or cautions you want to> utter before I dive in and start work? >I don't think. just beware of the docs/bits present on one side and not the other (aknowledgements, ...). though I'll however jump in there when you've laid up the base system to make sure we don't miss anything. I'll also have to check for the generation / integration of the HW compat list. don't hesitate to hit me regurlarly to check that we're on the right track. Further note: I'll need shell access to the host for the SVN repo.> One of my first tasks will be to write a hook that automatically > publishes a web page when its repo master gets a commit.private followup with Charles... thanks again for your help there. cheers, Arnaud -- Linux / Unix Expert R&D - Eaton - http://www.eaton.com/mgeops Network UPS Tools (NUT) Project Leader - http://www.networkupstools.org/ Debian Developer - http://people.debian.org/~aquette/ Free Software Developer - http://arnaud.quette.free.fr/ -------------- next part -------------- An HTML attachment was scrubbed... URL: http://lists.alioth.debian.org/pipermail/nut-upsdev/attachments/20090317/5c03c2cb/attachment.htm