[haiku-doc] Re: Installation docs with css and javascript

Philippe Michael Groarke wrote:

Hello Humdinger, happy to hear you liked the docs. It was a long process to 
format and
edit all those docs. I wrote a couple of guides and lines myself, or completed 
them
with information in comments, but it was basically a gathering job.  I was 
wondering,
are you the only person working on documentation, if not, hello everyone on the 
list?
I think at the moment we two are the only ones creating new pages. Others apparently look over it and correct small things. Thanks for that BTW. 


O.K. for now, maybe we could think of a target? Like Alpha or Beta. Obviously 
at R1
everything will be on the website. What has been your replies on the weblist?
I'd say it should definitely be online for the first alpha release. IIRC everyone is very much for having the user guide online. Unfortunately the people actually in charge of changes to the webpage aren't too active at the moment. Maybe real life issues... Or we're all still waiting how the proposed wiki solution is coming along. AFAIK that is still being worked on. 
You know how it's like, everything always takes a bit longer as expected when 
it's started...
BTW, we should at least put the original authors in the author comment of each respective page. 

Yes, I intended to do that, but didn't know where to put the credits. I forgot 
to ask
about it (all the authors have been advised that there names would figure 
somewhere...
I didn't know where :). When you say author comment, you mean in the header or
something (like the css)


Yes. Simply put them under the copyright notice in the header comment of every 
page.

> I thought about

including name and last edit date either under the title or at the bottom of 
the pages,
in light grey or something. It would be nice.
I don't think we should openly personalize pages. Over time so much will be added or rewritten, the list of contributors would grow to unsightly lengths. 

> I will try to fit in all the needed work for my docs, and once it's looking

good, I'll pick an easy application and start some writing on that. All my work 
is
stopped until the docs are in the svn repo.
I just committed the installation topic to SVN. Please have a look at it and tell me if the direction is OK. I restructured a bit... You'll see that the page install-usb.html isn't part of the user guide. I think there are much overlap to install-raw.html. Both deal with installing a raw-image to a partition/USB drive. 
Maybe you can try to unify these things.
Also, when looking into the source of installation.html you'll find the last two topics commented out (The UserBuildConfig may be a candidate for another link under "Compiling/Installing from source code"). Those are still part of other topics. Maybe you can transplant them from there.
As it only complicates things I'll keep my fingers from the whole installation topic for now so you can work undisturbed. If you need a second opinion on things or would like to pass on some topic, don't hesitate to post on this list.
To everyone else reading this: I don't know how much of these instruction Philippe could verify, I at least have neither Mac nor Windows or a BeOS capable machine. So if anyone finds errors or better solutions, please let us know. 

Regards,
Humdinger

--
--=-=--=-=--=-=--=-=--=-=--=-=--=-=--=-=--=-=--=-
Deutsche Haiku News @ http://www.haiku-gazette.de

Other related posts: