Page MenuHomePhabricator

Outreachy Proposal for Technology to transclude git content into wiki pages
Closed, DeclinedPublic

Description

Information for my profile
• Name: Shrutika Gulati
• Email: shrutikagulati@gmail.com
• Mediawiki Username: @Shrutika719
• IRC nickname: Shrutika
• Location: Noida, Uttar Pradesh, India
• Typical working hours: 9 P.M. to 5 A.M. from 7/12/2015 to 7/3/2016
• Time Zone: UTC + 5:30
• Preferred pronoun: She

Possible Mentors
• S Page (@Spage)
• Gergo Tisza (@Tgr)
• Ankita Shukla(@Ankitashukla)

Description of Project
This project solves the issue of copy + paste work that is required to be done for the content living in git but meant to appear in wiki pages. The output of this project will be an extension which will transclude git content into wiki pages. This will help the users to get the desired information from wiki pages inspite of searching them on the git and whenever any git document gets updated it will be reflected in the wiki pages.

Solution
Phases of developing Extension:

  1. Setup
  2. Execution
  3. Localization

The first task is to create a parser and HTTP request git server for documents, code snippets etc. For that the user requesting for a git document should provide the required filename, the url of its repository, the branch in which the file exists, the language in which the code is written and the commitId. And then cache it with an expiration limit which will be set in the parser cache.

The second task would be create a database which will keep a track that the content of a particular git file is being updated in which wiki page.

The third task would be to reflect the changes made in the git docs on the wiki pages. So whenever there will be any commit on the page obtained from git, the changes will be reflected in the wiki pages. We will store the start and end line of the change made in the document so that it is easy to make change in the wiki pages.

Timeline
All the research work, a request for repository and Wikimedia lab instance will be sent before the start of the internship period.

Weekly Tasks

WeekTasks
7/12/15 - 13/12/15Explore the problem statement and the existing parsers and start creating a parser
14/12/15 – 20/12/15Create a parser for parsing the git documents and provide the raw text to Lua for parsing and extraction
21/12/15 – 27/12/15Test the parser for all the use cases
28/12/15 – 3/1/16Modify the extension to include all the use cases for requesting the git server for a file
4/1/16 – 10/1/16Test the code developed till date and start with the documentation work
11/1/16 – 17/1/16Create and manage a database to map the git documents to wiki pages using MySQL
18/1/16 – 24/1/16Look for a method to update the wiki pages
25/1/16 – 31/1/16Develop a module to update the git documents into wiki pages
1/2/16 – 7/2/16Develop the script to update the git pages
8/2/16 – 14/2/16Test the code for all possible cases
15/2/16 – 21/2/16Integrate all the work done till date
22/2/16 – 28/2/16Fix the bugs if any and apply unit testing
29/2/16 – 7/3/16Complete the documentation and deliver the project

Deliverables
At the end of the project the deliverables will be an extension to transclude git content into wiki pages and cover all the possible cases when git server is requested for a document. Then update wiki pages with the content extracted and at last deploy the extension and provide its documentation.

Participation
I will be actively updating all the major and minor changes related to the project. Like all the documentation will be regularly updated, all the codes will be updated on gerrit and I will remain in constant touch with the mentors through irc channels.

About Me

Education: I am a fourth year student pursuing my Integrated BTech + MTech degree in Computer Science Engineering from JIIT, Noida, India.

How did you hear about the program?
From the seniors of my college.

Do you meet the eligibility requirements outlined at https://wiki.gnome.org/Outreachy#Eligibility?
Yes, I am eligible.

Will you have any other time commitments, such as school work, another job, planned vacation, etc., during the duration of the program?
I will dedicate near about 50 hours per week. My college will take only 20 hours per week and I do not have any other commitments during internship period.

We advise all candidates eligible to Google Summer of Code and FOSS Outreach Program for Women to apply for both programs. Are you planning to apply to both programs and, if so, with what organization(s)?
I am currently applying to Outreach Program for Women but I would love to work with WMF in the next round of GSoC.

We don't just care about your project -- you are a person, and that matters to us! What drives you? What makes you want to make this the most awesomest wiki enhancement ever?
I am a very hard working person and fully committed towards my goal. I hope I can prove my worth during the internship period and make this the most awesomest wiki enhancement ever.

What does making this project happen mean to you?
I chose Wikimedia among all the organizations to contribute because Wiki resources have played a vital part in providing information about everything we look for in a day. I am keen on contributing my bit to Wiki and moreover I am going to pursue my career in this field so I think I can learn a lot from my mentors during the internship period.

Past Experience
I have been working on the following projects:
Project 1
Title: CODEKARLO.com- A Collaborative Code Editing website
Language: HTML, CSS, PHP, Javascript, Python
Summary: A code editor on which two people can work from two remote places at the same time. It is a real time code editor which facilitates video chat, file transfer and text chat for the additional discussion.

Project 2
Title: Map based mashup website
Language: HTML, CSS, PHP(majorly used), Javascript
Summary: A web application which helps a person to search for whatever he needs to according to his current location.

I have completed the microtask T115959 and I have submitted my code on phabricator but I could not submit it on gerrit as my semester exams were going on and I was facing some connection problem with the server. If given a chance I promise to get it reviewed by gerrit ASAP.

Event Timeline

Shrutika719 claimed this task.
Shrutika719 raised the priority of this task from to Normal.
Shrutika719 updated the task description. (Show Details)
Slaporte set Security to None.
Slaporte awarded a token.

We find that you are having university/school during the Outreachy round 11 internship period ( Dec 2015 - March 2016 ). Please fill in the following details too in your proposal description so that we stick to the Outreachy norms.

https://wiki.gnome.org/Outreachy#Application_Form

Will you have any other time commitments, such as school work, exams, research, another job, planned vacation, etc., between December 7, 2015 and March 7, 2016? How many hours a week do these commitments take? If a student, please list the courses you will be taking between December 7, 2015 and March 7, 2016, how many credits you will be taking, and how many credits a full-time student normally takes at your school:

01tonythomas closed this task as Declined.Nov 23 2015, 8:45 AM

Thank you for your proposal. Sadly, the Outreachy administration team made it strict that candidates with any kind of academic/other commitments are not approved for this round. Please consider talking with your mentors about further steps, and we hope to see your application ( the same too, if the consensus still exist ) in the next round of GSoC/Outreachy. Closing the same as declined, and all the very best for the next round!