Help - Search - Members - Calendar
Full Version: Oz Documentation Project
OESF Forums > Distros, Development, and Model Specific Forums > Distro Support and Discussion > Angstrom & OpenZaurus
pframpton
There have been many rants and raves about the lack of documentation for OZ. I plan to put together a set of manuals for as many applications as possible. Not just a collection of tips/tricks/FAQs but a comprehensive manual on using the programs.

For this I will need volunteers. The first stage is to write quides for the most important/common applications. I welcome suggestions on which apps these are, aswell as volunteers to write documentation.

Ideall the document for an app will include:

Installation
Configuration
Use
Bugs/Trick/Tips
Links to source, more info, etc

I have started a webpage at OZ Documentation Project

I can be contacted by e-mail (details on the link above). Let me know which apps you want to write about and I will update the details on the website.

Philip

PS Could the admin pin this post to the top of the forum please?
lardman
Let's get writing everyone.


Si
Merardon
What would be particularly helpful would be a short description of all the packages installed by default, to aid in uninstalling the unessential ones. (Freeing up space) The information could then be integrated into the package manager via a description button. Unless this already exists, and I merely haven't located it yet.
lardman
The packages file contains a short description of each package - ipkg info <packagename> spits this info out to the terminal.

This would be a useful addition to aqpkg/opie-package-manager (IMHO), and may already have been suggested added (you'd need to check the opie bugtracker).

Edit: This functionality does exist in opie-packagemanager


Si
mimeca
Hi pframpton

I would like owrk in that project. Zaurus isn't for newbies and a good documentation can help. I can write some documents in english, but my language is spanish.
Hrw
in opie-packagemanager try to hold on package - infos will open
Merardon
From the packages I tested that out on, it didn't really tell what the package was, and what it was for, merely what it was called, space, what it requried, etc. Perhaps adding a small description of each package there would be helpful?
pframpton
QUOTE(Merardon @ Feb 15 2005, 07:00 AM)
Perhaps adding a small description of each package there would be helpful?
*


This puts the burden on the maintainers rather than the volunteer document writers. They (the maintainers) have enough to do. This is why the description fields are minimal.
lardman
You could submit a patch for the .bb file to alter the description if you don't think it's descriptive enough.


Si
Merardon
I don't know enough about the packages to write up descriptions, unfortunately,and if I did, I wouldn't have requested the feature in the first place. I was implying a volunteer, actually.
Merardon
Are you alive, pframpton? You haven't responded to the e-mail that I sent weeks ago, my proposed fixes haven't been added, and it's not been moved to OESF.
pframpton
Yes, I'm alive. What message? Do you mean texteditor documents, if so I only just found it in my junk box, I've whitelisted you now.
Merardon
It was essentially just what I said last post, and was an e-mail from harpalus hush ai (insert the @ and ., respectively) I'll have enough time to write up something in a few weeks, so I can start contributing then.
acpkendo
QUOTE
Do you mean texteditor documents, if so I only just found it in my junk box, I've whitelisted you now.


opie-textedit docs were from me, opie-write or Hancom (probably not tinykate) to follow. . .
pframpton
Before too much more is written, it would be good to produce some documents based on the OPIE and GPE documentation. No need to write instructions form scratch when the basics are already done.

I'm working on an the main manual PDF at the moment. Copying across info from the OZ website. Hopefully we can have a 0.1 release manual, based on what is done so far, ready for OZ 3.5.3.
dranath
Hello guys,

I only recently registered in this forum and right now I'm still looking which ROM to dedicate my SL-6000L to :-).

So I would like to contribute my gained knowledge to the manual-efforts if I decide on to run OpenZaurus with OPIE or GPE.

But one question:
Browsing the Homepage of openembedded.org I saw their Wiki. Would it be possible to ask them to be able to put the manual there? So everybody registered and working with OpenZaurus would be able to contribute to the manual - and not have a single person to maintain it (and in case recode the html-pages sent to him/her).

Greetings
dranath
BeKind
I agree with Dranath. Lets make the manual a Wiki.

I've spent so long getting OZ to work and learning the ins and outs of everything, that I think I should be contributing to a manual.

Because theres probably a few dozen people just like me, it should be a Wiki.
lardman
If you register on openzaurus.org you can create and edit wordpress docs there.

That is the preference as oe.org will eventually be just about the build system, not the ROMs which are built with it.


Si
offroadgeek
Why don't you all just carve out a section of the OESF wiki for OZ?
zenyatta
A while ago I set up an OpenZaurus wiki at my homepage - http://www.journey.sk/zwiki/index.php/UserManual. This was shortly before the big OESF changes etc. If anyone feels like it please feel free to work there. The site is being backed up once every 24 hours. As soon as I solve the most pressing problems with my newly-flashed 3.5.3 I will start contributing as well.

z.
Mickeyl
This is a good structure. Now could you all please settle one one wiki - preferably the "official" one @ openzaurus.org? wink.gif
acpkendo
Having all of this on a wiki is a good thing, but I think the higher priority should be making sure that there is some documentation on the device itself. Many of the *-help-* packages in OZ right now do not have any significant documentation to them (some are just an index page with a header). This is certainly an area where we can help take the burden off the developers.

So, we might want to think about some way we can pull the documents off the wiki and format (also HTML) them for inclusion in the *-help-* packages. I don't know if something like DocBook would be good to standardize on down the road, since you could write once and publish to HTML (you could specify both regular format for the wiki and smaller format for the Zaurus, I assume) as well as a "comprehensive" PDF manual.
zenyatta
Mickeyl: The openzaurus.org site allows me to attach comments to an article but does not let me edit the article itself. So it is not really useable as a wiki.

If there is a proper wiki section I couldn't find it (I used the search textbox in the top-right corner). Maybe I need to register somewhere in order to edit articles but I could not find a registration screen either. If I need to register and then beg someone for edit privileges, I won't bother.

Cheers,
z.

EDIT: Silly me, I just found the registration option under Login. I'm waiting for my password to arrive.
Hrw
zenyatta: password send

use "Write->Page" to write documentation. We will talk about it later wink.gif
pframpton
I never got my registration password from OZ. I'll try again when I have a gap in thesis writing, and upload all the instructions people have sent me (not many).
Hrw
@pframpton

I'm sending passwords usually once per day. If you registered after 2005-05-06 then I will send password tomorrow - had no time during last days - my grandmother died.
zenyatta
Thanks for the password. As a first step, I have revised installation instructions for SL-5500 and SL-5600. The text was very comprehensive and informative but I thought it could use some improvements. I had two major goals in particular:

1. Making the text as friendly to an absolute newbie as is humanly possible.
2. Making important pieces of information more visually distinct.

In order to help with goal number 2, I introduced two CSS styles through a <style> tag:

.tip { font-style: italic; color: #004000 }
.note { font-style: italic; color: #802000 }

However, wordpress suppresses them which I think is a shame. If someone could add these two rules to the stylesheet used at openzaurus.org (perhaps with more sensible colors) it would help raise the quality of all wiki contents.

The revised installation instructions are at http://openzaurus.org/wordpress/not-in-men...l-5600-revised/. I would appreciate feedback from anyone - please leave comments under the page. If the feedback is positive, we can replace the original instructions with this new version and I will proceed to revise more pages in a similar style.

Cheers,
z.
lardman
zenyatta,

do you have a 5600? See my note on your page in wordpress. The flashing processes for the 5500/5000D and 5600 are different.

Seems nice and clear though.


Si
zenyatta
It's rather embarrassing to make a typo in the headline of a supposedly revised page smile.gif I humbly thank you for pointing it out. The text is actually not intended for the 5600 at all. It is now fixed (same URL).

z.
Hrw
zenyatta: good work - thx.

css styles added
lardman
zenyatta,

smile.gif no worries

Si
obergix
What has happened on that front ?

The pinned article points to a disappeared page...

Any plans these days for a stable wiki in which to contribute to documentation for the users (for the developpers it's there and pretty good actually wink.gif

Best regards,
lardman
The openzaurus site is still there and the links should all work, I think that's the best place.

I've been a bit busy, hence my lack of having done anything very much,


Si
obergix
QUOTE(lardman @ Nov 12 2005, 02:10 PM)
The openzaurus site is still there and the links should all work, I think that's the best place.

I've been a bit busy, hence my lack of having done anything very much,


Si
*

Still this link is dead...
http://users.ox.ac.uk/~scat1139/oz/index.html

so maybe the pinned article may be updated to reflect current status ?

Thanks anyway wink.gif
lardman
Ah, I see, missed that one.
lardman
Right, all docs related stuff moved to here:

http://www.oesf.org/forums/index.php?showtopic=18472

Get writing guys (and girls).

Cheers,


Si
This is a "lo-fi" version of our main content. To view the full version with more information, formatting and images, please click here.
Invision Power Board © 2001-2014 Invision Power Services, Inc.