Hey Charles,<br><br><div class="gmail_quote">2009/7/29 Charles Lepple <span dir="ltr"><<a href="mailto:clepple@gmail.com" target="_blank">clepple@gmail.com</a>></span><br><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
<div>On Tue, Jul 28, 2009 at 3:41 PM, Arnaud Quette<<a href="mailto:aquette.dev@gmail.com" target="_blank">aquette.dev@gmail.com</a>> wrote:<br>
><br>
><br>
> 2009/7/28 Charles Lepple <<a href="mailto:clepple@gmail.com" target="_blank">clepple@gmail.com</a>><br>
>><br>
>> On Jul 28, 2009, at 7:53 AM, Arnaud Quette wrote:<br>
>><br>
>>> some testing around the NUT Packager Guide to validate the general<br>
>>> approach of the new documentation.<br>
>>> The shell script is there to track the command line used to generate the<br>
>>> HTML output, and the generated HTML file to show the result.<br>
>><br>
>> Hi Arnaud,<br>
>><br>
>> would it be OK for me to merge the contents of the shell script into<br>
>> docs/Makefile.am?<br>
>><br>
>> I plan to make the extra Buildbot step copy the generated documentation to<br>
>> someplace web-accessible.<br>
><br>
> though this is the aim (very) soon, ATM I prefer to keep the simple shell<br>
> script for testing quickly and avoiding to call automake.<br>
<br>
</div>OK. I will try to merge that into the automake rules, in order to<br>
reduce the number of times I need to reconfigure the Buildbot scripts.<br>
<div></div></blockquote><div><br>agreed (with your other mail)<br> <br></div><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;"><div>
> btw, for the User and Developer Guides (not applicable to the Packager one),<br>
> I'm thinking about using the combined document approach (eg having a<br>
> developer.txt that simply includes 1 file per chapters). the drawback of<br>
> this is that we can have a header in this file. but we can have this header<br>
> as a comment and put all authors in the main file. I've not validated this,<br>
> but we might have to use the .xml file to declare multiple authors...<br>
> comments and thought on your side?<br>
<br>
</div>I admit that I do not know much about asciidoc itself - I spent about<br>
a half hour trying to get it to generate a hyperlink for a plain URL<br>
(using the command line in docs/Makefile.am) before I gave up and<br>
focused on the Buildbot side.<br>
</blockquote><div><br>you've well done!<br>I'm finishing to clear the path so that you can then go straightforward on the developer guide.<br>most of the technical choices are done, so I'll continue to commit a few things by the end of the week.<br>
I'll send a summary mail once everything is ok.<br><br>btw, we will need 2 targets here:<br>- 1 for the documentation that will be shipped as part of the packages (HTML and optionally PDF),<br>- 1 for the website (ie the website specific part, including the homepage/news ; and the doc with a suitable layout for integrating to the website). The tricky part there is that I would like to have a separate file for the news, then included in the homepage.txt. so that we could then use the news.txt to serve an rss feed...<br>
<br>these are mostly the last points I'm currently checking.<br><br>on that website side, we can start setting up the toolchain.<br>what I've in mind ATM is that you use your local buildbot to regenerate the dynamic part of the website, and an automated rsync on the Eaton webserver will pull these changes...<br>
<br>in that aim, I've commited (r1883 on the AsciiDoc branch) some preliminary work on the website.<br>things like the menu's links are broken, waiting for the user manual to be available. so it's just a kind of proof of concept.<br>
I've setup a <a href="http://new.networkupstools.org">new.networkupstools.org</a>, so that we can still keep test.nut ATM, to rip off some contents that only exist there. I've only put an equivalent base of what will be generated in the end (website.html renamed to index.html + the CSS and images dir).<br>
you should be able to access it within a few hours, just the time to propagate through the NSs...<br>we'll switch to a private discussion to finalize the rsync setup.<br><br></div><blockquote class="gmail_quote" style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">
If we need to, we can paste in an Authors file before running asciidoc.<br>
</blockquote><div><br>possible, I've still not validated that point yet. <br></div></div><br clear="all">cheers,<br>Arnaud<br>-- <br>Linux / Unix Expert R&D - Eaton - <a href="http://www.eaton.com/mgeops" target="_blank">http://www.eaton.com/mgeops</a><br>
Network UPS Tools (NUT) Project Leader - <a href="http://www.networkupstools.org/" target="_blank">http://www.networkupstools.org/</a><br>Debian Developer - <a href="http://www.debian.org" target="_blank">http://www.debian.org</a><br>
Free Software Developer - <a href="http://arnaud.quette.free.fr/" target="_blank">http://arnaud.quette.free.fr/</a><br>