wiki:developers-meeting-20101014
Last modified 10 years ago Last modified on 10/15/10 12:39:49

Table of Contents

  1. Participants

[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:

  1. developer writes a new piece of code
  2. developer opens a ticket: new component has been written needs documenting
  3. developer writes an initial blob of information in wiki
  4. documentation-maintainer takes this information and merges the information into the book.
  5. documentation-maintainer closes ticket.

Story 2:

  1. developer changes some code where she knows is documented in the book,
  2. developer opens a ticket: new component has been written needs documenting
  3. developer writes an initial blob of information in wiki
  4. documentation-maintainer takes this information and merges the information into the book.
  5. documentation-maintainer closes ticket.

Story 3:

  1. developer changes some code that affects documentation but doesn't realise it
  2. reviewer notices and doesn't mark "Ship It!" until the ticket is created.
  3. developer opens a ticket: new component has been written needs documenting
  4. reviewer marks patch "Ship It!"
  5. developer writes an initial blob of information in wiki
  6. documentation-maintainer takes this information and merges the information into the book.
  7. documentation-maintainer closes ticket.

Story 4:

  1. User reports documentation problem (missing or inaccuracy).
  2. documentation-maintainer opens a documentation ticket
  3. developer writes an initial blob of information in wiki
  4. documentation-maintainer takes this information and merges the information into the book.
  5. 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