Major Feature #5246
Documentation
| Status: | Needs Feedback | Start date: | 2009-11-05 | ||
|---|---|---|---|---|---|
| Priority: | Must have | Due date: | |||
| Assignee: | Lars Lehners | % Done: | 50% |
||
| Category: | Documentation | ||||
| Target version: | Alpha 2 | ||||
| Votes: | 1 (View) |
Description
We need to have a documentation.
- What is the "caretaker"s job?
- Installation
- Configuration
- ...
i think for alpha1 we need at least a basic setup and configuration guide.
Related issues
| related to Caretaker - Task #7583: Review and complete documentation | Needs Feedback | 2010-05-01 |
History
Updated by Martin Ficzel almost 3 years ago
- Target version changed from Alpha 1 to Alpha 2
I moved the ticket to alpha 2 since alpha 1 is already in TER. New updates of the documentation should be added to the wiki. The new documentation will be generated from there.
Updated by Thomas Hempel almost 3 years ago
- Status changed from New to Needs Feedback
What's the status of this? Can we close this ticket?
Updated by Lars Lehners almost 3 years ago
- Priority changed from Should have to Must have
- % Done changed from 0 to 50
I suspect the special notes in this issue are still not done because there was lack of time for me to do this. So please do not close this ticket.
Beyond I think the doc should contain a tutorial with an example setup and a small paragraph about the installation of an caretaker instance.
For now I'll try to work on it step by step on the next weekends.
Updated by Martin Ficzel almost 3 years ago
I recommend to create / update all documentation in the Wiki-Manual so we can all review and edit the documentation. I moved the existing manual to the wiki and added the other parts of documentation we had as seperate chapters.
A first step would be to go through the docs and to create a list of empty/incomplete/missing chapters to assign them to the authors. Same goes for the needed screenshots. This should be done in the Manual Todo Section of the wiki.
When the wiki documentation is in good shape we will convert it back to an OO-Document.
Regards, Martin