| #summary Project Documentation for Social Features for Melange(GSoC2010) | |
| #labels Phase-Design,Contents-Draft,Importance-Details | |
| <wiki:toc max_depth="3" /> | |
| = Introduction = | |
| This document will be used to documents the progress and details of the Social Features (GSoC 2010) project for Melange. | |
| = Project Design and Implementation = | |
| == Main Feature 1: Tabbed User Pages == | |
| ===Overview=== | |
| User Page feature will be used by each user to share information about themselves with the rest of the GSoC community. The UI of this feature is designed with tabs, hence users will remain on a single page while navigating between multiple tabs. The design details of this feature's design and implementation are as follows. | |
| The tabs of the user page will be as follows: | |
| * Profile | |
| * Project | |
| * My Stuff (to be renamed later) | |
| ===Workflow=== | |
| Workflow for Users | |
| The workflow for using this feature is largely similar for all user roles in the soc framework, with some differences for the program and organization admins. | |
| Workflow for Student, Mentor, Organization_Admin User roles | |
| # User receives acceptance notification email that they have been accepted to participate in the program. A short message is appended to this email, mentioning that users can now update their respective user pages on Melange as well as view other users’ pages. | |
| # (i) if users click the link, they are redirected to the profile tab of their user page, where they see their partially filled profile based on current user information provided at sign up (i.e. name, current/past user roles).(ii) If they do not click on the email link, whenever they next log into Melange, they will see ‘User Page’ on their sidebar under the ‘User’ tab. Clicking on this will take them to the profile tab of their user page. | |
| # They may further update the data on their profile tab by clicking on the ‘Edit Profile’ button or navigate to the Project tab or My Stuff tab to update the respective data. | |
| # In the Project tab, similar to the Profile Tab, default project data is filled in such as organization name, project name etc. Users can fill in more details by clicking on the ‘Edit Project’ button. Here, students can fill in details of the project they are working on, while mentors can provide details about the project they are mentoring for. Organization_Admins can use this page to provide information about all their student projects. Program_Admins can use this page to provide general information about the program details itself. | |
| # In the My Stuff tab, users can click on “Add Blog Feed”, to insert their blog url to display updates from their blogs using Melange’s RSS widget. (To be confirmed: Can users add more than one feed? Eg. An org_admin might want to add the org’s blog feed as well as their personal blog feed.) | |
| # Once changes are saved, users may return anytime during the course of the program to change and save the information in their user pages. | |
| ===Data Models=== | |
| *Profile Tab* | |
| The additional data model for this feature will be user_profile.py, which will extend the existing user.py model in the soc_core famework. This model will contain additional properties on top of those in the user model. User information such as educational background, professional background, technical skills, interests, hobbies, etc. will be contained in this model. | |
| Data Models for Profile Tab | |
| * user_profile.py | |
| * education.py | |
| * job.py | |
| Properties of user_profile.py | |
| * user - *ReferenceProperty* | |
| * email – *StringProperty* | |
| * phone_number – *IntegerProperty* | |
| * address - *StringProperty* | |
| * website - *LinkProperty* | |
| * about_myself - *StringProperty* | |
| * activities – *StringProperty* | |
| * books – *StringProperty* | |
| * movies – *StringProperty* | |
| * television - *StringProperty* | |
| * profile_picture – *BlobProperty* | |
| * education – *ListProperty* | |
| * job – *ListProperty* | |
| * last_modified - *DateTimeProperty* | |
| Properties of education.py | |
| * user - *ReferenceProperty* | |
| * college_name – *StringProperty* | |
| * major_name – *StringProperty* | |
| * start_date – *DateProperty* | |
| * end_date – *DateProperty* | |
| Properties of job.py | |
| * user - *ReferenceProperty* | |
| * employer_name – *StringProperty* | |
| * position_name – *StringProperty* | |
| * start_date – *DateProperty* | |
| * end_date – *DateProperty* | |
| *Project Tab* | |
| The main additional data model for this feature will be user_project.py. This model will contain particular project related details such as technical details of the project, mentors and students of a given project and other details which users wish to share about their project. | |
| Data Models | |
| * user_project.py | |
| * user_project_details.py | |
| * user_project_update.py (Nice to have, if time permits) | |
| * user_project_comment.py (Nice to have, if time permits) | |
| Properties of for user_project.py | |
| * user - *ReferenceProperty* | |
| * student - *ReferenceProperty* | |
| * organization - *ReferenceProperty* | |
| * mentor – *ReferenceProperty* | |
| * project_details – *ListProperty* | |
| Properties for user_project_details.py | |
| * project_title - *StringProperty* | |
| * languages – *StringProperty* | |
| * apis_frameworks – *IntegerProperty* | |
| * related_url - *LinkProperty* | |
| * project_overview - *StringProperty* | |
| * other_general_info – *StringProperty* | |
| * proposal_link = *LinkProperty* | |
| * user_project_update – *ListProperty* (Nice to have, if time permits) | |
| * current_project – *BooleanProperty* | |
| * past_project - *BooleanProperty* | |
| Properties of for user_project_update.py | |
| * user - *ReferenceProperty* | |
| * update_text – *StringProperty* | |
| * update_time – *DateTimeProperty* | |
| * user_project_comment – *ListProperty* (Nice to have, if time permits) | |
| Properties of for user_project_comment.py | |
| * user – *ReferenceProperty* | |
| * user_project_update - *ReferenceProperty* | |
| * comment_text – *StringProperty* | |
| * comment_time – *DateTimeProperty* | |
| * comment_user – *ReferenceProperty* | |
| Additional Note: Organization and program admins, will have more than one project and multiple students and mentors associated with them. Hence, the model needs to undergo some changes to accommodate them or to develop separate user_admin_project.py models for users with admin roles. | |
| *My Stuff Tab* | |
| Currently, this data model is used to support the rss widget which displays blog feeds; however it can be extended to accommodate other widgets (twitter, calendar etc.). | |
| Data Models | |
| * user_stuff.py | |
| Properties of for user_stuff.py | |
| * user – *ReferenceProperty* | |
| * feed_url - *LinkProperty* | |
| ===State Diagrams=== | |
| = Meetings and Agendas = | |
| == Friday April 30, 2010 13:30:00 in UTC == | |
| ===Meeting Logs=== | |
| Meeting start: http://www.thousandparsec.net/~irc/logm/%23melange.2010-04-30.log.html#t2010-04-30T13:30:05 | |
| Meeting End: http://www.thousandparsec.net/~irc/logm/%23melange.2010-04-30.log.html#t2010-04-30T14:19:13 | |
| ===Meeting Notes=== | |
| Location: #melange on freenode | |
| Time: 13:30:00 Friday April 30, 2010 in UTC | |
| Chaired by: Madhusudan C.S | |
| Notes taken by: Savitha R | |
| * A general overview of the project design was discussed. | |
| * Users should be able to view fellow GSoC students/mentors/admin by (i) geographic location (perhaps like a global map) (ii) by organization attached to (iii) by type of work/projects they are doing (iv) a complete list of all users in the program. | |
| * Users should be able to find other users using the above categories and then further have the option of finding out more information by clicking to view their personal GSoC user pages. | |
| * Privacy & Visibility issues: Users might need to have the option to keep their location and personal information private. In their personal user pages they may or may not choose to share their personal profile. However, they can share information about their projects such as progress, issues and other information related to the project. Further discussion on the specific details is required. | |
| * In addition to finding fellow users by location, users can also choose to view events/calendars by selecting to view the happenings in certain locations only. In this case, the location will dictate the calendar to be displayed. | |
| * Tips on getting familiar with the code and documentation. | |
| * Select or get assigned to a simple patch/issue. Fix and submit the patch. | |
| * Homework assignments during community bonding period to get familiar with Melange code base. | |
| ===Next Meeting=== | |
| Location: #melange on freenode | |
| Time: 13:30:00 Wednesday May 5, 2010 in UTC | |
| Attendees: C.S.Madhusudan, Savitha | |
| Agenda: | |
| * Detailed Project requirements | |
| * Design and Implementation details of project | |
| * Discuss and assigning of patch/bug-fixing home works to be taken up. | |
| == Wednesday May 5, 2010 13:30:00 in UTC == | |
| ===Meeting Logs=== | |
| Meeting start: http://www.thousandparsec.net/~irc/logm/%23melange.2010-05-05.log.html#t2010-05-05T13:30:33 | |
| Meeting End: http://www.thousandparsec.net/~irc/logm/%23melange.2010-05-05.log.html#t2010-05-05T15:19:58 | |
| ===Meeting Notes=== | |
| Location: #melange on freenode | |
| Time: 13:30:00 Wednesday May 5, 2010 in UTC | |
| Chaired by: Madhusudan C.S | |
| Notes taken by: Savitha R | |
| * General discussion on version control. | |
| * Cloning project. - Done | |
| * Learn and understand mercurial version control system as well as commands etc. How to make changes, submit patches, push changes etc. | |
| * Fix and submit a patch a.s.a.p. for the issue no. 890 bug | |
| * APIs to be used – Google Calendar API, Maps API, CalVi UI library, GeoModel for filtering in maps, Google AJAX APIs, default GMAPs UI. | |
| * Project features in detail - Maps | |
| * Global map indicating GSoC students/mentors/etc. and events occurring at specific locations. | |
| * Filtering data displayed on global map using different categories such as | |
| (i)show all GSoC students from specific location | |
| (ii)show all students from specific organization | |
| (iii) show all events organized by program | |
| (iv) show all events for a specific organization | |
| (v) show all events between given date range | |
| (vi) show all students based on the work they are doing (e.g all students working with C/C++ project tags) | |
| issue: have to check app engine quota restrictions | |
| * Maps can be used to display student items or event items with any combination of the above filters. | |
| * UI – An AJAX-based UI which shows the map and a section for users to type in their filtering options, as they type input, map display gets updated dynamically. When users mouse over and click indicated points on the map, there will be a pop-out widget providing more information. If a user scrolls over and clicks on a GSoC meet up event at Singapore then a small widget will pop out showing the details such as time, venue and info about the event. | |
| * Project features in detail – Calendars | |
| * Other than maps view, there will be calendar-only display, to just view events. | |
| * Program calendar and their own organization calendar will be shown in this view. | |
| * If organization admins choose to make their org calendar “public”, this can also be viewed in the calendar display. | |
| * Events can be added by calendar owners only, such as org admins and program admins. Other wishing to share events, can submit a simple form with event details, which calendar owners can approve and publish on their calendar. | |
| * Display-only UI as users will not be allowed to edit calendar events without authorization. | |
| * Pop-out widget like In the maps, with event information and optional Google map view and optional YouTube video embed related to the event. | |
| * Project Features in detail – User pages | |
| * User pages will contain (i)personal profile (ii) picture (iii)project updates (iv) rss widget (iv) (if time permits) twitter widget also! | |
| * UI to be like face book profile pages, with tabs. (i) Profile tab for users to share personal, educational and professional information. (ii) Project tab for users to share info about their project progress, updates and issue. (iii) Other stuff tab where users can add other social widgets such as rss widget for their blog feed. | |
| * Simple forms to be used to get users to fill in profile information etc. Under “Project” tab users can post using a text field which takes in “html”. | |
| * Discussion on resolving issue 890 and submitting patch this weekend. Posting weekly updates to dev blog and submit patches by Friday night (compulsory!). | |
| * Todo List for Savitha | |
| * Keep updating wiki with project design, workflows and formalized implementation details over the week. | |
| * Post on Dev Blog this weeks’ update. | |
| * Fix issue 890 and submit patch. | |
| = Specification & Requirements = | |
| The detailed project specification will be added and updated here. | |
| = Timeline = | |
| The tentative project timeline will be added here. | |