Project

General

Profile

MAUSDevs » History » Revision 57

Revision 56 (Jackson, Mike, 09 February 2012 16:17) → Revision 57/133 (Jackson, Mike, 09 February 2012 16:18)

h1. MAUS Developer Documentation 

 h2. MAUS Documentation 

 * MAUS Overview documentation 
 ** [[System architecture|Overview of MAUS structure]] 
 ** [[Release schedule]] 
 ** [[Data Structure]] 
 * Code documentation - doxygen documentation for each class, function, method etc 
 ** "Framework":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_framework/html/index.html 
 ** "Backend":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_backend/html/index.html 

 h2. Development workflow  

 # [[Bzr_usage|Getting a development branch]] 
 ** "Development branches of MAUS":https://code.launchpad.net/maus 
 # [[CodingStandards|Coding Standards]] - minimum requirements for how code should be written 
 # [[Coding style]] 
 # [[Unit tests]] 
 # [[Application tests]] 
 # [[UserDocumenation|User documentation]] 
 # [[Code review]] 
 # [[Bzr_usage#Merging-changes-from-your-branch-to-the-trunk|Merging code]] 

 h2. Procedures 

 * [[Release procedure]] 
 * [[Deployment]] 
 * [[Geometry release procedure]] 

 h2. Other Information 

 * [[MAUSSSI|Software Sustainability Institute / MAUS collaboration]] 
 ** [[MAUSHistogramReducers|Reducers and histograms]] 
 ** [[MAUSCeleryConfiguration|Celery Configuration]] 
 ** [[MAUSRabbitMQ|RabbitMQ configuration and monitoring]] (development versions) 
 ** [[MAUSCelery|Celery configuration and monitoring]] (development versions) 
 ** [[MAUSCeleryRabbitMQRecovery|Celery error detection and recovery]] (development versions) 
 ** [[MAUSDocumentCacheConfiguration|Document Cache Configuration]] 
 ** [[MAUSThirdPartyOnlineMonitoring|Third-party online monitoring examples]] 
 ** [[MAUSDjangoApache|Deploying Django under Apache]] (under development) 
 ** [[MAUSDjangoWebFrontEnd|Deploying [[MAUSDjangoApache Deploying Django web-front end]] under Apache]] (under development) 
 * [[Publications policy]] 
 * [[Jenkins]] 
 * [[Additional build flags]] 
 * attachment:MAUS_Work_Specification_Template.odt