Contributing¶

Setup¶

See README.md for instructions on local development.

Create a local branch, such as feature/add-api-diagram to commit changes.

Create a pull request to merge to main.

Avoid using html whenever possible. Most types of content can be described with markdown and features of mkdocs.

Diagrams are created with PlantUML. The C4 model is used when appropriate.

A plugin is used to generate the diagrams in /docs/diagrams to svg in the pipeline.

For existing Visio diagrams, there does not appear to be a way to inline content from Sharepoint. Do not add the Visio file to the repo.

Options: - Rebuild the diagram via plantuml. - Create a link to the diagram on sharepoint that is available to anyone in JHA.

Generated visuals such as plantuml is preferred, however images may added to and linked from /docs/img.

Create a link to the document on sharepoint that is available to anyone in JHA. Do not add binary documents to the repo.