summaryrefslogtreecommitdiff
path: root/ci-arch.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'ci-arch.mdwn')
-rw-r--r--ci-arch.mdwn39
1 files changed, 20 insertions, 19 deletions
diff --git a/ci-arch.mdwn b/ci-arch.mdwn
index 004544e..5c9e6f4 100644
--- a/ci-arch.mdwn
+++ b/ci-arch.mdwn
@@ -51,25 +51,26 @@ Kubernetes
# Requirements
-* This chapter lists the requirements we have for the CI system and
- which we design the system to fulfil.
-
-* Each requirement is given a semi-mnemonic unique identifier, so it
- can be referred to easily.
-
-* The goal is to make requirements be as clear and atomic as possible,
- so that the implementation can be more easily evaluated against the
- requirement: it's better to split a big, complicated requirement
- into smaller ones so they can be considered separately. The original
- requirement can be a parent to all its parts.
-
-* FIXME: We may want to have a way to track which requirements are
- being fulfilled, or tested by automated acceptance tests. Need to
- add something for this, maybe a spreadsheet.
-
-* These requirements were originally written up in the [WG wiki pages][]
- and have been changed a little compared to that (as of the 21 March
- 2019 version).
+This chapter lists the requirements we have for the CI system and
+which we design the system to fulfil.
+
+Each requirement is given a semi-mnemonic unique identifier, so it can
+be referred to easily.
+
+The goal is to make requirements be as clear and atomic as possible,
+so that the implementation can be more easily evaluated against the
+requirement: it's better to split a big, complicated requirement into
+smaller ones so they can be considered separately. Requirements can be
+hierarchical: The original requirement can be a parent to all its
+parts.
+
+**FIXME:** We may want to have a way to track which requirements are
+being fulfilled, or tested by automated acceptance tests. Need to add
+something for this, maybe a spreadsheet.
+
+These requirements were originally written up in the [WG wiki pages][]
+and have been changed a little compared to that (as of the 21 March
+2019 version).
[WG wiki pages]: https://www.mediawiki.org/wiki/Wikimedia_Release_Engineering_Team/CI_Futures_WG/Requirements