So let's keep on doing things with the wiki. It's a lot easier to change stuff there, and this is important during these first steps, when things change too quickly.
At the same time I may start working on some basic tools and a directory structure for developer guide(s) (introduction to Illumos internals, drivers, etc.), man pages and a handbook.
As things stabilize we can start porting information from the wiki pages to the official documentation repo, and then start producing some more formal documents.
I think there's a lot of documentation from OpenSolaris that can be of interest. I'll try to see what's there and what can be integrated.
Cheers, Antonio On 19/08/2010 20:58, Garrett D'Amore wrote:
I think it *may* be too early to start formally documenting things. I've been thinking about this too. We do need a handbook of sorts. We need man pages. Right now we have none -- they are in a separate consolidation. Figuring out whether we keep them as such or integrate them into the gate is a topic for reasonable debate. (I see multiple possible directions, with various pros/cons.) I think right now the first thing to do is start improving the documentation on the wiki. We also need to engage actual writers. I know that there are some that have expressed an interest in our community -- we will have to see what happens. - Garrett On Thu, 2010-08-19 at 20:44 +0200, Antonio Vieiro wrote:Hi all, I noticed there's no documentation project yet, so I created one. The basic plan I propose is as follows: 1. Get a basic infrastructure for building the documentation, I'd like to use DocBook 5, as it can generate HTML/PDF/ePub from a sinle source and can be easily translated. 2. Start building a very first document, a handbook similar to FreeBSD's. The very first contents should be how to set-up the a development environment, build and install, etc. So what do you think? Is it too early to start documenting things? Any comments on the project? Cheers, Antonio [1] http://www.freebsd.org/doc/en/books/handbook/ _______________________________________________ Discuss mailing list [email protected] http://lists.illumos.org/m/listinfo/discuss
_______________________________________________ Discuss mailing list [email protected] http://lists.illumos.org/m/listinfo/discuss
