MAUSDevs » History » Version 58
Jackson, Mike, 09 February 2012 16:21
1 | 1 | Rogers, Chris | h1. MAUS Developer Documentation |
---|---|---|---|
2 | |||
3 | 43 | Rogers, Chris | h2. MAUS Documentation |
4 | |||
5 | 27 | Rogers, Chris | * MAUS Overview documentation |
6 | ** [[System architecture|Overview of MAUS structure]] |
||
7 | ** [[Release schedule]] |
||
8 | 39 | Rogers, Chris | ** [[Data Structure]] |
9 | 10 | Rogers, Chris | * Code documentation - doxygen documentation for each class, function, method etc |
10 | 3 | Rogers, Chris | ** "Framework":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_framework/html/index.html |
11 | 4 | Rogers, Chris | ** "Backend":http://micewww.pp.rl.ac.uk/embedded/maus/doxygen_backend/html/index.html |
12 | 42 | Rogers, Chris | |
13 | h2. Development workflow |
||
14 | |||
15 | 48 | Rogers, Chris | # [[Bzr_usage|Getting a development branch]] |
16 | 10 | Rogers, Chris | ** "Development branches of MAUS":https://code.launchpad.net/maus |
17 | 48 | Rogers, Chris | # [[CodingStandards|Coding Standards]] - minimum requirements for how code should be written |
18 | # [[Coding style]] |
||
19 | # [[Unit tests]] |
||
20 | # [[Application tests]] |
||
21 | # [[UserDocumenation|User documentation]] |
||
22 | # [[Code review]] |
||
23 | 49 | Rogers, Chris | # [[Bzr_usage#Merging-changes-from-your-branch-to-the-trunk|Merging code]] |
24 | 43 | Rogers, Chris | |
25 | h2. Procedures |
||
26 | |||
27 | * [[Release procedure]] |
||
28 | * [[Deployment]] |
||
29 | * [[Geometry release procedure]] |
||
30 | 12 | Rogers, Chris | |
31 | 50 | Rogers, Chris | h2. Other Information |
32 | 51 | Rogers, Chris | |
33 | 50 | Rogers, Chris | * [[MAUSSSI|Software Sustainability Institute / MAUS collaboration]] |
34 | ** [[MAUSHistogramReducers|Reducers and histograms]] |
||
35 | ** [[MAUSCeleryConfiguration|Celery Configuration]] |
||
36 | 54 | Jackson, Mike | ** [[MAUSRabbitMQ|RabbitMQ configuration and monitoring]] (development versions) |
37 | ** [[MAUSCelery|Celery configuration and monitoring]] (development versions) |
||
38 | ** [[MAUSCeleryRabbitMQRecovery|Celery error detection and recovery]] (development versions) |
||
39 | 50 | Rogers, Chris | ** [[MAUSDocumentCacheConfiguration|Document Cache Configuration]] |
40 | ** [[MAUSThirdPartyOnlineMonitoring|Third-party online monitoring examples]] |
||
41 | 56 | Jackson, Mike | ** [[MAUSDjangoApache|Deploying Django under Apache]] (under development) |
42 | 50 | Rogers, Chris | * [[Publications policy]] |
43 | * [[Jenkins]] |
||
44 | * [[Additional build flags]] |
||
45 | * attachment:MAUS_Work_Specification_Template.odt |