[oe] [RFC] Documentation problems and future plans

[Paul Menzel]

Dear everyone,


Am Samstag, den 26.11.2011, 19:40 -0700 schrieb Tom Rini:

> As things stand today, the wiki is out of date and a number of folks
> refuse to work on it.  Using things like "It's all text!" for firefox
> only go so far and don't solve problems like people just avoiding
> documentation anyhow.

the Special Pages page [1] has interesting information. For example you
can get an overview of the recent changes in the Wiki [2].

> Paul Menzel has mentioned that ikiwiki has been mentioned before and
> that lets us have the website in a repository.  Do folks have other
> ideas?

Before the implementation is discussed, could we decide what
documentation we need and what is possible to maintain in the long run?
Avoiding maintenance and duplicate efforts should be the objective.

1. User manual
2. FAQ
3. README
4. Guidelines (Commit, patch, style)
5. Getting started document (could be included in 1.)
6. Git usage (a lot of existing documentation for that one elsewhere) or
can be put in a file `HACKING`.
7. …

Formatted in a markup language like Markdown those could be converted to
HTML easily.

The second question is, is OE-core documented in the OE wiki or for
example at the Yocto project?

To get users started we could also recommend to use the Ȧngström scripts
or to take a look at the Yocto project, i. e. just point to
distributions being well documented.

They have a Wiki already [3] and we could decide to use that instead. Or
we could say to use use the Wiki at eLinux.org [4].


Thanks,

Paul


[1] http://www.openembedded.org/wiki/Special:SpecialPages
[2] http://www.openembedded.org/wiki/Special:RecentChanges
[3] https://wiki.yoctoproject.org/wiki/Main_Page
[4] http://elinux.org/Main_Page
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 198 bytes
Desc: This is a digitally signed message part
URL: <http://lists.openembedded.org/pipermail/openembedded-devel/attachments/20111127/b096d353/attachment-0002.sig>