diff --git a/.gitattributes b/.gitattributes index 57fdd4445e64d5a8fa24085f4b48ebbddca32111..046724231e5296c9ca4477c9e3f8f7e04a37fe14 100644 --- a/.gitattributes +++ b/.gitattributes @@ -3,7 +3,9 @@ CAL/CMakeLists.txt -text CAL/CalibrationCommon/CMakeLists.txt -text CAL/CalibrationCommon/bin/CMakeLists.txt -text +CAL/CalibrationCommon/doc/CalibrationCommon.md -text CAL/CalibrationCommon/doc/Holography_Data_Set.txt -text +CAL/CalibrationCommon/doc/package.dox -text CAL/CalibrationCommon/lib/CMakeLists.txt -text CAL/CalibrationCommon/test/CMakeLists.txt -text CAL/CalibrationCommon/test/t_holography_beam_specification_class.py -text diff --git a/CAL/CalibrationCommon/doc/CalibrationCommon.md b/CAL/CalibrationCommon/doc/CalibrationCommon.md new file mode 100644 index 0000000000000000000000000000000000000000..d7775634788bfe6436510f86c9c138884ab202f3 --- /dev/null +++ b/CAL/CalibrationCommon/doc/CalibrationCommon.md @@ -0,0 +1,87 @@ +# CalibrationCommon {#CalibrationCommon} + +## GENERAL +The CalibrationCommon package contains documentation and software that concerns all areas of LOFAR calibration. + +### Description +- *What does it do?* +- *Why is it needed?* + +### Author/Owner + +### Overview +- *Add a diagram* +- *Add a link to the overview diagram* +- *Add a link in the overview diagram to link back to this documentation*. + +- - - + +## DEVELOPMENT + +### Analyses +*Add non-technical information and functional considerations here, like user requirements and links to minutes of +meetings with stakeholders.* + +### Design +*Add technical considerations and design choices here* + +### Source Code +- *Add a link to svn (trunk).* +- *Add a link to (generated?) source code documentation.* + +### Testing +- *How do you run unit tests?* +- *How do you run integration tests?* +- *Add a link to Jenkins jobs (if available)* + +### Build & Deploy +- *Add a link to general instructions or describe specifics here.* +- *Add a link to Jenkins jobs (if available)* + +- - - + +## OPERATIONS + +### Configuration +- *Where is the configuration file?* +- *What are the configuration options?* + +### Log Files +- *Where are the log files?* + +### Runtime +- *Where does it run? (which user@machine)* +- *How do I run it? (user documentation? examples? commandline parameters?)* +- *Other considerations? (what happens elsewhere when I start or stop it?)* + +### Interfaces (API) +- *Describe interfaces to other applications (REST API? http requests? Messagebus?)* +- *Other communication (user? import/export?)* + +### Files/Databases +- *Which databases are used?* +- *Which files are used?* + +### Dependencies +- *To/from other applications?* +- *Files?* +- *Network locations?* +- *Other?* + +### Security +- *Special privileges needed?* +- *User login?* +- *Certificates needed?* +- *Other considerations?* + +- - - + +## ADDITIONAL INFORMATION + +### User Documentation + +*e.g. Please refer to URL X for the User Documentation* + +### Operations Documentation + +*e.g. Please refer to URL X for Operations Documentation* diff --git a/CAL/CalibrationCommon/doc/package.dox b/CAL/CalibrationCommon/doc/package.dox new file mode 100644 index 0000000000000000000000000000000000000000..d2b0c9136fecfcbc1314bcc812736d9ef171ff16 --- /dev/null +++ b/CAL/CalibrationCommon/doc/package.dox @@ -0,0 +1,9 @@ +/** + +\ingroup Packages +\defgroup CalibrationCommon CalibrationCommon + +\ref CalibrationCommon + +The CalibrationCommon package contains documentation and software that concerns all areas of LOFAR calibration. +*/