Forum .LRN Q&A: Re: F2F leadership team meeting (April 27, 2007)

Collapse
Posted by Avni Khatri on
Couple of other things I remember from the meeting:

1. Emma mentioned the duplication of xoWiki documentation + old documentation. Would be good if we could figure out how to expedite the migration to xoWiki and get rid of the old documentation?

2. I offered to write an email about how to improve documentation on getting people access to commit. And why it took me a while to commit the workflow UI code. (will do this as soon as I get a chance)

Collapse
Posted by Emmanuelle Raffenne on
1. Emma mentioned the duplication of xoWiki documentation + old documentation. Would be good if we could figure out how to expedite the migration to xoWiki and get rid of the old documentation?

I have 2 questions/concerns:

1. Access to documentation at openacs.org: the most up-to-date documentation is at the wiki but the "documentation" link is still pointing to the old one. Maybe we could point the "documentation" one to https://openacs.org/xowiki/openacs-handbook and add a link to the "old documentation" on that page.

2. How to pack the wiki doc into OpenACS and .LRN tarballs: IIRC a book can be created from the wiki pages, Gustaf? but can we keep different versions -for different releases- of the documentation? And what's the format of the output (the book) and how can it be included in the tarballs?

Collapse
Posted by Avni Khatri on
1. Access to documentation at openacs.org: the most up-to-date documentation is at the wiki but the "documentation" link is still pointing to the old one. Maybe we could point the "documentation" one to https://openacs.org/xowiki/openacs-handbook and add a link to the "old documentation" on that page.

Absolutely! (IMO)

2. How to pack the wiki doc into OpenACS and .LRN tarballs: IIRC a book can be created from the wiki pages, Gustaf?

Gustaf - Carl showed me a JPG of the book? Is this implemented?!! (It looked awesome)

but can we keep different versions -for different releases- of the documentation? And what's the format of the output (the book) and how can it be included in the tarballs?

Would this mean we also need xotcl and xowiki in the OpenACS and .LRN tarballs? If so, we would need to include the xotcl and xowiki installation instructions into the OpenACS and .LRN installation instructions.

Collapse
Posted by Malte Sussdorff on
The issue with the documentation is the longer term discussion between Torben's approach (openacs-handbook), writing all from scratch, tailored for different users and the old way (https://openacs.org/test-doc/).

The former has the intention of a categorized approach where pages are structured and presented differently depending on the target audience.

The latter has the intention of being a book.

My opinion was and still is that we should have the BOOK as the primary reference and add categories in a smart way so that we do have multiple entry points into it. But others might disagree. And due to this impasse I don't know where to fix documentation or upgrade it and most likely others don't either. So not much get's done.

If you go to /xowiki you will also realize that we have package documentation there twice (https://openacs.org/xowiki/ACS_Admin vs. https://openacs.org/xowiki/acs-admin). In two separate categories. User Installation. There exists a couple of pages, which one will be deemed current?

Another example: If you go to https://openacs.org/xowiki/en/openacs-system-install (which luckily is prominently linked from the main page), on the left hand side you see a ton of pages and options, all flat in one category. Here the category approach clearly fails in my understanding and having sections and subsections would be much better.

Usually I am a person who would get his hands dirty if he feels pationate about it as I do about user documentation. But there exists a documentation team which has different approaches, and this shows. Furthermore, not everything old is bad (read: /test-doc). It is just old and needs updating. But the old documentation was well structured.

Therefore, we might have to open the box of pandora again and discuss what the documentation should do for us, then talk about structure and last but not least talk about implementation. Not to mention the fact that e.g. I do all my user documentation in screencasts and not in writing anymore.

Currently the best way to learn OpenACS is to use google search. Why? Because they also index the forums smartly and we have a lot of hidden gems in there. Sadly it also increases the noise. Maybe .LRN 2.4 could be a documentation release (as it was with ZEN) while OpenACS 5.4 will be the "clean up bug-tracker" release? (the differentiation is purely to suggest who is in charge. .LRN consortium for documentation, OCT for bug-tracker cleanup)

Collapse
Posted by Torben Brosten on

For clarification purposes..

The description:

"The former (xowiki/openacs-handbook) has the intention of a categorized approach where pages are structured and presented differently depending on the target audience"

..is one interpretation of the documentation goals/requirements from https://openacs.org/xowiki/Documentation_Project_Plan. The stated goals are organized to be a book as much as any other book.. but that is a different topic from this thread.

The xowiki categorization of pages is a completely separate initiative from the documentation project, and perhaps deals more with the organization of the openacs.org website in its entirety.

The xowiki/openacs-handbook is just the next version of the "old" way. The old way had nearly identical goals etc, just a different strategy in reaching them. The old way's documentation project is viewable on this page: https://openacs.org/test-doc/docbook-primer. Which is easier to read, gets read, and is thus most useful? The xowiki/openacs-handbook way. Does the old way motivate anyone to take action (besides me)? The new way seems to at least keep readers from loosing interest in participating ;)