Hi all, I would like to propose the following framework as a starting point to consolidate and improve the documentation that currently exists in various locations within the wiki. Please provide your feedback.
------------------------------------------- Getting Started ------------------------------------------- What is Matterhorn? A guide that provides an overview of the Matterhorn system and concepts. System Requirements What do you need to get started Installing Matterhorn A guide on how to download and install Matterhorn Configuring Matterhorn A guide on how to properly configure Matterhorn Making your Matterhorn Installation Production Ready A guide on how to proactively monitor a Matterhorn system Design Considerations for Your Installation Matterhorn is flexible by design, this guide will provide tips for you to consider when deploying the platform ------------------------------------------- Developing for Matterhorn ------------------------------------------- Developer System Set-up A guide on how to get your development environment set-up Committing Code A guide on how to contribute code/patches to trunk. Writing Unit Tests A guide on writing unit tests Writing Integration Tests A guide on writing integration tests Using Matterhorn Services A guide to taking advantage of the Matterhorn Service Oriented Architecture (SOA) ------------------------------------------- Contributing to Matterhorn ------------------------------------------- How to Become a Committer A guide for how/why you become a committer Committer Guidelines The do's and don'ts of a committer Documentation Guidelines A guide outlining the community framework for documentation and expectations. QA/Testing Guidelines A guide for how you and your institutions can help improve Matterhorn On Aug 27, 2012, at 11:53 AM, Brian O'Hagan <[email protected]> wrote: > Hello all, > > Some updates and a new proposal for your review on the on-going plans for > wiki gardening: > > Given the response from the community, automated archiving of items within > the Opencast wikis is off the table for now. > > Instead, a new #proposal is on the table to focus on updating MHDOCS manually > and with care, with a focus on content that is useful for an adopter > audience. To do so, the documentation working group proposes this path: > > 1 -- open up access for anyone in the community to edit and modify MHDOCs > 2 -- develop a new color and design theme for MHDOCs, so that it is visibly > different and identifiable as a wiki geared for Matterhorn adopters. > 3 -- a new organizational structure for MHDOCs would be drafted and proposed > further for community approval > 4 -- Contingent on the approval of the organizational structure: decide on > content that can be moved from the developers wiki to MHDOCs; invite new > content within the revised structure of MHDOCs; solicit contributors that can > develop new guides for MHDOCS; revise the format of Release Docs. > > Please provide your feedback, comments, and general feelings on this proposal > so this effort can move forward toward improved documentation for use by you > and by others. Thanks! > > The Documentation Working Group > _______________________________________________ > Community mailing list > [email protected] > http://lists.opencastproject.org/mailman/listinfo/community > > > To unsubscribe please email > [email protected] > _______________________________________________ _______________________________________________ Matterhorn mailing list [email protected] http://lists.opencastproject.org/mailman/listinfo/matterhorn To unsubscribe please email [email protected] _______________________________________________
