Open-Media-Network
/
openwebgovernancebody
8
4
Fork 0
Code Issues 3 Pull Requests Releases Wiki Activity

Update 'Tech to do list'

master
mj-saunders 2022-01-03 11:56:15 +00:00
parent ff82c802eb
commit 885ce4cc2a
1 changed files with 93 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

188
Tech-to-do-list.md

@ -1,9 +1,23 @@
# Tech TODO # Tech TODO
## Requirements ## 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 ## Development Process
@ -17,121 +31,105 @@
7. Define the roles required to support the user features 7. Define the roles required to support the user features
8. Link the roles to the page templates (who can edit what) 8. Link the roles to the page templates (who can edit what)
9. Simplify the UI to lock down the templates from careless modifications 9. Simplify the UI to lock down the templates from careless modifications
11. Define the new voting module 10. Define the new voting module
12. Define the automated actions on voting, flagging, and elapsed time 11. Define the automated actions on voting, flagging, and elapsed time
13. Define the sortition feature 12. Define the sortition feature
14. Define the sortition actions and timings 13. Define the sortition actions and timings
15. Define the activity pub output feed 14. Define the activity pub output feed
16. Define the user classification feature (e.g. use their email address or post code to classify them) 15. Define the user classification feature (e.g. use their email address or post code to classify them)
17. Define non-functional requirements 16. Define non-functional requirements
18. Define automated testing requirments 17. Define automated testing requirments
19. Define git flow process 18. Define git flow process
20. Define peer code review process 19. Define peer code review process
21. Finalise wireframes 20. Finalise wireframes
22. Design simple, accessible UI/UX and demonstarate key "hero" pages for developers 21. Design simple, accessible UI/UX and demonstarate key "hero" pages for developers
- [**Q.** Can someone define hero pages, please?] - [**Q.** Can someone define hero pages, please?]
24. Build MVP using scrum process 22. Build MVP using scrum process
26. Deploy, use, and get feedback 23. Deploy, use, and get feedback
27. Define Version 1 to meet key feedback 24. Define Version 1 to meet key feedback
28. Build 25. Build
29. Deploy and iterate from 23. 26. Deploy and iterate from 23.
## List of candidate Wikis ## List of Candidate Wikis
TBD 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 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 Tom Campbell
hamish hamish
msanders msaunders
## Story Mapping Output (prioritised verticaly - downwards)
## Story Mapping Output (prioritised vertically - downwards)
TBD TBD
## Wire frame diagams
one page overview diagram of all pages
Home page ## Wireframe Diagrams
Signin/signup wireframe One page overview diagram of all pages
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
functionality wire frames ### Home page
voting config **[FIX THE FOLLOWING IF NECESSARY - I GUESSED THE STRUCTURE A BIT]**
voting actions
votinbg results
## Build Templates for the wiki page types Signin/signup wireframe:
voice bolgs - The pages are in reverse order to the user groups
groups - Voices blog first then groups pages, then body, then users
body - Side bars of voices blog items and recent activity pub feed
other users
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 Each group has:
- Wiki
Moduls - Member list
* 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.