zydronium/manage.get.gov
1
0
Fork 0
mirror of https://github.com/cisagov/manage.get.gov.git synced 2025-07-24 19:48:36 +02:00
Code Issues Projects Releases Packages Wiki Activity

Adjust markdown files with PlantUML inside for Github

Browse source
This commit is contained in:
Neil Martinsen-Burrell 2023-05-12 14:44:45 -05:00
parent fee659d1c4
commit 4b7a8953b7
No known key found for this signature in database
GPG key ID: 6A3C818CC10D0184
2 changed files with 14 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/architecture/diagrams/model_timeline.md
View file

@ -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
```

12
docs/architecture/diagrams/models_diagram.md
View file

@ -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
```