Meeting Link: https://yalelibrary.zoom.us/j/943909973
Present:
Absent:
Notes:
| Topic | Notes |
|---|
| Updates from group |
|
- Listserv activity
- Documentation citations
- Documentation enhancement suggestions
- Advanced queries – technically API but somewhat different
- Permissions
- MARCXML ingest (user docs?)
|
|
- Other potential docs enhancements
- Docs for running dev server – i.e. documenting ports for backend
- Plugin structure for models
- Subrecord oddities, differences between top level records and nested records.
- Better documention of JSONModel; templates? (Bobbi had mentioned this) – AD has done some work toward this
- Should create issues or stub records for these as they come up
|
|
- Work plan goals/timeline for docs enhancements
- Developer onboarding
- Review existing docs before next meeting
- AD will create Google doc or other shared tool for brainstorming what kinds of things should be added/updated – ultimately could submit issues to tech docs once we have a better sense of what we want to do
- Developer screencasts
- Review existing screencasts between now and next meeting, make notes on what should be added or updated in written documentation
- Generalized API documentation
- Different brainstorming doc?
- Some ideas: generalized (narrative) tutorial for authenticating, sending different types of requests. Note parameters that are used across endpoints – pagination, all_ids; better indicate that only top-level records have URIs that can be directly requested via the API
- Thoughts on this process/timeline?
|
|
Other work plan thoughts? |
|
| API docs working group update |
|