From 796ec5d99b286b47913489b3d0b6c5d6b786e266 Mon Sep 17 00:00:00 2001 From: Sniper7Kills Date: Tue, 8 Sep 2020 09:40:57 -0400 Subject: [PATCH 1/2] remove third party package name --- docs/tenancy/1.x/faq-common-problems.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/tenancy/1.x/faq-common-problems.md b/docs/tenancy/1.x/faq-common-problems.md index 5e148545..f95b2c71 100644 --- a/docs/tenancy/1.x/faq-common-problems.md +++ b/docs/tenancy/1.x/faq-common-problems.md @@ -101,7 +101,7 @@ I need to do some stuff directly after my affects are finished, but before the r *Example* -You might be using [PHP API Wrapper](https://github.com/CristalTeam/php-api-wrapper) in your application, and you need to configure it based on your tenant; AFTER your [affects-config](affects-configs) is finished. +You might be using a third party package in your application, and you need to configure it based on your tenant; AFTER your [affects-config](affects-configs) is finished. **Solution** @@ -127,7 +127,7 @@ class EventServiceProvider extends ServiceProvider protected $listen = [ \Tenancy\Affects\Configs\Events\ConfigureConfig::class => [ ConfigureTenantConfigs::class, - ConfigureApiWrapper::class, + ConfigurePackage::class, ], ]; } From 128d434fce3dec6a4213d464345d574b66016a2e Mon Sep 17 00:00:00 2001 From: Sniper7Kills Date: Wed, 14 Oct 2020 16:23:34 -0400 Subject: [PATCH 2/2] inital sample ADR for review --- docs.yaml | 1 + docs/tenancy/1.x/ADR-Sample.md | 51 +++++++++++++++++++ .../1.x/architecture-decision-records.md | 19 +++++++ 3 files changed, 71 insertions(+) create mode 100644 docs/tenancy/1.x/ADR-Sample.md create mode 100644 docs/tenancy/1.x/architecture-decision-records.md 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 +