From 885ce4cc2ab5f57b94e231424273f3476b2af7d6 Mon Sep 17 00:00:00 2001 From: mj-saunders Date: Mon, 3 Jan 2022 11:56:15 +0000 Subject: [PATCH] Update 'Tech to do list' --- Tech-to-do-list.md | 188 ++++++++++++++++++++++----------------------- 1 file changed, 93 insertions(+), 95 deletions(-) diff --git a/Tech-to-do-list.md b/Tech-to-do-list.md index 1181f99..a38955f 100644 --- a/Tech-to-do-list.md +++ b/Tech-to-do-list.md @@ -1,9 +1,23 @@ # Tech TODO ## Requirements +**[Can we list what the key behaviours of the system should be. In part I want to be certain that a wiki is the most suitable candidate - the initial list here was taken from the end of the previous version of this document]** -**[Can we list what the key behaviours of the system should be. In part I want to be certain that a wiki is the most suitable candidate]** +- We need structure and workflow – the 3 way split with sliders +- We need drag and drop UX to build this structure and workflow out of democracy “objects” +- “objects” voting/consensus process/decisions +- We need activity streams of any “object” and “action” +- Flagging is built from the existing “objects” +- We need “security” workflow/check “objects” +- Lottery code (random numbers) + - Mersene twister is probably fine +- The groups have membership + - when a group is set up, default templates are provided (e.g. a set of "skeleton" wiki pages) +### Definitions +**[Feel free to link to other pages if the content is already elsewhere]** + +- `Flagging`: - ... ## Development Process @@ -17,121 +31,105 @@ 7. Define the roles required to support the user features 8. Link the roles to the page templates (who can edit what) 9. Simplify the UI to lock down the templates from careless modifications -11. Define the new voting module -12. Define the automated actions on voting, flagging, and elapsed time -13. Define the sortition feature -14. Define the sortition actions and timings -15. Define the activity pub output feed -16. Define the user classification feature (e.g. use their email address or post code to classify them) -17. Define non-functional requirements -18. Define automated testing requirments -19. Define git flow process -20. Define peer code review process -21. Finalise wireframes -22. Design simple, accessible UI/UX and demonstarate key "hero" pages for developers +10. Define the new voting module +11. Define the automated actions on voting, flagging, and elapsed time +12. Define the sortition feature +13. Define the sortition actions and timings +14. Define the activity pub output feed +15. Define the user classification feature (e.g. use their email address or post code to classify them) +16. Define non-functional requirements +17. Define automated testing requirments +18. Define git flow process +19. Define peer code review process +20. Finalise wireframes +21. Design simple, accessible UI/UX and demonstarate key "hero" pages for developers - [**Q.** Can someone define hero pages, please?] -24. Build MVP using scrum process -26. Deploy, use, and get feedback -27. Define Version 1 to meet key feedback -28. Build -29. Deploy and iterate from 23. +22. Build MVP using scrum process +23. Deploy, use, and get feedback +24. Define Version 1 to meet key feedback +25. Build +26. Deploy and iterate from 23. -## List of candidate Wikis +## List of Candidate Wikis TBD -## Choosen Wiki and why + +## Chosen Wiki and Why xwik as its has https://extensions.xwiki.org/xwiki/bin/view/Extension/ActivityPub%20Application/ YOU CAN TALK TO THE DEV HERE https://socialhub.activitypub.rocks/t/integrating-activitypub-in-xwiki-a-journey/947/2 -## Team list + +## Team Members Tom Campbell hamish -msanders +msaunders -## Story Mapping Output (prioritised verticaly - downwards) + +## Story Mapping Output (prioritised vertically - downwards) TBD -## Wire frame diagams -one page overview diagram of all pages -Home page -Signin/signup wireframe -the pages are in revers order to the user groups -voices blog first then groups pages, then boady, then users -side bars of voice blog items and recent activity pub feed +## Wireframe Diagrams +One page overview diagram of all pages -functionality wire frames -voting config -voting actions -votinbg results +### Home page +**[FIX THE FOLLOWING IF NECESSARY - I GUESSED THE STRUCTURE A BIT]** -## Build Templates for the wiki page types -voice bolgs -groups -body -other users +Signin/signup wireframe: +- The pages are in reverse order to the user groups +- Voices blog first then groups pages, then body, then users +- Side bars of voices blog items and recent activity pub feed + +Functionality wireframes: +- Voting config +- Voting actions +- Voting results +## Build Templates +For the wiki page types. + +- Voice blogs +- Groups +- Body +- Other users +## END OF TOMS ADDITION +--- + +## XWiki Modules [Draft List] + +### Modules + +- A front end that gives you a choice of templates (and in version 02 a way to modify them) +- User roles - user, member (body), mod (group), admin(voice) +- Body balance - stake-holder, user, affiliate +- Voting - consensus -1 (1%) constitutional vote (⅔) and majority vote 50% + - **^[This needs to be more clear]** +- Lottery - to fill roles +- Basic security checks +- Flagging + +### Scripts + +- Gives rights +- Auto create wiki pages based on roles and memberships + +**[Please have a look through project descriptions and update this]** +## Identity “objects” +**[The word "identity" above is a correction from "ideantery" - please make sure it is a corrrect correction :)]** + +With admin access privileges. + +Use the roles -# END OF TOMS ADDITION +## Group “objects” +The content of the groups is stored in a wiki (we use an off the shelf one). -# Draft list of moduls for xwiki - -Moduls - -* A front end that gives you a choice of templates (and in version 02 a way to modify them) - -* Usear roles - user, member (body), mod (group), admin(voice) - -* Body balance - stake holder, usear, affilate - -* Voting - consensus -1 (1%) constutuanal vote (⅔) and majority vote 50% - -* Lottery - to fill roles - -* We need scripting that gives rights and auto creates wikipages based on roles and memmberships. - -* Basic security checks module - -* Flagging module - -please have a lok through project discriptions and update this - - - -## ideantery “objects” with admin access privileges. - -use the roales - - - -## group “objects” with memberships, the content of the groups is stored on a wiki (we use an off the shelf one) - -Group - Wiki - member list - - - - - -We need structure and workflow – the 3 way split with sliders - -We need drag and drop UX to build this structure and workflow out of democracy “objects” - -“objects” voting/consensus process/decisions - -We need activity streams of any “object” and “action”. - -Flagging is built of the existing “objects” - -We need “security” workflow/check “objects” - -Lottery code (random numbers) - -The groups have membership, when a group is set up a template of wiki pages is created. +Each group has: +- Wiki +- Member list \ No newline at end of file