[haiku-development] Re: Haiku documents

  • From: Ralf Schülke <ralf.schuelke@xxxxxxxxx>
  • To: "haiku-development@xxxxxxxxxxxxx" <haiku-development@xxxxxxxxxxxxx>
  • Date: Thu, 11 Aug 2016 10:53:11 +0200

I think not so,

but fakt is, haiku source tree need a docs about:
- PM and hpkg
- launch_d
- how wirte a driver (usb, gpu, etc)
- how build haiku
- how using haiku git repro
- how contribute
- etc...

let inspiration from other project, see here:
https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation?id=refs/tags/v4.7

https://github.com/freebsd/freebsd-doc
http://cvsweb.openbsd.org/cgi-bin/cvsweb/www/

Thanks

2016-08-11 10:40 GMT+02:00 Adrien Destugues <pulkomandy@xxxxxxxxxxxxx>:

11 août 2016 10:33 "Ralf Schülke" <ralf.schuelke@xxxxxxxxx> a écrit:
And its on haiku www some docs but this are the wrong place and way:
https://github.com/haiku/website/tree/master/static/legacy-docs

https://github.com/haiku/website/tree/master/content/
legacy-docs/writing-video-card-drivers

and i found more.

the licencs give no problem:
https://haiku.netlify.com/legacy-docs/benewsletter/legalnotice

It does not allow making any changes, so storing this in git is useless.
It will stay frozen forever and no one will be allowed to make any changes.


see other project, he put www stuff into the main source tree
http://cvsweb.openbsd.org/cgi-bin/cvsweb/

we can do this too and then can some git pul from
/docs/egacy-docs/writing-video-card-drivers to
the www path.

I prefer these docs to stay in the separate "website". The website itself
will be soon moving to git, using the pages you found on
github/haiku/website. Having it in a separate repo is better because:
1) If people only want the code, they can checkout just the code
2) Likewise if they only want the docs
3) The website can be built automatically from that repo, so the docs
pushed there are always easily accessible

Once the website migration to this new system is complete, we will also
rework the website design and organization, to makes these documents more
visible and easier to navigate.

--
Adrien.


Other related posts: