feat(invariants): add mojaloop invariants to documentation website (#428

) * Draft work in progress on adding invariants to main docs site * Draft work in progress on adding invariants to main docs site * Draft work in progress on adding invariants to main docs site * Draft work in progress on adding invariants to main docs site. progress check-in. * Draft work in progress on adding invariants to main docs site. progress check-in. * Draft work in progress on adding invariants to main docs site. progress check-in. * Draft work in progress on adding invariants to main docs site. progress check-in. * update package-lock.json * fix broken build * fix broken CI build * address PR comment from Paul Baker. * address PR feedback from Sam K. * further change to address PR feedback from Sam K. * Address feedback from Sam re transfer fulfilment meaning Co-authored-by: Sam <[email protected]> * further change to address PR feedback from Sam K. * further change to address PR feedback from Sam K. Graceful degredation under load. * remove references to editorial notes which have now been removed. * Update with feedback from PR reviews from Michael Richards and Paul Baker. * Clarify purpose of operational characteristics section. * Revert change from bad merge in package-lock.json * fix bad fix package-lock.json * address review feedback from Michael Richards after DA discussion on uptime targets. * fix indentation. * fix grammar / typo. * Update docs/community/standards/invariants.md --------- Co-authored-by: Sam <[email protected]>
mojaloop · Jun 6, 2024 · 4428214 · 4428214
1 parent 495ee8c
commit 4428214
Show file tree

Hide file tree

Showing 4 changed files with 247 additions and 1 deletion.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -114,6 +114,7 @@ module.exports = {
           sidebarDepth: 2,
           children: [
             ['standards/guide', 'Our Standards'],
+            ['standards/invariants', 'Mojaloop Invariants'],
             ['standards/versioning', 'Versioning'],
             ['standards/creating-new-features', 'Creating New Features'],
             ['standards/triaging-bugs', 'Triaging Bugs'],

diff --git a/docs/community/standards/guide.md b/docs/community/standards/guide.md
@@ -2,9 +2,17 @@
 
 > *Note:* These standards are by no means set in stone, and as a community, we always want to be iterating and improving Mojaloop. If you want to propose a change to these standards, or suggest further improvements, please reach out to the Design Authority Channel on the Mojaloop Slack (#design-authority)
 
+## Mojaloop Invariants
+
+Mojaloop has some [invariants](./invariants.md) that are important to understand and adhere to when contributing to the codebase.
+
+These invariants are derived from [The Level One Principles](https://www.leveloneproject.org/wp-content/uploads/2020/07/L1P_Guide_2019_Final.pdf) and other business requirements as decided upon by the Mojaloop Technical Governance Board, API Change Control Board, Design Authority and Product Council. They are intended to ensure the platform retains certain characteristics important for national infrastructure grade operation.
+
+Please ensure you are familiar with the invariants before contributing to the codebase.
+
 ## Runtime Environment
 
-The following runtime standards are utilizes for Mojaloop.
+The following runtime standards apply to Mojaloop.
 
 ### Micro-services & Libraries