Pair Documentation Breakout Planning

Samvera Community Wiki


Pair Documentation Breakout Planning

Planning for http://connect2015.curationexperts.com/sessions/13

Since we'll only have 50 minutes, I hope we can prep here by collecting gems and particular areas therein which are begging for documentation. We can also use this page to help organize pairs.

 

Link to candidate gem / area therein (feel free to add additional notes)

I know something about this gem

I know little / nothing about this gem

Link to candidate gem / area therein (feel free to add additional notes)

I know something about this gem

I know little / nothing about this gem

https://github.com/projecthydra-labs/hydra-works

contents of lib/hydra/works/models/concerns

@Colin Gross

 

https://github.com/projecthydra/sufia (documentation improvement suggestions)

@Michael Joseph Giarlo

 

active fedora associations - maybe more of a guide than an inline documentation - example use cases, how do they fit with / differ from activerecord analogies, where is the fit uncomfortable with rdf.

 

 

active fedora - indexing. clarify difference in function / use of IndexingService and RDF::IndexingService. comb through other indexing-related modules. method-level comments are good but it's hard to tell how things fit together.

 

 

Blacklight search builder behavior – understanding how Solr cache and interface presentation layer interact (around /lib/blacklight/solr/search_builder_behavior in particular)