Hydra Tech Call 2015-05-27

Owned by Bill Branan
Jun 16, 2017
2 min read

Time: 9:00am PDT / Noon EDT

Call-In Info: 1-530-881-1400, access code 651025

Moderator:  justin (DCE)

Notetaker:  Michael Joseph Giarlo (Penn State)

Attendees: 

  • Lakeisha Robinson (Yale)
  • Katheryn Lynch (Temple)
  • Collin Brittle (Virginia Tech)
  • David Chandek-Stark (Duke)
  • Adam Wead (Penn State)
  • Thomas Scherz (Cincinnati)
  • Matt Zumwalt (independent)
  • Corey Harper (New York University)
  • Tom Johnson (Digital Public Library of America)
  • Trey Terrell (Oregon State)
  • Anna Headley (Chemical Heritage Foundation)
  • Drew Myers (WGBH)
  • Michael Klein (Northwestern)
  • Carolyn Cole (Penn State)


Agenda:

  1. Call for agenda items
    1. No new items
  2. Improving Inline Documentation (Tom Johnson)
    1. Do we have a standard approach for inline documentation? (YARD?)   (Ex. Hydra::Works::RemoveGenericFile, ActiveTriples::LocalName::Minter)
    2. What can we do to improve/clarify our expectations about documentation of our interfaces & contracts in new code?
    3. Do we have aspirations of improving inline documentation for the existing code base?
    4. Broad agreement that we should be better at this. It would make it easier for coders to get into the codebase.
    5. It'd be helpful to provide a YARD template to base other documentation on. Good examples in our code (e.g., in ActiveFedora).
    6. Ideal: some integration in the CI system to let us know when "coverage" increases or decreases.
    7. ACTION: Anna to add to the CONTRIBUTING document for all Hydra repositories: use YARD documentation for new public methods, classes, and modules, and include checking for coverage as part of our pull request process.
    8. ACTION: Anna to edit the outdated contributing doc on the DuraSpace wiki so it links to our Hydra repo version on GitHub.
  3. Hydra PCDM FAQ page (Drew Myers)
    1. Collect answers to FAQs through http://goo.gl/forms/2pK1bHNthp.
    2. Combine them into coherent answers.
    3. Post them here:  Samvera and the Portland Common Data Model (PCDM)
  4. Update: CurationConcerns, CurationEngine, Sufia, etc. (Matt Zumwalt)
    1. Work has started up the stack in the new PCDM-based gem constellation: https://github.com/pulibrary/curation_concerns
    2. Naming of proposed gems is likely to change. Stay tuned for a proposal!
  5. Next call
    1. Date: June 3, 2015
    2. Moderator:  Steven Ng
    3. Notetaker:  Adam Wead