2021-03-16 Tech Docs Meeting notes

Date

Mar 16, 2021

Participants

  • @Trevor Thornton

  • @Alicia Detelich

  • @Dave Mayo (Unlicensed)

  • @Rachel Searcy

  • @Blake Carver

  • @Mark Cooper (Unlicensed)

Discussion topics

Time

Item

Notes

Time

Item

Notes

10 mins

updates

10 mins

reviewing issues from Github

https://github.com/archivesspace/tech-docs/issues/99

This one is related to the static site generator project

https://github.com/archivesspace/tech-docs/issues/71

https://github.com/archivesspace/tech-docs/issues/70

These are suggestions for new documentation from Alicia. We should consider adding stub pages for these.

https://github.com/archivesspace/tech-docs/issues/66

Documenting API endpoints that don’t require authentication. Might be an issue for API docs working group.

Trevor will bring this up with API docs working group

20 mins

Tech Docs discussion at ArchivesSpace Online Forum,
March 30, 2021 (12-4 pm ET)

Trevor will send a message to list asking for questions, etc.

He will also make a list of documentation sources

10 mins

Any other business

 

Action items

Draft email to users lists to promote discussion session (so people will come with questions) (Trevor)
Add stub pages for topics in Github issues (@Alicia Detelich)
Begin (Trevor) and contribute to (all) a doc listing different indexing scenarios for a 'troubleshooting” page
List of documentation pages (repo, API docs, metadata mappings, etc.) to share at forum
Find existing stubs pages/sections in tech-docs repo
For API Working Group: add a note in documentation for endpoints that don’t require authentication

Decisions