Comments and Style fixes. Review 1.
diff --git a/SocialFeaturesMelangeGSoC2010.wiki b/SocialFeaturesMelangeGSoC2010.wiki index 8ecc8fe..60fabec 100644 --- a/SocialFeaturesMelangeGSoC2010.wiki +++ b/SocialFeaturesMelangeGSoC2010.wiki
@@ -13,7 +13,7 @@ == 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. +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 details of this feature's design and implementation are as follows. The tabs of the user page will be as follows: * Profile @@ -22,22 +22,30 @@ ===Workflow=== -Workflow for Users +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 +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.) + # There are two possibilities from here: + # 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). + # 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. +----- +Comment (Madhu): I think there should be only one edit page where they can edit all the three tabs. +----- + # 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.) +----- +Comment (Madhu): Nope, that makes the interface too complicated and messy. Or if you would like, don't make it generic, but give Admins options for 2 RSS widgets. Thats the max, not more than that for sure. +----- # 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=== -*User Page* +*UserPage* This will be the master model for this feature which will enclose the three tabs that make up this feature. @@ -56,6 +64,10 @@ * Initialized - This user_page is in this state when the user has entered the user page and authorized to display his basic user information already in the GSoC system. * Updated - The user has entered or changed existing information in his user page. * Deactivated - The user account has been terminated. + +----- +Comment (Madhu): Status is good, but I don't think Uninitialized, Initialized and Updated is a good idea. Instead we can just have three states like, visible, invisible and invalid. +----- *Profile Tab* @@ -153,8 +165,19 @@ * user_page – *ReferenceProperty* * feed_url - *LinkProperty* +----- +Comment (Madhu): Oh! I am extremely sorry for not making this clear earlier, when you started writing it out, but anyways better late than never. You need not create so many Python files and data models. From what I can see all the files and data models you have specified above can be merged into one single file with one single data model. So many reference properties is not good. Also, even if we keep all the data you have specified in a single data model we can write views in such a way that it shows only what data needs to be shown to a specific user and tabbing etc etc can all be controlled by views and templates. So we might not want so many data models. We will have to redesign this together. +----- + ===State Diagrams=== + += Specification & Requirements = + The detailed project specification will be added and updated here. + += Timeline = + The tentative project timeline will be added here. + = Meetings and Agendas = == Friday April 30, 2010 13:30:00 in UTC == @@ -251,10 +274,4 @@ * 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. \ No newline at end of file