Hi Chris et al,
Yeah your points make perfect sense. Being nice and flexible it makes
sense to move as much of the dynamic stuff over as possible to allow
minions like myself to edit and maintain it without having to deploy a
whole new website, but then people do need to be able to find it to make
use of it :)
Organising the wiki pages into different folder structures also helps us
work out whats missing and what needs expanding on in terms of
documentation and tutorial stuff.
A some of the stuff in the CAS section for example seems largely brain
dump content and either repetitive or along the same lines of other docs
in there, it would make sense at some point for me to sit down and sift
through the information and concatenate some wiki pages and split out
others maybe into the Tutorial sections or other areas.
Tom
On 16/07/13 06:15, Mattmann, Chris A (398J) wrote:
Hey Tom,
This makes great sense to me and I'm glad you're offering your valuable
time and cycles to get the wiki organized. I think a multi-pronged approach
of:
* The website for releases -- static content, updated infrequently
* Pointers to wiki for *active* documents, and links from the website
displayed
more prominently
* Encouraging users to start at the wiki -- and really only head to the
website
for downloads, and for long standing information about the project and team
Will make a huge difference. I'll try and help where I can and thanks. I
plan on putting a bow on the Apache OODT 0.6 RC and pushing the release
tomorrow since the VOTE has already passed.
Cheers!
Chris
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Chris Mattmann, Ph.D.
Senior Computer Scientist
NASA Jet Propulsion Laboratory Pasadena, CA 91109 USA
Office: 171-266B, Mailstop: 171-246
Email: [email protected]
WWW: http://sunset.usc.edu/~mattmann/
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Adjunct Assistant Professor, Computer Science Department
University of Southern California, Los Angeles, CA 90089 USA
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-----Original Message-----
From: Tom Barber <[email protected]>
Reply-To: "[email protected]" <[email protected]>
Date: Friday, July 12, 2013 1:18 PM
To: "[email protected]" <[email protected]>
Subject: OODT Documentation Organisation
Hi guys
Whilst working on getting to know OODT better I walked through the CAS
Curation tutorial on the website and found it both hard to read and
buggy in places. I also (as a newbie) found getting started and tutorial
stuff tricky to locate with bits being on the main website and some on
the wiki. I guess this is left over from the Apache ingestion.
I took the liberty of migrating the original Curation tutorial over to
the wiki and made a few tweaks although I would like to improve this
further over the next week or so:
https://cwiki.apache.org/confluence/display/OODT/Deploying+and+using+CAS+C
urator
My question is really this, is there a documentation policy with regards
to creating stuff and guiding new users. Personally I feel that as much
of the documentation as possible should be moved across to the wiki to
allow users to develop and maintain it as OODT grows and changes (and
allows people to fix errors). Also finding the wiki isn't very obvious
>from the main OODT website, I would suggest that whoever maintains the
website puts the wiki link into the header or something allowing people
easy access to it, otherwise its buried in various page menus.
Having worked closely with a number of open source tools over the years,
especially as a newbie, I find the wiki documentation invaluable in
getting started and guiding new users, if no one has any objections I'd
like to put some time and effort into organising the wiki and landing
pages on their in a way that helps guide people in a more effective
manner. This will clearly be extended as I learn more myself :)
Cheers
Tom
