Stakeholder engagement: which API documentation UI to use?

[shmonks]

Overview

We need to get feedback from stakeholders about preferred form of API documentation, following Fang's research indicating pros and cons of two main options: Swagger and Redoc

Action Items

• Create draft of slide deck
• Review
• Send link to Bonnie for feedback
• Send message to VRMS (and CTJ?) PMs, asking if we can join one of their team meetings to talk about it, with link to version of slide deck saved to local drive

Resources/Instructions

• Add OpenAPI (swagger) docs to our documentation #239
• Swagger UI vs. Redoc #381
• People Depot Team Meeting Agenda #103 (comment)
• Draft of slide deck for stakeholders

[shmonks]

Hi @vanessaavviles - please consider the following questions and add an update below:

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. Pictures (if necessary): "Add any pictures that will help illustrate what you are working on."

[vanessaavviles]

Fang could not make the meeting this past tuesday, so we will work on going through the presentation all 3 of us next tuesday's meeting and have it ready to show the team thursday of next week.