Changes between Version 27 and Version 28 of BluePrint/Sunflower


Ignore:
Timestamp:
03/18/14 11:17:47 (8 years ago)
Author:
somayjain
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • BluePrint/Sunflower

    v27 v28  
    44== Introduction ==
    55Sunflower is a template that will be used by the Sahana Software Foundation (SSF) as a community management and coordination tool. It's development started during the [http://eden.sahanafoundation.org/wiki/Event/2012/Sahanathon Sahanathon in 2012].
     6
     7== Stakeholders ==
     8* The Sahana Community - Since this is a community management and coordination tool, it is a means for the community to see what everyone is interested/is working on.
     9* People using Sahana Eden - They will be able to report a problem/seek assistance regarding Sahana Eden.
     10* Organisations for fundraising - It will be a tool to give stats about the work going on in Sahana Eden which would be useful in getting funds.
     11* Deployments - Information about how and where is Sahana Eden being used.
    612
    713=== Goals ===
     
    4046
    4147== Requirements ==
    42 <Outline the requirements here>
    43 <Group requirements in subsections, e.g. functional, non-functional, interoperability etc.>
    44 
    45 === Data ===
     48
     49=== Non-Functional ===
     50
     51==== Data ====
    4652Data models for Sunflower objects can be found here: https://docs.google.com/a/sarapisfoundation.org/spreadsheet/ccc?key=0ArhSktWsQi1VdE5lQncyYWNESUxsdXdDYUI3ZEg1dEE&usp=sharing
    4753
    48 === Points ===
    49 There have been suggestions that we determine a way in which to recognise top contributors - one way of doing this would be to give people "Points" (Sunflower seeds?) for completing tasks. This could work something like:
    50 * All contributors can vote on the number of points a task is worth (0-5). The value of the task is the average of those votes. If there are no votes, a task gets 1 point.
    51   * Tasks are often assigned value by the person who creates them.  I think that's a good way to establish not just their difficulty but also their priority level.  Additionally, it would be nice if the person who completes the task also indicates the amount of time they put into that task. Both factors could be recorded to create more useful information about community contributors and their contributions.
    52 * When a task is completed, the contributors that the task is assigned to gets the average value of their votes (although their own vote is ignored)
    53 * On the homepage the top contributors based on points accumulated over the past month are displayed
    54 * We can also keep historic point talleys over time
    55   * I think it's useful to think about the types of rewards that could be offered to people with lots of points.
    56   * I also think this would be a good reason to incorporaespeciallyte badges into EDEN, specifically http://openbadges.org/ which could be used as a reward mechanism as well as a way to share information about people's skills and experiences.
    57 
    58 === Personal Profiles ===
     54==== Metrics ====
     55Sunflower should be able to produce the
     56* Number of active (tasks, emails to list, wiki updates, trunk commits) contributors
     57 - Daily Active
     58 - Weekly Active
     59 - Monthly Active
     60 - Yearly Active
     61
     62=== Functional ===
     63
     64==== Personal Profiles ====
    5965A personal profile should record:
    6066* Name
     
    7480* What groups/teams people belong to (eg. Board, GSoC Mentors, GCI Student...)
    7581
    76 === Metrics ===
    77 Sunflower should be able to produce the
    78 * Number of active (tasks, emails to list, wiki updates, trunk commits) contributors
    79  - Daily Active
    80  - Weekly Active
    81  - Monthly Active
    82  - Yearly Active
    83 
    84 === Subscription ===
     82
     83==== Subscription ====
    8584
    8685* A person who is subscribed to a task/project/organisation/etc receives notifications via email about it.
     
    9897  * The mode of notifications (email/no email)
    9998
    100 === Task Management ===
     99==== Task Management ====
    101100
    102101* Review Permissions
     
    122121 * Log a bug when an error is encountered
    123122 * If not already logged for this bug
     123
     124==== Points ====
     125There have been suggestions that we determine a way in which to recognise top contributors - one way of doing this would be to give people "Points" (Sunflower seeds?) for completing tasks. This could work something like:
     126* All contributors can vote on the number of points a task is worth (0-5). The value of the task is the average of those votes. If there are no votes, a task gets 1 point.
     127  * Tasks are often assigned value by the person who creates them.  I think that's a good way to establish not just their difficulty but also their priority level.  Additionally, it would be nice if the person who completes the task also indicates the amount of time they put into that task. Both factors could be recorded to create more useful information about community contributors and their contributions.
     128* When a task is completed, the contributors that the task is assigned to gets the average value of their votes (although their own vote is ignored)
     129* On the homepage the top contributors based on points accumulated over the past month are displayed
     130* We can also keep historic point talleys over time
     131  * I think it's useful to think about the types of rewards that could be offered to people with lots of points.
     132  * I also think this would be a good reason to incorporaespeciallyte badges into EDEN, specifically http://openbadges.org/ which could be used as a reward mechanism as well as a way to share information about people's skills and experiences.
    124133
    125134
     
    227236
    228237== Implementation ==
    229 <Leave open for a list of implementation>
     238
     239=== Current Implementation ===
     240
     241* The current implementation is a template built on top of Sahana Eden.
     242* Currently, it supports the following -
     243 * Contributors - Using the {{{hrm}}} module.
     244 * Tasks Lists - Using the {{{project_task}}} table, where a task can be assigned to just one person.
     245 * Deployments - Using the {{{project_project}}} table, filtered by sector name as "Deployment".
     246 * Projects - Using the {{{project_project}}} table, filtered by sector name as "Project".
     247 * Disaster Organisations - Using the {{{org}}} module.
     248* The current implementation can be found in the trunk at {{{private/templates/SSF}}} [https://github.com/flavour/eden/tree/master/private/templates/SSF here].
     249
     250=== Planned Implementation ===
     251
     252* Goals for my(Name : Somay Jain, [https://github.com/somayjain Github Repo], IRC : Somay) implementation -
     253 * Personal Profile
     254  * Including a {{{pr_person_details}}} table to include the details in the profile for the user, which will be linked to {{{pr_person}}}.
     255 * Subscriptions
     256  * Using [wiki:S3/Notifications Subscriptions] to give updates to the user via the mode selected and on the the homepage.
     257 * Task Management
     258  * Include visibility of everyone who is subscribed to the task, possibly with another tasks to subscribed users table.
     259 * Homepage, Views -
     260  * Using Bootstrap to customize views.
     261  * Information from multiple modules on the homepage - Eg : tasks, updates, newsfeed, contributors/deployments map, etc.
     262  * Will define custom layouts and controllers for each module.
     263 * Metrics of contributions -
     264  * Include trunk commits URLs.
     265  * Include tasks logged/resolved.
     266  * Include links of wiki pages edited.
     267  * These metrics will have to be entered manually by the user as part of building his/her profile.
     268 * Pages for each module -
     269  * Use summary pages and datalists for each module mentioned above.
     270
     271== Future Extensions ==
     272
     273* Metrics - Making the metrics being automatically updated
     274 * Emails links on the list.
     275 * Trunk commits URLs
     276 * Tasks logged URLs
     277 * Tasks resolved URLs
     278 * Links of wiki pages edited.
    230279
    231280== References ==