forked from harshtandiya/ballot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC: Add basic documentation (harshtandiya#3)
* DOC: Add basic documentation - create a team - create an election - create a candidature form - manage submissions - submit candidature form * DOC: Add documentation about nominations from community * Update CONTRIBUTING.md
- Loading branch information
1 parent
a66ac4c
commit 371b1de
Showing
24 changed files
with
120 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,41 @@ | ||
# Standing for election | ||
|
||
* As a member of the Community, "All Elections" is where you will find | ||
inforamtion about active Elections within the Community | ||
|
||
![All Elections](./assets/all-elections.png) | ||
|
||
## Submit your Candidature form | ||
|
||
* You can select one of the listed Elections to look at additional information | ||
about it and to submit your Candidature form | ||
|
||
![Election information](./assets/select-live-election.png) | ||
|
||
* Please provide all requested information and click on the "Submit" button | ||
|
||
![Apply for candidature](./assets/apply-for-candidature.png) | ||
|
||
* Your Candidature form submissions are visible under the "My Submissions" page | ||
|
||
![Candidate submissions](./assets/candidature-submissions.png) | ||
|
||
## Seeking nominations from the Community | ||
|
||
![Candidates](./assets/select-live-election.png) | ||
|
||
* The list of Candidates who have successfully submitted a Candidature form | ||
for an Election can be found on the Election page | ||
|
||
![Submit nomination](./assets/submit-comment-candidature-form.png) | ||
|
||
* Members of the Community can voluntarily or by request comment on a Candidate | ||
and nominate them. Nominations from esteemed and/or active members of the | ||
Community lend credibility to the Candidate, especially for members of the | ||
Community who might not be regularly active or if they are unaware of the | ||
Candidate | ||
|
||
![Submitted nominations](./assets/submitted-nomination.png) | ||
|
||
* Nominations submitted by the members of the Community are displayed in the | ||
same page |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,78 @@ | ||
# Organizing an election | ||
|
||
![Dashboard](./assets/workspace.png) | ||
|
||
The landing page for Ballot provides easy access to | ||
|
||
* the Dashboard, which provides access to the Teams | ||
* the Submissions page, which contains information about my Candidature | ||
submissions | ||
* the All Elections page, which displays information about all of the "Live" | ||
Elections | ||
|
||
## Creating a team | ||
|
||
* Before you organize an Election, you first need to create a Team. You can | ||
create a Team by clicking on the "Create Team" button on the Dashboard page | ||
and providing a name. | ||
|
||
|Create a Team|Updated Dashboard| | ||
|---|---| | ||
|![Create Team](./assets/create-team.png)|![New team](./assets/new-team.png)| | ||
|
||
* Once a Team is created, Members can be added to the team by clicking on the | ||
"Add Member" button and providing an email address of a User registered on | ||
the Platform | ||
|
||
|Team details|Add a Team member|Updated team details| | ||
|---|---|---| | ||
|![Team details](./assets/team-details.png)|![Add team member](./assets/add-team-member.png)|![Updated team](./assets/team-updated.png)| | ||
|
||
## Creating an Election | ||
|
||
![Team elections](./assets/team-elections.png) | ||
|
||
* Once a "Team" has been created, all Elections for the Team can be viewed under | ||
the "Elections" page. A new Election can be created by clicking on the | ||
"Create Election" button and providing a Title for the election. | ||
|
||
|Create new Election|Updated Elections page| | ||
|---|---| | ||
|![Create new election](./assets/create-new-election.png)|![Election details](./assets/elections-details.png)| | ||
|
||
* Once created, the Election should be displayed in the Elections page. By | ||
default, the Election isn't "live". To make it "live", please click on the | ||
Election and update the "Status" under "Details" to "Live", provide a | ||
"Slug", and update the Description of the Election. | ||
|
||
![Election status](./assets/election-live.png) | ||
|
||
## Creating a Candidature Form | ||
|
||
![Election candidates](./assets/election-candidates.png) | ||
|
||
* Members of the Community who are interested in running for Election should | ||
submit a Candidature Form. The Candidature Form can be created by clicking | ||
on "Create Form" under the "Candidates" section of the Election | ||
|
||
![Create candidate form](./assets/create-candidate-form.png) | ||
|
||
* The Candidate Form can be customized according to the needs of the Community | ||
e.g. the layout of the forum and the questions in the forum can be | ||
customized when creating the Candidature Form. | ||
|
||
![Edit candidate form](./assets/edit-candidate-form.png) | ||
|
||
* The Candidature Form needs to made "Live" by clicking on "Update Form" | ||
and updating the Status to "Live". The "Description" for the Candidature | ||
Form can also be updated here | ||
|
||
## Manage Candidates | ||
|
||
* Once created, members of the Community can express their interest in running | ||
for Election by submitting information via the Candidature Form. Information | ||
about submissions can be viewed in the "Candidates" page for the Election. | ||
|
||
|Candidates with no submissions|Candidates page with a submission| | ||
|---|---| | ||
|![Manage candidates](./assets/manage-candidates.png)|![Manage candidates updated](./assets/manage-candidates-updated.png)| |