Table of Contents
[part of a series of meetings]
Participants
Antje, Patrick, Paul, Jan, Karsten, Christian
AP/ Patrick to ask about legal issues with allowing people to write comments on Book.
Use the wiki
Story 1:
- developer writes a new piece of code
- developer opens a ticket: new component has been written needs documenting
- developer writes an initial blob of information in wiki
- documentation-maintainer takes this information and merges the information into the book.
- documentation-maintainer closes ticket.
Story 2:
- developer changes some code where she knows is documented in the book,
- developer opens a ticket: new component has been written needs documenting
- developer writes an initial blob of information in wiki
- documentation-maintainer takes this information and merges the information into the book.
- documentation-maintainer closes ticket.
Story 3:
- developer changes some code that affects documentation but doesn't realise it
- reviewer notices and doesn't mark "Ship It!" until the ticket is created.
- developer opens a ticket: new component has been written needs documenting
- reviewer marks patch "Ship It!"
- developer writes an initial blob of information in wiki
- documentation-maintainer takes this information and merges the information into the book.
- documentation-maintainer closes ticket.
Story 4:
- User reports documentation problem (missing or inaccuracy).
- documentation-maintainer opens a documentation ticket
- developer writes an initial blob of information in wiki
- documentation-maintainer takes this information and merges the information into the book.
- documentation-maintainer closes ticket.
TODO:
- Go through book, check actuality of chapters, try to apply structure on the way.
suggestion: split chapters
--> Installation Script: optionally provide script that includes all the commands of dCache install chapter (dCache configure) --> System Requirements: one requirement that postgre is installed --> link to postgre installation in requirements --> Antje, Karsten, Christian rewrite "Getting started" chapter
- Go through dCache Wiki, check for actuality
