Skip to content

Commit

Permalink
deploy: 5c14b6e
Browse files Browse the repository at this point in the history
  • Loading branch information
gilesknap committed Feb 22, 2024
1 parent ed32d84 commit cec5bb4
Show file tree
Hide file tree
Showing 128 changed files with 23,818 additions and 0 deletions.
4 changes: 4 additions & 0 deletions 0.8.0b0/.buildinfo
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 not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added 0.8.0b0/.doctrees/developer/how-to/lint.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 added 0.8.0b0/.doctrees/developer/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added 0.8.0b0/.doctrees/environment.pickle
Binary file not shown.
Binary file added 0.8.0b0/.doctrees/genindex.doctree
Binary file not shown.
Binary file added 0.8.0b0/.doctrees/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added 0.8.0b0/.doctrees/user/index.doctree
Binary file not shown.
Binary file added 0.8.0b0/.doctrees/user/reference/api.doctree
Binary file not shown.
Binary file not shown.
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 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.
Binary file added 0.8.0b0/_images/pilatus_edl.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions 0.8.0b0/_sources/developer/explanations/decisions.rst.txt
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/*
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.
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
Loading

0 comments on commit cec5bb4

Please sign in to comment.