From 4b7a8953b7f191b5666c48d2f1caa81591143411 Mon Sep 17 00:00:00 2001
From: Neil Martinsen-Burrell <neil.martinsen-burrell@gsa.gov>
Date: Fri, 12 May 2023 14:44:45 -0500
Subject: [PATCH] Adjust markdown files with PlantUML inside for Github

---
 docs/architecture/diagrams/model_timeline.md |  2 ++
 docs/architecture/diagrams/models_diagram.md | 12 ++++++++++++
 2 files changed, 14 insertions(+)

diff --git a/docs/architecture/diagrams/model_timeline.md b/docs/architecture/diagrams/model_timeline.md
index 30363e4d4..4a39807a1 100644
--- a/docs/architecture/diagrams/model_timeline.md
+++ b/docs/architecture/diagrams/model_timeline.md
@@ -19,6 +19,7 @@ A more complete diagram of the data models, their fields, and their
 relationships are in [models_diagram.md](./models_diagram.md), created with
 the `django-model2puml` plugin.
 
+```plantuml
 @startuml
 
 allowmixing
@@ -131,3 +132,4 @@ actor user3 #Green
 user3 -right[#green]-> UserDomainRole : **/domain/<id>/users/add**
 user3 -right[#green]-> DomainInvitation : **/domain/<id>/users/add**
 @enduml
+```
diff --git a/docs/architecture/diagrams/models_diagram.md b/docs/architecture/diagrams/models_diagram.md
index f10c6ad87..5e47514d0 100644
--- a/docs/architecture/diagrams/models_diagram.md
+++ b/docs/architecture/diagrams/models_diagram.md
@@ -1,3 +1,14 @@
+# Complete model documentation
+
+This is an auto-generated diagram of our data models generated with the
+[django-model2puml](https://github.com/sen-den/django-model2puml) library
+using the command
+
+```bash
+$ docker compose app ./manage.py generate_puml --include registrar
+```
+
+```plantuml
 @startuml 
 class "registrar.Contact <Registrar>" as registrar.Contact #d6f4e9 {
     contact
@@ -248,3 +259,4 @@ class "registrar.Website <Registrar>" as registrar.Website #d6f4e9 {
 
 
 @enduml
+```