[haiku-development] Re: Haiku documents
- From: "Adrien Destugues" <pulkomandy@xxxxxxxxxxxxx>
- To: haiku-development@xxxxxxxxxxxxx
- Date: Thu, 11 Aug 2016 08:10:35 +0000
11 août 2016 09:51 "Ralf Schülke" <ralf.schuelke@xxxxxxxxx> a écrit:
Hello list,
i will open a this thread to find out what can we do better.
In this mail, i will talk about the documents issus in the haiku project,
quick the problem are some documentas are decentral and not in the haiku
source tree "/docs"
What need we to do? now we need put in the source tree for central decuments.
http://cgit.haiku-os.org/haiku/tree/docs
Why? but it is better for new developers and it is easy to write new docs or
update docs by rev.
What documents are mean?
wiki:
https://dev.haiku-os.org/wiki/PackageManagement
https://dev.haiku-os.org/wiki/LaunchDaemon
www:
https://www.haiku-os.org/legacy-docs/writing-video-card-drivers
https://www.haiku-os.org/files/CreatingUIsusingtheLayoutAPI.pdf
https://www.haiku-os.org/development/getting-started
https://www.haiku-os.org/articles
legacy:
https://www.haiku-os.org/legacy-docs/bebook/
https://www.haiku-os.org/legacy-docs/benewsletter/
These two we are not allowed to modify (the license is BY-NC-ND). So there is
no point in moving them into git.
However, there is
http://api.haiku-os.org which is generated from git ;
docs/user/ , and is a replacement for the Be Book. The newsletter is somewhat
replaced by articles and blog posts on the website.
http://www.oreilly.com/openbook/beosprog/book/index.html
I don't see any license information on this one. Do you know if we can
copy/update it?
An i hope, the new hompage can can add to main git source tree in the docs
path, then we are on a
good way to central source tree.
A single central place for all docs may be a good idea, but there are some
problems on how things are managed and distributed:
- docs/user in git is meant to be a documentation of the Haiku API, for people
writing programs running on Haiku.
- Other folders in docs/ are meant to document the internals of the system.
This could be made a bit more formal, maybe using a common syntax and webpage
generation like docs/user.
- The wiki is more for "brain dump" kind of things. They are better stored
there than in mailing list posts.
- The website, similar to the be newsletter, is a way to showcase a new feature
or a specific technical aspect of Haiku programming.
- Finally, some docs are full-blown books on their own (eg. the "writing video
card drivers" one).
These are all quite different things, with different workflows and a different
result. I'm not sure trying to unify everything under a single storage and
publishing solution is a good idea.
Other related posts:
