Am Sonntag, 31. Oktober 2010, 13:04:14 schrieb davidMbrooke:
> Hi kp. Thanks for the feedback.
> 
> On Sat, 2010-10-30 at 01:29 +0200, KP Kirchdoerfer wrote:
> > Hello;
> > 
> > Am Freitag, 29. Oktober 2010, 22:15:46 schrieb davidMbrooke:
> > > Hi,
> > > 
> > > I have added a lot more suggested structure to the main Wiki page for
> > > the User Guide:
> > > http://sourceforge.net/apps/mediawiki/leaf/index.php?title=Bering-uClib
> > > c_4. x_-_User_Guide
> > > 
> > > In particular I have suggested where most of the sections from the v3.x
> > > installation guide (http://leaf.sourceforge.net/doc/buc-install3.html)
> > > might fit (except for the sections that relate most to download, floppy
> > > disks etc. and hence are largely out of date).
> > 
> > Looks like a pretty good start.
> > 
> > > kp: You mentioned you had some prepared material ready to upload -
> > > would that fit easily into such a structure? I am happy to convert the
> > > "- Copy from ..." material listed on the main User Guide page using
> > > the approach I used for the Developer Guide, but if you have already
> > > done that (and especially if you have already made edits for 4.x) I
> > > will spend my time elsewhere.
> > 
> > No, no, please move on; but I can take care of dropbear, ezipupd, hostapd
> > and the changed timeserver (busybox ntpd), for those I have reworked
> > files.
> 
> OK. I will try to convert and upload all of the existing 3.x
> Installation Guide today / tomorrow, apart from the sections you
> mention.
> 
> > > Initially I suggest we try to have one Wiki page per numbered Chapter,
> > > containing several Sections. If these get too big we can create
> > > sub-pages.
> > > 
> > > 
> > > One question I have been wondering about is whether to also create a
> > > Wiki page for each Package. I think I will do that. They can be in a
> > > "Packages" category and hence easily listed from an index page.
> > 
> > Do you think about a replacement for the "Packages page" of the old
> > Bering- uClibc series?
> 
> Perhaps. The "Packages" page is generated automatically from the content
> in each buildtool.cfg, I presume? That would be possible for the Wiki
> pages too.

It's a bit more, it collects information from cvs log and from the lrp's in 
the local cvs copy. That way we have the information from buildtool.cfg as 
well as changelog for the packages and the package date. (plus an option to 
download the latest package version).

If we can move the page to wiki, without losing content, it will be fine with 
me and Mike will be delighted - another step forward to get rid of the 
underlying php framework of our pages :)

> For now I am just thinking of somewhere to capture more documentation
> for a package - e.g. to mention that ntpd can replace the Busybox ntpd
> if someone wants the extra functionality, or to document LEAF-specific
> usage notes for a package.
> I am thinking of a standard "Infobox" on the right hand side of the Wiki
> for each package, showing version, home page, "requires" etc.
> 
> The alternative to all this is to cover "Topics" (like "Time Server") in
> the User Guide and mention the packages there...
> 
> > > Maybe I will try creating one or two and see what people think...
> > 
> > Shurely helps to get the idea.
> 
> OK. I will create one or two as samples.

Good! 
I like the idea. 
Depending how much information will be for each package, the buildtool.cfg 
"help" section will be a good place to provide the infos. That way we do have 
in cvs, we do have it on the LEAF box and it can be added to the wiki.
If more info is needed, a seperate topic in the User's guide is required.
I just like to have maintain as less docs as possible :)


kp

------------------------------------------------------------------------------
Nokia and AT&T present the 2010 Calling All Innovators-North America contest
Create new apps & games for the Nokia N8 for consumers in  U.S. and Canada
$10 million total in prizes - $4M cash, 500 devices, nearly $6M in marketing
Develop with Nokia Qt SDK, Web Runtime, or Java and Publish to Ovi Store 
http://p.sf.net/sfu/nokia-dev2dev

_______________________________________________
leaf-devel mailing list
leaf-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/leaf-devel

Reply via email to