Skip to content

Commit a531bbf

Browse files
jaskiratsingh2000gitbook-bot
authored andcommitted
GitBook: [master] 6 pages modified
1 parent ee13805 commit a531bbf

File tree

6 files changed

+120
-84
lines changed

6 files changed

+120
-84
lines changed

SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
* [Development of Admin Management mechanism for DONUT](activities/gsoc2020/gsoc2020-ideas/role-management.md)
3434
* [Developing a module with a Tag Cloud with a post check mechanism](activities/gsoc2020/gsoc2020-ideas/tag-mechanism.md)
3535
* [Displaying Github Activity Data in Donut Platform](activities/gsoc2020/gsoc2020-ideas/github-bot.md)
36-
* [Proposal Functionality](activities/gsoc2020/gsoc2020-ideas/draft-proposal-functionality.md)
36+
* [Proposal Functionality\(Pledge a research project\) inside Donut](activities/gsoc2020/gsoc2020-ideas/draft-proposal-functionality.md)
3737
* [Personal Assistant for Donut Platform](activities/gsoc2020/gsoc2020-ideas/draft-bot-for-donut-platform.md)
3838
* [Integrations for Donut](activities/gsoc2020/gsoc2020-ideas/draft-url-shortener-for-donut.md)
3939
* [Badge and point allotment Api](activities/gsoc2020/gsoc2020-ideas/badge-and-point-allotment-api.md)
Lines changed: 29 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Personal Assistant for Donut Platform
22

3-
### Tasks:
3+
### Priority:
4+
5+
High
6+
7+
### Description:
8+
9+
#### Tasks:
410

511
* [ ] Build the UI of the bot.
612
* [ ] Bot should respond based on pre defined commands:
@@ -10,34 +16,39 @@
1016
* [ ] Remove an item from todo
1117
* [ ] Mark an item to done
1218

13-
### **Detailed Info:**
19+
#### **Detailed Info:**
1420

1521
This bot is to be built as an independent module which will be integrated into Donut platform. Making it as an independent module will help us make this available to anyone willing to integrate this bot into there website/platform.
1622

17-
### **Working:**
23+
#### **Working:**
24+
25+
Upon integrating this with Donut user should be able to use this bot upon clicking the bot icon on the lower right corner of the screen.
26+
27+
Upon clicking on the icon the bot should present user the commands that user can use in order to get a task done. For the beginning we are going ahead with TODO functionality. So when the bot interface opens users should be able to see 4 commands that will be viewing all the todos, adding a new to the list, removing a todo, marking todo as done. Clicking on each one of them should preform the desired task.
28+
29+
If deadline of a particular todo is approaching the bot window should open automatically and send user a message saying the deadline is today or tomorrow.
1830

19-
Upon integrating this with Donut user should be able to use this bot upon clicking the bot icon on the lower right corner of the screen\[2\].
20-
1. Upon clicking on the icon the bot should present user the commands that user can use inorder to get a task done. For the begining we are going ahead with TODO functionality. So when the bot interface opens users should be able to see 4commands that will be viewing all the todos, adding a new to the list, removing a todo, marking todo as done. Clicking on each one of them should preform the desired task.
21-
2. If deadline of a particular todo is approaching the bot window should open automatically and send user a message saying the deadline is today or tomorrow.
31+
tegrate Jitsi with Donut platform.
2232

23-
### References:
33+
{% hint style="warning" %}
34+
**References:** [**Intercomm**](https://www.intercom.com/) **,** [**ToDo Bot - Working inside Telegram**](https://botostore.com/c/todobbot/#) **,** [**First Telegram Bot**](https://chatbotslife.com/your-first-telegram-bot-47ea6034d311) ****
35+
{% endhint %}
2436

25-
\[1\]Bot interface design - To be provided.
26-
\[2\][https://www.intercom.com/](https://www.intercom.com/)
27-
\[3\][https://botostore.com/c/todobbot/\#](https://botostore.com/c/todobbot/#)
28-
\[4\][https://chatbotslife.com/your-first-telegram-bot-47ea6034d311](https://chatbotslife.com/your-first-telegram-bot-47ea6034d311)
37+
### **Required Skills/knowledge:**
2938

30-
### Tech Stack: <a id="tech-stack"></a>
39+
* Tech Stack MongoDB Rest API
40+
* Working with Backend
41+
* Nodejs, ES 6 am Reactjs
3142

32-
* MongoDB, RESTapi,
33-
* NodeJs, ES 6, ReactJs
43+
### **Difficulty Level:**
3444

35-
### Difficulty Level: Moderate to Hard
45+
Hard
3646

37-
### Potential Mentors:
47+
### **Expected Outcome:**
3848

39-
* [Jaskirat Singh](https://github.com/jaskirat2000)
40-
* [Devesh Verma](https://github.com/devesh-verma)
49+
* This would end up becoming a bot which will be used inside the Donut platform and can be called as a assistant for the users.
4150

51+
### **Potential Mentors:**
4252

53+
\*\*\*\*[**Jaskirat Singh**](https://github.com/jaskirat2000) **and** [**Devesh Verma**](https://github.com/devesh-verma) ****
4354

activities/gsoc2020/gsoc2020-ideas/draft-proposal-functionality.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,22 @@
1-
# Proposal Functionality
1+
# Proposal Functionality\(Pledge a research project\) inside Donut
22

3-
### **Summary:**
3+
### Priority:
4+
5+
Medium
6+
7+
### Description:
8+
9+
#### **Summary:**
410

511
This feature of Donut platform will enable individual developers to reach out to Open Source Organizations. Doing so will help developers and organizations in many different ways, lets see how developers can get benefit from this:
612

713
* Consider an individual developer who is passionate about his/her project which he/she thinks is good enough and wants to showcase this project under any reputed organization.
814
* Consider a scenario where developer wants to reach out to a bigger crowd of developers seeking help in development or enhancement of the project.
915
* Or say someone has some crazy idea which he wants to propose under any Open Source Organization seeking help from them then this functionality will help the developer in such scenario.
1016

11-
### **Detailed Info:**
17+
#### **Detailed Info:**
1218

13-
#### User Facing Tasks:
19+
#### Here are the User Facing Tasks:
1420

1521
* [ ] Build a Proposal page in Donut platform.
1622
* [ ] Proposal page should have a markdown editor.
@@ -53,8 +59,21 @@ As the user submits the proposal the the admins of the organization should be ab
5359
If Admin marks as more info required which is Stage 3 of the proposal tracker, in that case the admin should be able to add comments from the new page where the proposal opens up for review. Also, any comments added by the user should also be visible to admins on that page.
5460
If admins feels the idea or project is good and wants to proceed with it then they can change the state of the proposal to accepted state. As soon as the proposal gets accepted the user should a congratulation email says the propsal has been accepted.
5561

56-
**Task 3: Intergrate Jitsi for video calls:**
57-
To provide more flexibility in terms of interaction between admins and user. Admins can setup a meeting with the user. To provide this video call functionality you need to intergate Jitsi\[2\] with Donut platform.
62+
**Task 3: Integrate Jitsi for video calls:**
63+
To provide more flexibility in terms of interaction between admins and user. Admins can setup a meeting with the user. To provide this video call functionality you need to integrate Jitsi with Donut platform.
64+
65+
{% hint style="warning" %}
66+
**References:** [**Integration of Jitsi**](https://jitsi.org/) **,** [**Make a Pledge \| Open Collective**](https://opencollective.com/pledges/new)\*\*\*\*
67+
{% endhint %}
68+
69+
### **Required Skills/knowledge:**
70+
71+
* Tech Stack Nodejs, Reactjs and MongoDB
72+
* Working with AWS S3
73+
74+
### **Difficulty Level:**
75+
76+
Hard
5877

5978
### **Expected Outcome:**
6079

@@ -68,20 +87,7 @@ To provide more flexibility in terms of interaction between admins and user. Adm
6887
* Admin can setup a meeting with the user using Jitsi.
6988
* User should receive email once proposal gets accepted.
7089

71-
### **References:**
72-
73-
\[1\] Proposal page design link. TO BE ADDED SOON
74-
\[2\] [https://jitsi.org/](https://jitsi.org/)
75-
76-
### Tech Stack:
77-
78-
* MongoDB, AWS S3.
79-
* NodeJs, JavaScript, ReactJs
80-
81-
### **Difficulty Level:** Hard
82-
8390
### **Potential Mentors:**
8491

85-
* [**Jaskirat Singh**](https://github.com/jaskirat2000)
86-
* [**Devesh Verma**](https://github.com/devesh-verma)
92+
[**Devesh Verma**](https://github.com/devesh-verma) ****and [**Vaibhav D. Aren**](https://github.com/vaibhavdaren)\*\*\*\*
8793

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
# Displaying Github Activity Data in Donut Platform
22

3+
### Priority:
4+
5+
High
6+
7+
### Description:
8+
9+
**Summary:**
10+
11+
Build a GitHub bot which users can install from GitHub marketplace\[1\] and configure the bot on selected repositories / all repositories based on users choice. After successful installation, the bot should send details of activities happening in the repositories on which bot is configured. Here repository activities refer to actions done by any user.
12+
313
* Bot Functionalities:
4-
* Issues\[open/close/comment/assign/unassign/assignedUsers\]
14+
* Issues\[open/close/comment/assign/unassigned/assigned Users\]
515
* pr\[open/close/comment/review\]
616
* Share Issue on Donut as a post
717
* Reply to comments through Donut platform
818
* While enabling the bot
919
* Send a request to admin
10-
* Then select repos to enable the bot
11-
12-
TODO: build a simple bot to check the complexity.
13-
20+
* Then select repositories to enable the bot
1421

15-
### Summary
16-
17-
Build a GitHub bot which users can install from GitHub marketplace\[1\] and configure the bot on selected repositories / all repositories based on users choice. After successful installation, the bot should send details of activities happening in the repositories on which bot is configured. Here repository activities refer to actions done by any user.
18-
19-
### **Detailed Info:**
22+
#### Detailed Info:
2023

2124
**TASK 1:** The main purpose of this bot is to show github activity inside Donut platform. This feature will help users stay updated with all types of activities happening in the repository on which the bot has been configured. ****Donut platform will have a dedicated page to show github activities which users can access after logging in where they will able to see every activity that happens on github repos.
2225

@@ -35,35 +38,31 @@ Build a GitHub bot which users can install from GitHub marketplace\[1\] and conf
3538

3639
**TASK 3:** Build sharing functionality, such that every activity which is displayed on the activity page, user should be able to share any activity as a post.
3740

38-
### **Expected Outcome:**
39-
40-
* The user should be able to install this bot on repositories they wish to.
41-
* The bot should send activity data\(mentioned in Detailed info section\) to donut platform.
42-
* Display the received data in proper format as show in the design.
43-
* User should be able to share any activity as a post.
41+
{% hint style="warning" %}
42+
**References:** [**Github Market Place, Demonstrating expectations from the bot**](https://github.com/marketplace) **,** [**Probot**](https://probot.github.io/)\*\*\*\*
43+
{% endhint %}
4444

4545
The bot will be sending activity data to donut platform where the activities will be displayed
4646

47-
**References:**
48-
49-
\[1\]: [https://github.com/marketplace](https://github.com/marketplace) \[2\]:You can make use of [probot](https://probot.github.io/).
50-
51-
### Tech Stack:
52-
53-
* Nodejs
54-
* Reactjs
55-
* MongoDB
56-
5747
### **Required Skills/knowledge:**
5848

49+
* Tech Stack Nodejs, Reactjs and MongoDB
5950
* Good knowledge of databases
6051
* Good knowledge of Back-end
61-
* Languages such as NodeJs, JavaScript, React
52+
* Prior knowledge of UI/UX
53+
54+
### **Difficulty Level:**
6255

63-
### **Difficulty Level:** Moderate
56+
Moderate
57+
58+
### **Expected Outcome:**
59+
60+
* The user should be able to install this bot on repositories they wish to.
61+
* The bot should send activity data\(mentioned in Detailed info section\) to donut platform.
62+
* Display the received data in proper format as show in the design.
63+
* User should be able to share any activity as a post.
6464

6565
### **Potential Mentors:**
6666

67-
* [**Jaskirat Singh**](https://github.com/jaskirat2000)
68-
* [**Devesh Verma**](https://github.com/devesh-verma)
67+
[**Jaskirat Singh**](https://github.com/jaskirat2000) and [**Devesh Verma**](https://github.com/devesh-verma)
6968

activities/gsoc2020/gsoc2020-ideas/role-management.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# Development of Admin Management mechanism for DONUT
22

3-
**Priority:** High
3+
### **Priority:**
44

5-
**Description:** [**Donut Platform**](https://github.com/codeuino/Social-Platform-Donut) is a flexible open source **Social Network Kit that aims** to give you the customized social network, social intranet or huge social enterprise application for communities that really fits their needs.
5+
High
6+
7+
### **Description:**
8+
9+
[**Donut Platform**](https://github.com/codeuino/Social-Platform-Donut) is a flexible open source **Social Network Kit that aims** to give you the customized social network, social intranet or huge social enterprise application for communities that really fits their needs.
610

711
Development of configuration mechanism is one of our newest additions to our installation frameworks of Donut Platform. Currently Donut is central hosted but aims to get bundled as FOSS/OSS tool. So, the task of this major project is to develop an **Admin Management System** that will allow individuals or community admins to setup for themselves. To simplify the configuration, these predefined modules will have the most common use cases with different options for modules and settings while setting up this environment.Few have been described below which would serve essential features as a separate modules:
812

913
1. Development of module for Configuration screens :
1014
2. **Screen 1:** Registering Admin account with information such as Admin name, Email, Username, Password, etc. For example check [**here**](https://www.tecmint.com/wp-content/uploads/2018/05/Create-New-Discourse-Account.png)
1115
3. **Screen 2:** Include Admin Account Confirmation through email. An email send to the Admin account, On confirmation should redirect them to the page of "Activate Account" which further leads to other setup.
12-
4. **Screen 3:** Welcoming Screen, that should allow to setup Community account. For hint check [**here**](https://support.patreon.com/hc/article_attachments/360027026912/Image_2019-04-24_at_9.25.35_AM.png)\*\*\*\*
16+
4. **Screen 3:** Welcoming Screen, that should allow to setup Community account. For hint check [**here**](https://support.patreon.com/hc/article_attachments/360027026912/Image_2019-04-24_at_9.25.35_AM.png)
1317
5. **Screen 4:** Setting up Community profile and permissions like Community Name, Description,Welcoming Invites, Access \( Is community open to everyone or limited to invites,etc. \), Automated Invites, System Email setup, etc.
1418
6. **Screen 5:** This screen includes **View** are from User end that how the Admins want their platform to look like. This will have custom things like Theme Selection, Community Top bar \( Including Logos\), home page look, some other modules. **\(Important Part !\)**
1519
7. **Screen 6:** Includes the Thumbnail or the preview of the main page based upon the settings configured by Admin.
@@ -30,17 +34,23 @@ This will include building of Admin panel or dashboard which will be visible to
3034
**References:** [**Youtube Guide of Discourse SetUp**](https://www.youtube.com/watch?v=sjFlBgSiyCY) **,** [**How to bundle a software \| Tom's Guide**](https://forums.tomsguide.com/threads/how-to-bundle-software-in-one-installer.310629/) **,** [**Admin panel Templates**](https://colorlib.com/wp/admin-panel-templates/)
3135
{% endhint %}
3236

33-
**Required Skills/knowledge:**
37+
### **Required Skills/knowledge:**
3438

3539
* Good knowledge of databases
3640
* languages such as NodeJs, JavaScript, React;
3741
* Knowledge of visual representation
3842
* Good Knowledge of Modules Bundling
3943
* UI/UX experience is also required with unique approach.
4044

41-
**Difficulty Level:** Moderate
45+
### **Difficulty Level:**
46+
47+
Moderate
48+
49+
### **Expected Outcome:**
50+
51+
This project would result in formation of packaged setup of a Donut platform along side with Admin panel with new User Interface that would allow the Admins/Moderators to use it in their custom way.
4252

43-
**Expected Outcome:** This project would result in formation of packaged setup of a Donut platform along side with Admin panel with new User Interface that would allow the Admins/Moderators to use it in their custom way.
53+
### **Potential Mentors:**
4454

45-
**Potential Mentors:** [**Jaskirat Singh**](https://github.com/jaskirat2000) , [**Devesh Verma** ](https://github.com/devesh-verma) and [**Vaibhav D. Aren**](https://github.com/vaibhavdaren)
55+
[**Jaskirat Singh**](https://github.com/jaskirat2000) , [**Devesh Verma** ](https://github.com/devesh-verma) and [**Vaibhav D. Aren**](https://github.com/vaibhavdaren)
4656

0 commit comments

Comments
 (0)