2021-04-20 Tech Docs Meeting notes

Date

Apr 20, 2021

Participants

  • @Trevor Thornton

  • @Alicia Detelich

  • @Dave Mayo (Unlicensed)

  • @Rachel Searcy

  • @Blake Carver

  • @Mark Cooper

Discussion topics

Time

Item

Notes

Time

Item

Notes

10 mins

updates

15 mins

API Docs Working Group

Questions:

  • Who will serve as administrative lead next year?

  • What will happen after@Dave Mayo (Unlicensed) leaves TAC after next year?

  • Can Tech Docs sub-team assume administrative/organizational responsibility for the ongoing API Documentation work?

  • Can Core Committers add missing endpoint documentation whenever controllers are updated?

Answer, maybe:

Maybe ASpace devs can take on the bulk of the API documentation work and integrate it into other development - i.e. make endpoint documentation part of their workflow

15 mins

Tech Docs sub-team leadership for next term

We need a new Chair and Vice Chair, each of whom should ideally be selected from the current TAC members on the team

15 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
Trevor will email Brian, Lora, etc. to discuss how to get API Docs work done in conjunction with AS development

Decisions