-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
128 changed files
with
23,818 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 0a621657c23fe411083838786164534e | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Binary file not shown.
Binary file added
BIN
+7.05 KB
...0b0/.doctrees/developer/explanations/decisions/0001-record-architecture-decisions.doctree
Binary file not shown.
Binary file added
BIN
+8.27 KB
0.8.0b0/.doctrees/developer/explanations/decisions/0002-switched-to-pip-skeleton.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
71 changes: 71 additions & 0 deletions
71
0.8.0b0/_images/graphviz-5e22cfdf92319ef38cd6feb62e2f699b3ea35921.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
217 changes: 217 additions & 0 deletions
217
0.8.0b0/_images/graphviz-b19c94a71c62554f002f9ae7a916b57147580cf4.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
.. This Source Code Form is subject to the terms of the Mozilla Public | ||
.. License, v. 2.0. If a copy of the MPL was not distributed with this | ||
.. file, You can obtain one at http://mozilla.org/MPL/2.0/. | ||
Architectural Decision Records | ||
============================== | ||
|
||
We record major architectural decisions in Architecture Decision Records (ADRs), | ||
as `described by Michael Nygard | ||
<http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions>`_. | ||
Below is the list of our current ADRs. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
:glob: | ||
|
||
decisions/* |
26 changes: 26 additions & 0 deletions
26
...ces/developer/explanations/decisions/0001-record-architecture-decisions.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
1. Record architecture decisions | ||
================================ | ||
|
||
Date: 2022-02-18 | ||
|
||
Status | ||
------ | ||
|
||
Accepted | ||
|
||
Context | ||
------- | ||
|
||
We need to record the architectural decisions made on this project. | ||
|
||
Decision | ||
-------- | ||
|
||
We will use Architecture Decision Records, as `described by Michael Nygard | ||
<http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions>`_. | ||
|
||
Consequences | ||
------------ | ||
|
||
See Michael Nygard's article, linked above. To create new ADRs we will copy and | ||
paste from existing ones. |
35 changes: 35 additions & 0 deletions
35
..._sources/developer/explanations/decisions/0002-switched-to-pip-skeleton.rst.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
2. Adopt python3-pip-skeleton for project structure | ||
=================================================== | ||
|
||
Date: 2022-02-18 | ||
|
||
Status | ||
------ | ||
|
||
Accepted | ||
|
||
Context | ||
------- | ||
|
||
We should use the following `pip-skeleton <https://github.com/DiamondLightSource/python3-pip-skeleton>`_. | ||
The skeleton will ensure consistency in developer | ||
environments and package management. | ||
|
||
Decision | ||
-------- | ||
|
||
We have switched to using the skeleton. | ||
|
||
Consequences | ||
------------ | ||
|
||
This module will use a fixed set of tools as developed in python3-pip-skeleton | ||
and can pull from this skeleton to update the packaging to the latest techniques. | ||
|
||
As such, the developer environment may have changed, the following could be | ||
different: | ||
|
||
- linting | ||
- formatting | ||
- pip venv setup | ||
- CI/CD |
Oops, something went wrong.