Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ packages:
- requirements
- installation
- architecture
- architecture-decision-records
tenants:
- tenant-what-is
- tenant-setup
Expand Down
51 changes: 51 additions & 0 deletions docs/tenancy/1.x/ADR-Sample.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: Architecture Decision Record - TEMPLATE
icon: fal fa-cogs
excerpt: >
Brief description of the decision
tags:
- architecture
---

# TEMPLATE
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a summary please


## 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
19 changes: 19 additions & 0 deletions docs/tenancy/1.x/architecture-decision-records.md
Original file line number Diff line number Diff line change
@@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of these should be listed under 0.x

** Use of Config Files **
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to use capitalized letters config files


** Disallow the ordering of Affects **
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Disallow sounds so rude, "Do not support", sounds slightly better


## 0.x