[haiku-web] [new feature] New way of maintaining developer documentation
- From: Niels Reedijk <niels.reedijk@xxxxxxxxx>
- To: haiku-web@xxxxxxxxxxxxx
- Date: Wed, 11 Mar 2009 16:58:21 +0100
Hello all,
This message is especially of interest for Bertrand and Urias.
As per the previous thread on the location and maintenance of the
docs, I have been playing with a drupal core module called books. The
book module does the following:
1. it groups several nodes together and presents them as a book
2. the nodes can be commented on
3. the nodes can be edited by any registered users (configurable).
I've started with an experiment on experimental.web.haiku-os.org. Have
a look at the getting started docs at
http://experimental.web.haiku-os.org/documents/getting_started
Notes:
1. Design. On the left there are two blocks. One is a custom block I
wrote which describes the page. The other one is an automatic block
that generates a table of contents of the book. When I first put the
block in the right column (with the yellow blocks), it sort of
disappeared, so I decided to put this info in the left column.
However, in order to keep the content readable, I had to hide the
right column. Personally I think I did the right thing with this
design. It could use some CSS love.
2. Contents. I included three existing tutorials in this experiment.
However, the existing tutorials are of the type doc_dev and they need
to be converted to the type book. Converting a page is a low level
operation, which includes some database work, so it's not for
everyone. I kept the comments.
3. Permissions. Currently everyone who is logged in can change the
docs. Because most people on this list have higher permission levels
than regular users, I've created a test account (user: test, pass:
test) so that you can see what this looks like from an end user
perspective.
4. Todo. The pages are not yet tied in with the Documents page. I
think this can be done when we deploy it on the real website.
Anyway, I'm calling for comments. Functionality wise I think it is
mostly done. I hope the people interested in using this system are
willing to test it out. I'll leave it to you to hearing what should be
changed and when it can be deployed.
Kind regards,
Niels
-----------------------------------------------------------------------
haiku-web@xxxxxxxxxxxxx - Haiku Web & Developer Support Discussion List
Other related posts:
