Author Topic: Oz Documentation Project (Read 44939 times)

dranath · « **Reply #15 on:** April 07, 2005, 06:10:35 pm »

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 · « **Reply #16 on:** May 02, 2005, 11:58:50 pm »

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 · « **Reply #17 on:** May 03, 2005, 07:14:45 am »

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 · « **Reply #18 on:** May 03, 2005, 10:28:14 am »

Why don't you all just carve out a section of the OESF wiki for OZ?

zenyatta · « **Reply #19 on:** May 05, 2005, 08:37:08 am »

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 · « **Reply #20 on:** May 05, 2005, 09:28:45 am »

This is a good structure. Now could you all please settle one one wiki - preferably the "official" one @ openzaurus.org?

acpkendo · « **Reply #21 on:** May 05, 2005, 11:43:11 am »

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 · « **Reply #22 on:** May 06, 2005, 07:54:30 am »

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 · « **Reply #23 on:** May 06, 2005, 10:59:42 am »

zenyatta: password send

use "Write->Page" to write documentation. We will talk about it later

pframpton · « **Reply #24 on:** May 10, 2005, 01:39:33 pm »

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 · « **Reply #25 on:** May 10, 2005, 05:07:35 pm »

@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 · « **Reply #26 on:** May 10, 2005, 05:08:17 pm »

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 · « **Reply #27 on:** May 10, 2005, 06:10:36 pm »

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 · « **Reply #28 on:** May 11, 2005, 02:49:41 am »

It's rather embarrassing to make a typo in the headline of a supposedly revised page 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 · « **Reply #29 on:** May 11, 2005, 03:01:36 am »

zenyatta: good work - thx.

css styles added

News:

Author Topic: Oz Documentation Project (Read 44939 times)