Skip to content
Snippets Groups Projects
Commit 646a2768 authored by Thomas Jürges's avatar Thomas Jürges
Browse files

SW-90: Started the md for Messaging.

parent 0de1c149
No related branches found
No related tags found
No related merge requests found
......@@ -1570,6 +1570,7 @@ LCS/MessageDaemons/webmonitor/Schema.svg.ccu099 -text
LCS/MessageDaemons/webmonitor/start_QPIDWebMonitor -text svneol=unset#text/x-shellscript
LCS/MessageDaemons/webmonitor/stop_QPIDWebMonitor -text svneol=unset#text/x-shellscript
LCS/Messaging/CMakeLists.txt -text
LCS/Messaging/doc/Messaging.md -text
LCS/Messaging/doc/package.dox -text
LCS/Messaging/include/Messaging/CMakeLists.txt -text
LCS/Messaging/include/Messaging/DefaultSettings.h -text
......
# Messaging {#messaging}
## GENERAL
### 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*
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment