Deliverables for Documentation Week from Working Groups

Web Pages Working Group:  (Judy, Wyatt, Rick)

  1. List of needed new or updated web pages – Wyatt (done)
  2. New web area set up on CD webserver, access provided for sam account with .k5login – Judy (in progress)
    [Judy will be doing templates in Lab style for the pages below, with links or placeholders as defined by Wyatt and Rick.  Wyatt and Rick and others as designated will add actual links as they become available during and after Doc Week.]
  3. SAMGrid top level web page – for general public – Wyatt, Judy
  4. SAMGrid At Work page – for informed public & the project – Wyatt, Judy
  5. SAMGrid User page – Rick, Judy
  6. SAMGrid Technical page – for station admins and shifters – Rick, Judy
  7. SAMGrid Developer page – Lauri, Judy
  8. SAMGrid Project History page – Wyatt, Lee, Judy

Developers and Applications Working Group: Lauri, Stefan, Gabriele + all developers

  1. List of needed documents – Lauri, Stefan, Gabriele (done)
    [There’s a LOT of work in this list.  It can’t all be deliverable for this week.  I’ve listed my top priorities for the first deliverables below, but this is open to discussion in the working group.  I believe the group has an updated list with assignments for people, but I don’t have it at the moment.]
  2. Complete description of python API
  3. Complete description of C++ API
  4. Complete description of DBServer …

General Project Documentation: (Rick, Wyatt, Sinisa, Rob)

  1. List of needed documents – (in progress)
  2. Update of “What is SAM” document - Sinisa
  3. SAM architecture document (formerly known as SAM ARDA doc) – Sinisa, Rob, Igor
  4. Update of project management plan? – Rick, Wyatt

Station Admin Documentation: (Andrew, Adam, Robert, Igor, Ulrich, Joel)

  1. List of needed documents – Andrew (done)
  2. General overview of station functionality – Robert?
  3. General overview of grid-enabled station functionality – Igor?
  4. Complete description of station components – Andrew, Ulrich, Adam
  5. Station installation guide – Art, Andrew
  6. JIM execution site installation guide – Gabriele, Igor
  7. JIM submission site installation guide – Gabriele, Igor

User Documentation:  (Rick, Lauri, D0User, CDFUser, Mike D., Iain B.)

  1. Find a D0User and CDFUser to help - ?
  2. Make list of needed new and updated documents - ?
  3. .. DEFINITELY need a new FAQ, new basic user guides for each experiment
  4. ...need experiment-specific SAM user pages (D0 is done)
  5. …add JIM user documentation, incl JIM client installation guide
  6. … separate documentation for production users – MC and resconstruction farmers, file storage, …

Shifter Documentation: (Daria, Alan, D0Shifter, CDFShifter)

  1. Recruit D0Shifter and CDFShifter to help – Daria, Alan (in progress)
  2. Make list of needed new and updated documents – Daria, Alan (in progress?)
  3. …DEFINITELY need to work on Shifter FAQ

SAM Schema Documentation: (Julie, Anil, Adam, Rick, Randy)

  1. Make list of needed documentation - ?
  2. Text description of major areas of SAM schema – Julie, Anil, …
  3. Update of Adam’s doc for V4 to V5 schema upgrade
  4. Description of dev/int/prod model – Julie?
  5. Catalog web page with lists of versions deployed in dev/int/prod for each experiment, description of mini-dev’s, ??
  6. Document with wish list for further schema improvements

Project History Documentation: (Wyatt, Lee, Igor, Vicky)

  1. Project history web page (make sure it includes all old links we don’t want to lose)
  2. Project time line
  3. Personnel history
  4. Collect older design docs, talks, papers