|
| 1 | +--- |
| 2 | +collaborating_projects: |
| 3 | + - coala |
| 4 | +desc: "Enhance and Improve the architecture of coala Community and Projects |
| 5 | +website with new API Endpoints in webservices" |
| 6 | +difficulty: hard |
| 7 | +initiatives: |
| 8 | + - GSoC |
| 9 | +issues: |
| 10 | + - "https://github.com/coala/projects/issues/691" |
| 11 | +markdown: enhance-and-improve-coala-community-and-projects-website.md |
| 12 | +mentors: |
| 13 | + - damngamerz |
| 14 | +name: "Enhance websites architecture" |
| 15 | +requirements: |
| 16 | + - "At least one patch accepted to coala community, projects and webservices |
| 17 | + repository." |
| 18 | + - "The applicant should be familiar with AngularJS, Django and Python." |
| 19 | +tags: |
| 20 | + - community |
| 21 | + - projects |
| 22 | + - webservices |
| 23 | + - AngularJS |
| 24 | + - Django |
| 25 | + - Python |
| 26 | +--- |
| 27 | +### Overview |
| 28 | +The motivation here, is to enhance and improve the websites ([community](https://community.coala.io) and |
| 29 | +[projects](https://projects.coala.io)) for the coala community, for newcomers |
| 30 | +who wish to start contributing to coala open-source organization and for other |
| 31 | +organizations. The hurdle that newcomers mainly come across is the invitation |
| 32 | +to the organization before making any contributions, so this project adds a |
| 33 | +form for newcomers who wish to join the coala community. Also, to give a |
| 34 | +motivation to existing contributors, coala has created a `Promotion form` which |
| 35 | +will promote them to `coala Developer` status. To reduce the workload for |
| 36 | +maintainers, this project includes the development of form with some |
| 37 | +rudimentary checks that will promote the coala-newcomer to coala-developer. |
| 38 | +Moreover, this project adds major enhancements to websites that will help |
| 39 | +newcomers as well as developers to know more about this community and about |
| 40 | +what they have contributed to it. |
| 41 | + |
| 42 | +### Goals |
| 43 | + |
| 44 | +* Add calendar app to show timeline for various events |
| 45 | +* Add a one-stop tab for all google forms |
| 46 | +* Add contributors geolocation |
| 47 | +* Add *Login/SignUp* using GitHub |
| 48 | +* Add organization teams |
| 49 | +* Advanced filters |
| 50 | +* Automate welcoming process for newcomer |
| 51 | +* Automate newcomer promotion |
| 52 | +* Create new database models to manage data |
| 53 | +* Ease navigatibility in websites |
| 54 | +* Improve the **UI/UX of websites** to make more interactive |
| 55 | +* Motivating newcomers & developers with - |
| 56 | + * modifications in Gamification Leaderboard |
| 57 | + * adding a tab of **GSoC** in projects website |
| 58 | +* New coala-community logo |
| 59 | +* Contributors profile page |
| 60 | +* Admin/Maintainers dashboard |
| 61 | + |
| 62 | +### Milestones |
| 63 | + |
| 64 | +#### PREPARATION/BONDING |
| 65 | + |
| 66 | +* Detailed research on what **new cron jobs** or **API endpoints** need to be |
| 67 | + added in [coala webservices](https://gitlab.com/coala/landing/). |
| 68 | +* Discussion on improvements to be made in coala [community website](http://community.coala.io/) and |
| 69 | + [projects website](http://projects.coala.io/) |
| 70 | +* Research on new models to be created (if any) and adding new fields to |
| 71 | + existing db models in coala community website **db models**. |
| 72 | +* *Created* and *Merged* a cEP of how the new enhancements will be implemented |
| 73 | + and how will it be beneficial to [coala community](https://github.com/orgs/coala/teams/coala-newcomers). |
| 74 | + |
| 75 | +#### CODING PHASE 1 |
| 76 | + |
| 77 | +1. Implementation of methods in **coala [webservices](https://gitlab.com/coala/landing)** |
| 78 | +2. Implementation of listed enhancements in coala [community website](http://community.coala.io/) |
| 79 | + |
| 80 | + a. Create new **[Community Logo](https://github.com/coala/community/issues/55) + Header Image of README.md** |
| 81 | + |
| 82 | + b. Add [contributor's Geolocation](https://github.com/coala/community/issues/18) |
| 83 | + |
| 84 | + c. Add [Organisation Teams](https://github.com/coala/community/issues/12) |
| 85 | + |
| 86 | + d. Add [Mentors](https://github.com/coala/community/issues/11) |
| 87 | + |
| 88 | + e. Add **Newcomer Invitation** [form](https://github.com/coala/community/issues/89#issuecomment-468955279) |
| 89 | + |
| 90 | + f. Add **Promotion to Developer** [form](https://github.com/coala/community/issues/89) |
| 91 | +3. Make Improvements (or fix bugs) in coala [community website](https://community.coala.io/) |
| 92 | + |
| 93 | + a. Build failure for more than one remote [#235](https://github.com/coala/community/issues/235) |
| 94 | + |
| 95 | + b. Netlify build failure for fork [#232](https://github.com/coala/community/issues/232) |
| 96 | + |
| 97 | +#### CODING PHASE 2 |
| 98 | + |
| 99 | +1. Implementation of listed enhancements in coala [community website](http://community.coala.io/) |
| 100 | + |
| 101 | + a. Manage live data of community members |
| 102 | + |
| 103 | + b. Addition of more data fields in **Users** db model |
| 104 | + |
| 105 | + c. Create **Profile Page** |
| 106 | + |
| 107 | + d. Add **Login and Sign-up** using GitHub |
| 108 | + |
| 109 | + e. Leaderboard on **[Homepage](https://coala-community.netlify.com/)** |
| 110 | + |
| 111 | + f. Enhancement in **[Gamification Leaderboard](https://coala-community.netlify.com/gamification/)** |
| 112 | + |
| 113 | +2. Make Improvements in coala [community website](https://community.coala.io/) |
| 114 | + |
| 115 | + a. **[Gamification Leaderboard](https://coala-community.netlify.com/gamification/)** |
| 116 | + |
| 117 | + b. **[UI](https://coala-community.netlify.com/)** |
| 118 | + * [Re-designing of the website](https://github.com/coala/community/issues/44) and making it responsive. |
| 119 | + * [Inactive Issue](https://coala-community.netlify.com/static/inactive-issues.json) and [unassigned issues activity](https://coala-community.netlify.com/static/unassigned-issues.json) web pages shows |
| 120 | + just JSON response, it should be displayed in proper format with some |
| 121 | + extra important information. |
| 122 | + * [Meta-Review data](https://coala-community.netlify.com/meta-review/) web pages should be redesigned to make it look good. |
| 123 | + |
| 124 | +#### CODING PHASE 3 |
| 125 | + |
| 126 | +1. Implementation of listed enhancements in [projects website](https://projects.coala.io) |
| 127 | + |
| 128 | + a. [Improve](https://github.com/coala/projects/issues/394) the projects website for use by other GSoC orgs |
| 129 | + |
| 130 | + b. Add **[Filters](https://github.com/coala/projects/issues/559)** for searching projects |
| 131 | + |
| 132 | + c. Create [tab for all the google forms](https://github.com/coala/projects/issues/284) |
| 133 | + |
| 134 | + d. Add [posts / calendar app](https://github.com/coala/projects/issues/560) to projects website |
| 135 | + |
| 136 | + e. Create a tab for **GSoC Students** |
| 137 | + |
| 138 | +2. Make Improvements (and fix bugs) in coala [projects website](https://projects.coala.io/) |
| 139 | + |
| 140 | + a. **UI** |
| 141 | + * Re-designing of `Index` Page |
| 142 | + * Add UI to reports page that lists all previous year GSOC projects. |
| 143 | + * Improve responsive UI of user reports page. |
| 144 | + |
| 145 | + b. **Various bug fixes -** |
| 146 | + * [Mark issues - Open, Merged or Closed](https://github.com/coala/projects/issues/298) |
| 147 | + * Remove completed projects or ["Completed" tags](https://github.com/coala/projects/issues/342) for projects |
0 commit comments