From 9c6ad038d47841037b23101cc07e1a3733c65a4f Mon Sep 17 00:00:00 2001 From: mj-saunders Date: Mon, 3 Apr 2023 16:25:16 +0000 Subject: [PATCH] Minor cleanup --- 02.-Tech-Spec.md | 115 ++++++++++++++++++++++++----------------------- 1 file changed, 59 insertions(+), 56 deletions(-) diff --git a/02.-Tech-Spec.md b/02.-Tech-Spec.md index e2888a7..c4ced34 100644 --- a/02.-Tech-Spec.md +++ b/02.-Tech-Spec.md @@ -81,17 +81,19 @@ Use built in Templating of Xwiki to implement; filling any gaps using additional Login if exsiting user on the instance - * Create new account as 'Member' (everyone): - * may decide to only observe or take part (untick the box "take role") - * create a personal wiki page with their activiypub stream; to do with what they want - * Upgrade to 'Stakeholder Member': - * fill in questionnaire body (template) - * a tagged activity pub message will get posted to the approval group - * group members can each submit 'approve' or 'disapprove' (this is useing the vote modual, likly with a passive time in/out) - * Upgrade to 'Affiliate Member': - * Fill in questionnaire body (template) - * a tagged activity pubmessage will get posted to the approval group - * group members then each submit 'approve' or 'disapprove' (this is useing the vote modual, likly with a passive time in/out) +* Create new account as 'Member' (everyone): + * may decide to only observe or take part (untick the box "take role") + * create a personal wiki page with their activiypub stream; to do with what they want +* Upgrade to 'Stakeholder Member': + * fill in questionnaire body (template) + * a tagged activity pub message will get posted to the approval group + * group members can each submit 'approve' or 'disapprove' (this is useing the vote modual, + likly with a passive time in/out) +* Upgrade to 'Affiliate Member': + * Fill in questionnaire body (template) + * a tagged activity pubmessage will get posted to the approval group + * group members then each submit 'approve' or 'disapprove' (this is useing the vote modual, + likly with a passive time in/out) @@ -99,13 +101,14 @@ Login if exsiting user on the instance Facilitating how members can invite new people, such as: - * Send email - * SMS - * QR codes - * Print Posters - * Signup URL - * AP event -This will allow work for the groups, then it would be a AP event +* Send email +* SMS +* QR codes +* Print Posters +* Signup URL +* AP event + +Thesse will all work for the groups, then it would be a AP event @@ -113,14 +116,14 @@ This will allow work for the groups, then it would be a AP event All actions within an OGB instance related to actions taken on users are handled by the creation, editing and control of wiki pages. We therefore harness the built-in functionality of XWiki to perform such things as: - * member individuals - * member groups - * permissions or members/groups to edit and lock pages - * Create groups - * Join groups - * Leave groups - * Admin of groups - * Freeze/lock pages (make uneditable) +* member individuals +* member groups +* permissions or members/groups to edit and lock pages +* Create groups +* Join groups +* Leave groups +* Admin of groups +* Freeze/lock pages (make uneditable) @@ -138,19 +141,19 @@ Notifications are published by creating ActPub alerts and API actions. ### OGB Sortition Module - * Determines who gets placed in a given 'Body' - * Runs every 10 mins - * Looks for any space in body - * Uses the ratios of sortition into 'Body Member' (1/3 1/3 1/3) from template model - * candidate for each pool are selected randomly from the candidates (who are taking part) - * Updates the new members rolls - * Posts to ActivityPub and alerts via email - * Streams are best kept to a minimum. The default shall be one per body/group, and one per user - * Second sortition runs to pick 'Voices' of the 'Body' - * 3 to 5 (template-defined) are picked and sortated as voices (see above) - * Members may be regularly refreshed based on a timeline defined in the initial template, e.g. - * Once every year, all body members are refreshed - * Once every 6 months half the body is refreshed +* Determines who gets placed in a given 'Body' +* Runs every 10 mins +* Looks for any space in body +* Uses the ratios of sortition into 'Body Member' (1/3 1/3 1/3) from template model + * candidate for each pool are selected randomly from the candidates (who are taking part) + * Updates the new members rolls + * Posts to ActivityPub and alerts via email + * Streams are best kept to a minimum. The default shall be one per body/group, and one per user + * Second sortition runs to pick 'Voices' of the 'Body' + * 3 to 5 (template-defined) are picked and sortated as voices (see above) +* Members may be regularly refreshed based on a timeline defined in the initial template, e.g. + * Once every year, all body members are refreshed + * Once every 6 months half the body is refreshed @@ -223,19 +226,19 @@ As such, there may be a single stream for a given group. WIthin that stream, #ta We will implement filters on these tagged flows to display relevant content on a given page - further narrowed by the group and template. - * Goals support new users - * Flagging challenging content - * Showing the write notification in the appropriate section - * Giving feedback on proposals +* Goals support new users +* Flagging challenging content +* Showing the write notification in the appropriate section +* Giving feedback on proposals ### OGB 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 vote on any "proposal" +* if it goes through, then one of the admins/mod takes the action + * it auto announces via ActPub @@ -245,15 +248,15 @@ Facilitate how hashtags and/or categories from ActivityPub messages are processe Various separate designations within OGB should be able to filter specific messages/posts. This module provides the ability for other modules to achieve this. - * Members - * Stakeholders - * Affiliates - * Body - * Voice - * Groups - * Admin - * Group Members - * Roles +* Members +* Stakeholders +* Affiliates +* Body +* Voice +* Groups + * Admin + * Group Members + * Roles