[Lustre-devel] Document Database Re: [Lustre-discuss] [wc-discuss] Seeking contributors for Lustre User Manual
aik at fnal.gov
Wed Nov 14 11:47:21 PST 2012
On Nov 13, 2012, at 3:26 PM, Ned Bass wrote:
> On Tue, Nov 13, 2012 at 11:48:35AM -0800, Nathan Rutman wrote:
>> Would it be easier to move the manual back to a Wiki? The low hassle
>> factor of wikis has always been a draw for contribution. The openSFS
>> site is up and running with MediaWiki now (wiki.opensfs.org).
> Easier? Yes, probably. Better? I personally don't think so. Wikis are
> great collaboration tools for informally sharing information, but I
> don't think the paradigm scales well for documents of this size and
> complexity. And a wiki isn't the right tool for producing a formal
> professional-quality document, which is what I think the Lustre manual
> should strive to be.
> True, we would lower the bar for contributions, but for that we would
> sacrifice the following features that I consider essential.
> - Ability to export to multiple formats (pdf, html, epub) from one source
> - Consistency of formatting and navigation elements
> - A review process for proposed changes that assures a high standard of quality
- ability to track changes between document versions to incrementally update 'higher level' documents
> However, there are some short articles that probably do belong in the
> wiki that could be poached from the manual, i.e. installation and
> configuration procedures, etc.
And also the other way around: detailed articles on wiki written by developers can be later 'harvested' by professional writer into manual chapter, referencing to wiki for details.
Lowering entry bar is vital to encourage developers to write or update documentation.
In addition to wiki and "manual" it will be nice to have Document Database, where conference reports, RFCs, RFP, HLD, DLD, ... can be committed, updated and later searched.
Something like DocDB
Document format can be any.
DocDB has been created to keep track of documentation in large collaboration - BTeV experiment - and then used by several others. DocDB has ability to manage access rights to some documents.
I think we need all three - wiki, DocDB and manuals, they serve different purpose.
Right now lustre support tips and hints are living on lustre-discuss list. It is tedious to search emails (no tags,no links), and when the answer found, there is no guarantee it is still relevant.
It can be useful to accumulate tips and best practices in Knowledge Base and have mechanisms to update it, e.g. instead of answering directly to the list create entry in KB and post the ref. to the list.
> Lustre-discuss mailing list
> Lustre-discuss at lists.lustre.org
More information about the lustre-devel