[oe] Documentation problems

[Koen Kooi]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Op 28-11-11 06:11, Tom Rini schreef:
> On Sun, Nov 27, 2011 at 8:44 AM, Koen Kooi <koen at dominion.thruhere.net>
> wrote:
>> -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1
>> 
>> Op 27-11-11 03:40, Tom Rini schreef:
>>> Hey all,
>>> 
>>> As things stand today, the wiki is out of date and a number of folks 
>>> refuse to work on it.
>> 
>> Does it actually need to be a wiki? Or rather: do web edits need to
>> show up immediately?
> 
> If spam is eliminated, does it still matter, today?

Ever since OE was founded the information in the wikis has been terrible.
The information in the docbook was accurate, but didn't cover everything.


>>> 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?
>> 
>> I really like the idea of storing the content in git since it gives us
>> 2 things we need for documentation: backups and a pull model.
> 
> The number one thing we lack today is people willing to document.

I'd change that to "knowledgable people"

> Everyone, myself included, who has said we need X done to the public 
> documentation today, has generally found a point at which they stop 
> wanting to keep things up to date.  Why?  What would change that?

I stopped working on the OE wiki because I couldn't keep up with people
adding anecdotal, but misleading information into it.

> Does anyone reading this know people that _like_ editing wikis?  Can we
> ask them what keeps them engaged in the process?

People in general like editing wikis, yes. The problem with OE is that it is
such niche product and has a steep learning curve as well. It does not lend
itself to drive-by editing like e.g. wikipedia.

How about this:

Proposal a:

1) fork the poky/yocto docbook based manual
2) run a sed script to change it to an OE branded version
3) convert it to a wiki

proposal b:

1) fork the poky/yocto docbook based manual
2) run a sed script to change it to an OE branded version
3) put it in git, webpages get updated with a git-hook

If people want to use a webbrowser to edit it:
https://github.com/blog/844-forking-with-the-edit-button
If we have setup the github mirror correctly the pull request will arrive on
the mailinglist automatically.

regards,

Koen
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (Darwin)
Comment: GPGTools - http://gpgtools.org

iEYEARECAAYFAk7TUvoACgkQMkyGM64RGpGqZACgoputgxl8LxHT0bipoA0gdWpV
kzEAnA3mTcKxrfsH3a4M1jTnGHACa6VL
=PMji
-----END PGP SIGNATURE-----