Skip to content

Commit 371b1de

Browse files
authored
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
1 parent a66ac4c commit 371b1de

24 files changed

+120
-0
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818
* Install the Ballot app on the new site `bench --site test.ballot install-app ballot`
1919
* [Access the site conveniently](https://frappeframework.com/docs/user/en/tutorial/create-a-site#access-site-in-your-browser)
2020
from your computer using `bench --site test.ballot add-to-hosts`
21+
* Add `"ignore_csrf":1` to the `sites/common_site_config.json`
22+
configuration file. Without this, performing operating on the frontend app
23+
raises CSRF errors
2124
* Finally, run `bench start` to launch the backend
2225

2326
The frappe framework-powered backend application should now be running. To run

docs/docs/assets/add-team-member.png

69.1 KB
Loading

docs/docs/assets/all-elections.png

47.6 KB
Loading
73.3 KB
Loading
35.3 KB
Loading
79.4 KB
Loading
53 KB
Loading

docs/docs/assets/create-team.png

47.6 KB
Loading
124 KB
Loading
48.1 KB
Loading

docs/docs/assets/election-live.png

70 KB
Loading
49.2 KB
Loading
57.1 KB
Loading
54.4 KB
Loading

docs/docs/assets/new-team.png

51.8 KB
Loading
47.4 KB
Loading
Loading
63 KB
Loading

docs/docs/assets/team-details.png

53.5 KB
Loading

docs/docs/assets/team-elections.png

36.3 KB
Loading

docs/docs/assets/team-updated.png

59.5 KB
Loading

docs/docs/assets/workspace.png

41.3 KB
Loading

docs/docs/candidature.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
11
# Standing for election
2+
3+
* As a member of the Community, "All Elections" is where you will find
4+
inforamtion about active Elections within the Community
5+
6+
![All Elections](./assets/all-elections.png)
7+
8+
## Submit your Candidature form
9+
10+
* You can select one of the listed Elections to look at additional information
11+
about it and to submit your Candidature form
12+
13+
![Election information](./assets/select-live-election.png)
14+
15+
* Please provide all requested information and click on the "Submit" button
16+
17+
![Apply for candidature](./assets/apply-for-candidature.png)
18+
19+
* Your Candidature form submissions are visible under the "My Submissions" page
20+
21+
![Candidate submissions](./assets/candidature-submissions.png)
22+
23+
## Seeking nominations from the Community
24+
25+
![Candidates](./assets/select-live-election.png)
26+
27+
* The list of Candidates who have successfully submitted a Candidature form
28+
for an Election can be found on the Election page
29+
30+
![Submit nomination](./assets/submit-comment-candidature-form.png)
31+
32+
* Members of the Community can voluntarily or by request comment on a Candidate
33+
and nominate them. Nominations from esteemed and/or active members of the
34+
Community lend credibility to the Candidate, especially for members of the
35+
Community who might not be regularly active or if they are unaware of the
36+
Candidate
37+
38+
![Submitted nominations](./assets/submitted-nomination.png)
39+
40+
* Nominations submitted by the members of the Community are displayed in the
41+
same page

docs/docs/organizing.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,78 @@
11
# Organizing an election
2+
3+
![Dashboard](./assets/workspace.png)
4+
5+
The landing page for Ballot provides easy access to
6+
7+
* the Dashboard, which provides access to the Teams
8+
* the Submissions page, which contains information about my Candidature
9+
submissions
10+
* the All Elections page, which displays information about all of the "Live"
11+
Elections
12+
13+
## Creating a team
14+
15+
* Before you organize an Election, you first need to create a Team. You can
16+
create a Team by clicking on the "Create Team" button on the Dashboard page
17+
and providing a name.
18+
19+
|Create a Team|Updated Dashboard|
20+
|---|---|
21+
|![Create Team](./assets/create-team.png)|![New team](./assets/new-team.png)|
22+
23+
* Once a Team is created, Members can be added to the team by clicking on the
24+
"Add Member" button and providing an email address of a User registered on
25+
the Platform
26+
27+
|Team details|Add a Team member|Updated team details|
28+
|---|---|---|
29+
|![Team details](./assets/team-details.png)|![Add team member](./assets/add-team-member.png)|![Updated team](./assets/team-updated.png)|
30+
31+
## Creating an Election
32+
33+
![Team elections](./assets/team-elections.png)
34+
35+
* Once a "Team" has been created, all Elections for the Team can be viewed under
36+
the "Elections" page. A new Election can be created by clicking on the
37+
"Create Election" button and providing a Title for the election.
38+
39+
|Create new Election|Updated Elections page|
40+
|---|---|
41+
|![Create new election](./assets/create-new-election.png)|![Election details](./assets/elections-details.png)|
42+
43+
* Once created, the Election should be displayed in the Elections page. By
44+
default, the Election isn't "live". To make it "live", please click on the
45+
Election and update the "Status" under "Details" to "Live", provide a
46+
"Slug", and update the Description of the Election.
47+
48+
![Election status](./assets/election-live.png)
49+
50+
## Creating a Candidature Form
51+
52+
![Election candidates](./assets/election-candidates.png)
53+
54+
* Members of the Community who are interested in running for Election should
55+
submit a Candidature Form. The Candidature Form can be created by clicking
56+
on "Create Form" under the "Candidates" section of the Election
57+
58+
![Create candidate form](./assets/create-candidate-form.png)
59+
60+
* The Candidate Form can be customized according to the needs of the Community
61+
e.g. the layout of the forum and the questions in the forum can be
62+
customized when creating the Candidature Form.
63+
64+
![Edit candidate form](./assets/edit-candidate-form.png)
65+
66+
* The Candidature Form needs to made "Live" by clicking on "Update Form"
67+
and updating the Status to "Live". The "Description" for the Candidature
68+
Form can also be updated here
69+
70+
## Manage Candidates
71+
72+
* Once created, members of the Community can express their interest in running
73+
for Election by submitting information via the Candidature Form. Information
74+
about submissions can be viewed in the "Candidates" page for the Election.
75+
76+
|Candidates with no submissions|Candidates page with a submission|
77+
|---|---|
78+
|![Manage candidates](./assets/manage-candidates.png)|![Manage candidates updated](./assets/manage-candidates-updated.png)|

0 commit comments

Comments
 (0)