...
- Small number of folks met Oct 28th for doing a one-day documentation review.
- Not a technical review, focused on community perspectives
- Marked docs that could be improved
- Good notes/suggestions on ways things can be improved. Mostly around better organization, de-duplication, defining things better. These notes can drive documentation updates
- There may be a couple people who are interested in documentation during the sprint, but there may be enough suggestions to support a documentation sprint later on this year or next year.
- Most of the suggested improvements are not technical, so it is not necessary for doc writers to be committers, developers, etc
- awoods: Each release has their own wiki space, but we have a 5.x "head". It looks like the 5.x "head" is what was reviewed. Presumably, it'll be re-named to 6.0. A bulk of the review is likely based on 4.x/5.x understanding. New content and/or updates would need to be added for fcrepo6
- dwilcox: Hopefully, the front-facing parts of fcrepo6 won't change that much from 4/5, but new docs will be needed.
- Fcrepo6 documentation was out of scope for this review. That could be its own sprint, not sure if it should be its own separate effort, or part of a fcrepo6 sprint. Difficult to do anything for fcrepo6 yet, since it doesn't exist. It'd be difficult to write docs for it at this point.
- Desire for a regular rhythm for doc updates.
...
- Islandora stores it's documentation in Markdown . Might be something we want to consider for Fedora.
- It makes it easier to couple code changes with documentation changes.
- ISLE also does this.
- There are pros/cons to docs in markdown, but it'll be interesting to watch how other projects evolve
Fedora and OCFL:
Actions
- Aaron Birkland to look explore notion of OCFL client with database as authoritative metadata source + asynchronous writing of the inventory.json file
- David Wilcox will review the NDSA matrix and pull out the concrete technical requirements that could be considered during the Fedora 6 development.
- Call for comments on https://docs.google.com/document/d/18rSFqqoxixmozZrgPKON59Ojpg5iOu4lsHDNMm23soY/edit# till tuesday
- Clarify in in documentation that multiple simultaneous writes to OCFL are not supported
...