Agenda/Meeting Notes 2019-01-14

• AD - still have some issues to submit per action items from last meeting

• Archon-AS migration
• Locales
• Solr params - have some of this info in the tech docs configuring AS section.

• Question: why is info about reports module part of the developer docs? Move to customization and configuration?
• Developer docs just have info about setting up a development environment and building a release. That is fine, but in order for developers to get going it might also be good to flesh out the architecture and components section a bit more
• Where do you go in the code to do X
• What is the business purpose of all of the various model classes?

Please add your notes here!

1. Introduction (6:04)

* this video is almost seven years old and is from version 1. should it be updated? (the next three are fine)
* overview of the interface
* overview of the (seven-year-old) technical documentation
* overview of the technical architecture

2. Backend Introduction (6:33)

* intro to querying the backend using curl
* creating resources and accessions
* basics of JSONSchema, validations for fields

3. JSONModel (6:56)

* how JSONModel works
* how its validation rules clean up data and return errors for invalid inputs
* using irb to display the entirety of the accession JSONModel
* working with JSONModel properties for accessions

4. Backend Controllers (4:35)

* review of the controller layer
* defining REST endpoints for the ArchivesSpace API
* design patterns for defining endpoints -- parameters to pass, pagination T/F, permissions to query them

9. Backend Summary (10:00)

* Review data flow from request to endpoint through backend codebase
* Examines request context by adding trace statements at various points in the code flow
* Covers curl_as utility script, which simplifies calling API endpoints via curl

10. Frontend Introduction (3:17)

* very basic overview of staff interface (frontend)
* intro to Twitter bootstrap templates and js component overrides
* intro to JQuery plugins used

11. Access Control (0:59)

* covers how user access is enforced in front end controllers by mapping abilities (eg 'view repository', etc.) to actions in the controller

12. JSONModel Client (1:35)

* covers shared 'handle_crud' method used in controllers
* basic intro to JSONModel::Client module

13. Frontend Form Helper (5:02)

* Very little of this is in the docs and could be useful

14. Locales (1:11)

* Most of this is already covered in the docs

15. Frontend Locales (2:03)

* Add info about the _frontend .yml entry to docs

16. Frontend Themes (5:04)

* This video is linked in the docs. Most of the content could be converted to written docs

17. Indexing

* Much of this is already in the docs but could be fleshed out a bit based on what is in the video

18. ArchivesSpace Build System

* A fair bit of this could still be added to the docs

19. Installation (12:19)

* All of the content in this video is already represented in the written documentation

Also I (Kevin) am reviewing the API Docs videos per Dave's request. Not sure I'll get through them all before 11:00 but so far they're really good. My only suggestion would be to divide them up into chapters for each file that Dave talks about, in case half-hour videos are too much for folks to digest at once or if they want video docs for one specific part of the documentation.

• Follow up on solr customization listserv thread
• Add developer screencast links to tech-docs
• Create a directory structure/outline for architecture and component section of tech-docs (AD)
  • Other tech docs members can begin enhancing docs by creating stubs or directories as the mood strikes
• PR to move reports section to customization section
• Split up 1st API docs video into two videos
  • Eventually: convert to written docs or more formal scripted screencast
• Contact Jessica Crouch re: survey, open call