caseywatson / azure-architecture-documentation-provider Goto Github PK

• How do I add docs to the doc library?
• How do I use the React front-end to generate a doc?

• Logic app is triggered by blob storage PutBlob event grid notification.
• Logic app should pull blob metadata to get list of email recipients.
• Logic app should download blob content (PDF) and add it as an attachment to email.

Pending Mr Pluta's plans

• How much time do engineers take on average per week composing and sending follow-up emails?
• On average, how soon do you send follow-up emails after customer calls?
  • What context is lost?

This API is called by the React front-end to initiate document generation through the Pandoc GitHub action.

• Should take array of MD documents to include (paths), document ID (guid), and email addresses that the final document should be sent to.
• Should call the appropriate GitHub action to generate the doc.

The default doc generated by the Pandoc GitHub action isn't pretty. Clean up and customize Pandoc formatting. For more information, see https://pandoc.org/MANUAL.html.

Restrict Mainline to PRs only, Owners are Senior/Principals. Add Code Reviews. The main point here is add governance to help facilitate up skilling.

Ensure folks know branch per issue & PR your branch. Forking is a pain, lets minimize that.

Generate Swagger. Rest Interface should have its Open API Doc generated and this can later be added to APIM.

Originally posted by @drcrook1 in #1 (comment)

• Provide a tree interface that allows users to navigate repo folders and MD files.
• User should be able to "check" MD files to be included in the doc.
• Idea -- Allow users to select folders to include all MD files therein in the doc. Makes it easier to include high-level information if needed.

Present to stake holders and get a go/no go decision.