NOTE:
...
THIS WORKING GROUP HAS CONCLUDED AS OF JANUARY 2019
(See Conclusions of the Samvera Documentation WG)
Scope & Objectives
This working group has been chartered to implement concrete improvements to developer documentation within the Hydra communitySamvera Community. These improvements were identified during LDCX^8 and the Hydra Developer Congress held on March 27-31, 2017 at Stanford.
...
- Increase inline documentation coverage and improve quality for repositories under https://github.com/projecthydrasamvera.
- Establish http://projecthydrasamvera.github.io as the primary home for instructional documentation.
- Define community expectations for coverage and quality of documentation.
...
- Choose one or more tool for measuring coverage and quality of inline docs.
- Use metrics from chosen tools to establish achievable targets.
- Achieve the targets.
Improving http://
...
samvera.github.io
- Implement a theme and layout that provides easier discovery and navigation than current options (e.g. the Duraspace Wiki).
- Reorganize existing content on projecthydra samvera.github.io, preserving any legacy links.
- Identify instructional documentation from other sources that should be migrated http://projecthydrasamvera.github.io, archived somewhere, or deleted.
...
We track issues we're working on via github issues and a github project
Sprints and Other Efforts to Improve Documentation
- Documentation Effort - interviews and reorganization of site (2017-11-21)
- Work Sessions
- Workspace: Hyrax feature spec reorganization
Time frame
Initial timeframe will be May - August 2017. We will meet in early September 2017 to decide whether to re-charter.
...
- TODO: Choose a facilitator
- Elizabeth Elizabeth (Data Curation Experts)
- Aaron Collier (California State University)
- Jennifer Lindner (Art Institute of Chicago)
- LaRita Robinson (University of Notre Dame)
- Andrew Myers (WGBH)
- James Griffin (Lafayette College Libraries)
- Lynette Rayle (CornellLynette Rayle (Cornell)
- James Griffin (Princeton University Library)
Meeting Times
Doodle poll for our first meeting phone call: https://doodle.com/poll/uxkddrmia6r3332i
...
| Child pages (Children Display) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Communication channels
- Slack channels under the Project Hydra team (project-hydrasamvera.slack.com):
- #documentation - used for discussion specific to this working group.
- #dev - used for more general development discussions, and to get developer feedback.
- "HydraSamvera-Tech" Google Group
- Hydra Samvera Tech Call (weekly)
Resources
- Hydra Samvera Documentation Working Group on Github - Repository for issue tracking and other working documents.
- White board images from Docs WG breakout during Samvera Connet 2018:
NOTE: The Call for Participation (CfP) for this working group was from Monday, April 10, 2017 through Tuesday, April 25, 2017.
NOTE: This is a first draft of the charter. The scope, objectives, deliverables, and timeline may change before the close of the CfP. After the CfP is closed, the working group will move forward based upon the version of the charter at that time. Any further changes will only be made by consensus of the working group.