Update 'Tech to do list'
parent
0e51c9f17e
commit
f70dc26a44
|
@ -11,7 +11,6 @@ Use the existing XWiki template system to build a set of pages which cannot be a
|
||||||
|
|
||||||
Including a group that checks if some is a stakeholder or affiliate.
|
Including a group that checks if some is a stakeholder or affiliate.
|
||||||
|
|
||||||
|
|
||||||
### Signup Module
|
### Signup Module
|
||||||
Login if exsiting user on the instance
|
Login if exsiting user on the instance
|
||||||
- Create new account as 'Member' (everyone):
|
- Create new account as 'Member' (everyone):
|
||||||
|
@ -26,9 +25,11 @@ Login if exsiting user on the instance
|
||||||
- a tagged activity pub message will get posted to the approval group
|
- a tagged activity pub message will get posted to the approval group
|
||||||
- group members must each submit 'approve' or 'disapprove'
|
- group members must each submit 'approve' or 'disapprove'
|
||||||
|
|
||||||
|
### Invite Members Module
|
||||||
|
[Research how this currently works in Xwiki]
|
||||||
|
Send email, SMS, Download QR codes, Print Posters, Signup URL
|
||||||
|
|
||||||
### [Sortition](https://en.wikipedia.org/wiki/Sortition) Module
|
### [Sortition](https://en.wikipedia.org/wiki/Sortition) Module
|
||||||
|
|
||||||
- Determines who gets placed in a given 'Body'
|
- Determines who gets placed in a given 'Body'
|
||||||
- Runs every 10 mins
|
- Runs every 10 mins
|
||||||
- Looks for any space in body
|
- Looks for any space in body
|
||||||
|
@ -39,64 +40,40 @@ Login if exsiting user on the instance
|
||||||
- **_[Q. How many ActPub "users"/streams will there be? One for Organisation, one per Body, one per Member?]_**
|
- **_[Q. How many ActPub "users"/streams will there be? One for Organisation, one per Body, one per Member?]_**
|
||||||
- Second sortition runs to pick 'Voices' of the 'Body'
|
- Second sortition runs to pick 'Voices' of the 'Body'
|
||||||
- 3 to 5 are picked as sortated as voices (see above)
|
- 3 to 5 are picked as sortated as voices (see above)
|
||||||
* [add activity time outs and time limits]
|
- [add activity time outs and time limits]
|
||||||
* [add group and wifi logic]
|
- [add group and wifi logic]
|
||||||
|
|
||||||
### Invite Members module
|
|
||||||
[Research how this currently works in Xwiki]
|
|
||||||
Send email, SMS, Download QR codes, Print Posters, Signup URL
|
|
||||||
|
|
||||||
|
|
||||||
### Voting
|
### Voting
|
||||||
|
- 3 options
|
||||||
|
- can vote on any "proposal"
|
||||||
|
- if it goes through, then one of the admins/mod takes the action
|
||||||
|
- it auto announces via ActPub
|
||||||
|
|
||||||
3 options, can vot on any "popusal" if it goes through then one of the admins/mod takes the action, its anouces on AP
|
### These need writing up:
|
||||||
|
- structure/workflow/templates to define varables
|
||||||
### these need wrighting up:
|
- for creating wiki pages with user rights, user groups who can edit the wiki and lock pages
|
||||||
|
- creating/joining and leaveing groups, admin of groups.
|
||||||
|
- logic for flagging
|
||||||
structure/workflow/templates to define varables
|
- voting x3
|
||||||
for creating wiki pages with user rights, user groups who can edit the wiki and lock pages
|
- sortation for roles and posts
|
||||||
creating/joining and leaveing groups, admin of groups.
|
- user page scrypiting
|
||||||
logic for flagging
|
- Basic security and checks
|
||||||
voting x3
|
- Activerty streams (by tag/cat)
|
||||||
sortation for roles and posts
|
- Roles are complex and needed for money but we can leave these out of draft version to keep it KISS
|
||||||
user page scrypiting
|
|
||||||
Basic security and checks
|
|
||||||
Activerty streams (by tag/cat)
|
|
||||||
Roles are complex and needed for money but we can leave these out of draft version to keep it KISS
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### UI to choose tempate for OGB
|
|
||||||
Java backend
|
|
||||||
|
|
||||||
Velocity frount end
|
|
||||||
|
|
||||||
Used by any member to set up a new OGB
|
|
||||||
|
|
||||||
Choose from avliable templates
|
|
||||||
|
|
||||||
[Research if this functionality is in xwiki or needs developing]]
|
|
||||||
|
|
||||||
[Hasmish to define template and how difrences]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
### UI to choose template for OGB
|
||||||
|
- Java backend
|
||||||
|
- Velocity front end
|
||||||
|
- Used by any member to set up a new OGB
|
||||||
|
- Choose from avliable templates
|
||||||
|
- [Research if this functionality is in xwiki or needs developing]]
|
||||||
|
- [Hamish to define template and how differences]
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## NFR (Non Functional Requirments)
|
## NFR (Non Functional Requirments)
|
||||||
|
|
||||||
|
### 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 - the initial list here was taken from the end of the previous version of this document]**
|
||||||
|
|
||||||
Function:
|
Function:
|
||||||
|
@ -125,10 +102,13 @@ UI/X:
|
||||||
- `Flagging`: ...
|
- `Flagging`: ...
|
||||||
- ...
|
- ...
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Development Process
|
## Development Process
|
||||||
|
|
||||||
1. Choose a **well maintained, open source wiki** to be the base of the functionality
|
1. Choose a **well maintained, open source wiki** to be the base of the functionality
|
||||||
2. Find a team who are skilled in the language(s), data storage and frameworks used to build the chosen wiki (recruit from the maintenainers initially if possible)
|
2. Find a team who are skilled in the language(s), data storage and frameworks used to build the chosen wiki
|
||||||
|
- recruit from the maintainers initially if possible
|
||||||
3. Do story mapping exercise to define the features and scope and user life cycles
|
3. Do story mapping exercise to define the features and scope and user life cycles
|
||||||
4. Prioritise the stories to highlight MVP features
|
4. Prioritise the stories to highlight MVP features
|
||||||
5. Design initial wireframes
|
5. Design initial wireframes
|
||||||
|
@ -155,30 +135,28 @@ UI/X:
|
||||||
25. Build
|
25. Build
|
||||||
26. Deploy and iterate from 23.
|
26. Deploy and iterate from 23.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## List of Candidate Wikis
|
## Why XWiki
|
||||||
TBD
|
|
||||||
|
|
||||||
|
|
||||||
## Chosen Wiki and Why
|
|
||||||
|
|
||||||
### XWiki
|
|
||||||
|
|
||||||
Ideal candidate as it has active maintainers, and because it already has ActivityPub integration
|
Ideal candidate as it has active maintainers, and because it already has ActivityPub integration
|
||||||
|
|
||||||
- [ActivityPub Extension](https://extensions.xwiki.org/xwiki/bin/view/Extension/ActivityPub%20Application/)
|
- [ActivityPub Extension](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)
|
- YOU CAN TALK TO THE DEV [HERE](https://socialhub.activitypub.rocks/t/integrating-activitypub-in-xwiki-a-journey/947/2)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Team Members
|
## Team Members
|
||||||
Tom Campbell
|
Tom Campbell
|
||||||
hamish
|
Hamish
|
||||||
msaunders
|
Michael
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Story Mapping Output (prioritised vertically - downwards)
|
## Story Mapping Output (prioritised vertically - downwards)
|
||||||
TBD
|
TBD
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Wireframe Diagrams
|
## Wireframe Diagrams
|
||||||
One page overview diagram of all pages
|
One page overview diagram of all pages
|
||||||
|
@ -196,23 +174,22 @@ Functionality wireframes:
|
||||||
- Voting actions
|
- Voting actions
|
||||||
- Voting results
|
- Voting results
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Build Templates
|
## Build Templates
|
||||||
For the wiki page types.
|
For the wiki page types
|
||||||
|
|
||||||
- Voice blogs
|
- Voice blogs
|
||||||
- Groups
|
- Groups
|
||||||
- Body
|
- Body
|
||||||
- Other users
|
- Other users
|
||||||
|
|
||||||
---
|
|
||||||
### END OF TOMS ADDITION
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## XWiki Modules [Draft List]
|
## XWiki Modules [Draft List]
|
||||||
|
|
||||||
### Modules
|
### Modules
|
||||||
are simply blocks on the wiki pages with options.
|
are simply blocks on the wiki pages with options
|
||||||
|
|
||||||
- A front end that gives you a choice of templates (and in version 02 a way to modify them)
|
- A front end that gives you a choice of templates (and in version 02 a way to modify them)
|
||||||
- propsal is tyed into the voteing
|
- propsal is tyed into the voteing
|
||||||
|
|
Loading…
Reference in New Issue