2020-10-20 Tech Docs Meeting notes

20-30 mins

Static site generators for tech docs site

• https://docs.google.com/spreadsheets/d/1GJDw1fYG7EMFG_maR9sxehzRwj0QUph4ZmOPBCxLM4c/edit#gid=0

• Blank (and Mark) will start with Jekyl via GitHub pages and see how it works

• Will determine what is needed from TAC after test implementation

20-30 mins

Tech docs repo organization

• https://docs.google.com/spreadsheets/d/1XU9HPWMqJN_sIe7NlgnjNDo5HkE2UN1oFBST04ItBzY/edit?usp=sharing

• “for code contributors” might need some more introductory material for nubies

• task/activity-focused organization

• maybe move running a development version to section about running an instance

• maybe use multiple organization schemes (by role vs by function)

• Roles:

  • Implementation for production

  • Evaluation of AS

  • Developers (code contributors)

  • Technical troubleshooting

  • Contributing code

  • MORE

• need documentation of entity relationship model (how records relate to each other)

• links from Alicia:

  • https://github.com/archivesspace/tech-docs/tree/backend_docs/architecture/backend

  • 
https://github.com/archivesspace/tech-docs/blob/backend_docs/architecture/backend/database.md 
https://desolate-tundra-60608.herokuapp.com/
    

• Need updated data dictionary