diff --git a/docs.yaml b/docs.yaml index e47c24c5..fb85d321 100644 --- a/docs.yaml +++ b/docs.yaml @@ -18,6 +18,7 @@ packages: - requirements - installation - architecture + - architecture-decision-records tenants: - tenant-what-is - tenant-setup diff --git a/docs/tenancy/1.x/ADR-Sample.md b/docs/tenancy/1.x/ADR-Sample.md new file mode 100644 index 00000000..3b7bda59 --- /dev/null +++ b/docs/tenancy/1.x/ADR-Sample.md @@ -0,0 +1,51 @@ +--- +title: Architecture Decision Record - TEMPLATE +icon: fal fa-cogs +excerpt: > + Brief description of the decision +tags: + - architecture +--- + +# TEMPLATE + +## Introduction +Some background about the possible decisions + +### Assumptions +A list of all assumptions that are being made + +### Constraints +A list of constraints that the decision must conform to + +## Outcomes investigated + +### Decision 1 +Detailed expaination of what changes would need to be made + +#### Benifits +Benifits of this decision + +#### Drawbacks +Drawbacks of this decision + +### Decision 2 +Detailed expaination of what changes would need to be made + +#### Benifits +Benifits of this decision + +#### Drawbacks +Drawbacks of this decision + +## Outcome +Decision made: DECISION + +Reasoning for this decision being made. + +## References +Github Issue(s): [####](link) [####](link) [####](link) + +Github Pull Request(s): [####](link) [####](link) [####](link) + +Additional reference material supporting decision \ No newline at end of file diff --git a/docs/tenancy/1.x/architecture-decision-records.md b/docs/tenancy/1.x/architecture-decision-records.md new file mode 100644 index 00000000..87c5e4cc --- /dev/null +++ b/docs/tenancy/1.x/architecture-decision-records.md @@ -0,0 +1,19 @@ +--- +title: Architecture Decision Records +icon: fal fa-cogs +excerpt: > + Log of architectural decisions that have been made and their reasoning +tags: + - architecture +--- + +# Architecture Decision Records +The following are a list of decisions that have been made regarding the architecture of the Tenancy package. + +## 1.x +** Use of Config Files ** + +** Disallow the ordering of Affects ** + +## 0.x +