Page MenuHomePhabricator

GSOD 2024 Proposal - Migrating MediaWiki Documentation
Closed, DeclinedPublic

Description

Personal Information

Name : Radha Thakare
Email : thakareradha2001@gmail.com
Location : Maharashtra, India
Working Hours : IST (GMT+5:30)
Available Hours : 40 hours
Resume : Radha_Thakare_CV

I embarked on my tech journey a few years back, coinciding with my introduction to the world of open source. Since then, I've been eager to give back to the community through contributions. While diving into code contributions can be daunting due to the technical expertise required, I quickly realized that there are various avenues beyond coding to contribute to open source.
I've been actively involved in fostering open source communities and have made significant contributions, including participating in GSoC with AOSSIE and The Mifos Initiative. At Mifos, I not only contributed as a developer but also had the privilege of mentoring others.

Open Source Contribution

  1. Research Paper(Published by IEEE)
  2. Worked as Developer and Mentor in GSoC to the Organization name The Mifos Initiative.
  3. Worked on many API Documentation and User Guides - Github

Project

Complete migration of MediaWiki documentation

Abstract

MediaWiki, an open-source wiki software, empowers collaborative content creation for numerous websites, notably Wikipedia. With its simple wikitext markup language, users can seamlessly edit and organize content in real-time. This versatile platform boasts features such as version history tracking and granular user permissions, supported by a robust community of developers and contributors. While the migration of documentation from Meta-Wiki to MediaWiki.org aims to centralize resources, challenges arise from licensing restrictions and content overlap. Nevertheless, MediaWiki remains a powerful tool for knowledge sharing, driving continuous innovation and collaboration online.

Past contributors highlight the absence of a strategy for the task, emphasizing the need for a cohesive plan moving forward mentioned in T181380.

Deliverables

  1. Update existing Meta pages related to MediaWiki documentation, ensuring accuracy, relevance and remaining content.
  2. Develop new MediaWiki.org pages specifically addressing topics covered in Meta documentation related to MediaWiki usage for Wikimedia projects.
  3. Implement the new structure, ensuring alignment with best practices and community needs.

Having stated the above deliverables, here is my detailed approach to achieving them;

My Approach

1.Comparison and Integration:

  • Begin by conducting a comprehensive comparison between the MediaWiki documentation pages existing on Meta-Wiki and their corresponding pages on MediaWiki.org.
  • Identify any discrepancies or missing information on the MediaWiki.org pages that can be sourced from the Meta-Wiki documentation.
  • Integrate the missing information from Meta-Wiki into the relevant pages on MediaWiki.org, ensuring accuracy, consistency, and completeness of the documentation across both platforms.
  • This process calls for exacting attention to detail and can include revising text to comply with documentation requirements or licensing constraints.

2.Creation of New Pages:

  • For Meta-Wiki documentation pages listed under "No MediaWiki.org equivalent," initiate the creation of new pages on MediaWiki.org to cover the content present on the Meta-Wiki pages.
  • Develop these new pages in alignment with established documentation standards and guidelines, ensuring clarity, coherence, and accessibility of the information presented.
  • Include relevant examples, explanations, and usage instructions to provide users with comprehensive guidance on the topic covered by each page.
  • This step involves both content creation and formatting to ensure consistency with existing documentation on MediaWiki.org.

3.Review and Organization:

  • Conduct a thorough review of Meta-Wiki documentation pages listed under "Actually WMF-specific" to assess their usability and relevance.
  • Determine the most effective organizational structure to enhance the discoverability and maintenance of these pages, considering factors such as topic relevance, user needs, and ease of navigation.
  • Implement the chosen organizational structure, which may involve categorization, tagging, or restructuring of pages to streamline access and management of the content.
  • This step requires careful consideration of user requirements and feedback to optimize the organization of documentation across Meta-Wiki.

4.Documentation, Reporting, and Updated Structure for Maintenance:

  • I will work on documenting the entire migration process, detailing each step taken, challenges encountered, and solutions implemented along the way.
  • Provide clear and concise recommendations for ongoing maintenance and improvement of documentation on both Meta-Wiki and MediaWiki.org, based on insights gained during the migration project.
  • Compile a final report summarizing the outcomes and achievements of the project, including metrics such as the number of pages migrated, improvements made, and impact on user experience.
  • In addition to documentation and reporting, design a new structure for maintenance that facilitates efficient ongoing management and updates of the documentation on both Meta-Wiki and MediaWiki.org.
  • Consider factors such as content organization, version control, access permissions, and contributor workflows when designing the new maintenance structure.
  • Implement the new maintenance structure, ensuring that it aligns with established best practices and addresses the specific needs and challenges of MediaWiki documentation under guidance of mentors.
  • This step ensures the long-term sustainability and effectiveness of the documentation, enabling continued growth and improvement over time while streamlining maintenance processes for contributors.

Timeline

TimelineTaskPriority
May 20 - June 1Onboarding Period: Familiarize with project goals, existing documentation, and community workflows.High
June 2 - June 15Enhance Meta Documentation: Update and refine existing Meta pages related to MediaWiki documentation.Medium
June 16 - June 30Design Maintenance Structure: Develop a streamlined maintenance framework for Meta and MediaWiki.org documentation.Medium
July 1 - August 15Implement Maintenance Structure: Roll out the new maintenance structure, including workflows, version control, and access permissions.Medium
August 16 - October 30Create New MediaWiki Pages: Develop and publish new MediaWiki.org pages, aligning them with existing Meta content and addressing Wikimedia project usage.High

Budget

With a budget of $10,500, and a readiness to negotiate, I aim to optimize resources for maximum project impact and flexibility in adapting to evolving needs.

Event Timeline

Personal Information

Name : Radha Thakare
Email : thakareradha2001@gmail.com
Location : Maharashtra, India
Working Hours : IST (GMT+5:30)
Available Hours : 40 hours
Resume : Radha_Thakare_CV

I embarked on my tech journey a few years back, coinciding with my introduction to the world of open source. Since then, I've been eager to give back to the community through contributions. While diving into code contributions can be daunting due to the technical expertise required, I quickly realized that there are various avenues beyond coding to contribute to open source.
I've been actively involved in fostering open source communities and have made significant contributions, including participating in GSoC with AOSSIE and The Mifos Initiative. At Mifos, I not only contributed as a developer but also had the privilege of mentoring others.

Open Source Contribution

  1. Research Paper(Published by IEEE)
  2. Worked as Developer and Mentor in GSoC to the Organization name The Mifos Initiative.
  3. Worked on many API Documentation and User Guides - Github

Project

Complete migration of MediaWiki documentation

Abstract

MediaWiki, an open-source wiki software, empowers collaborative content creation for numerous websites, notably Wikipedia. With its simple wikitext markup language, users can seamlessly edit and organize content in real-time. This versatile platform boasts features such as version history tracking and granular user permissions, supported by a robust community of developers and contributors. While the migration of documentation from Meta-Wiki to MediaWiki.org aims to centralize resources, challenges arise from licensing restrictions and content overlap. Nevertheless, MediaWiki remains a powerful tool for knowledge sharing, driving continuous innovation and collaboration online.

Past contributors highlight the absence of a strategy for the task, emphasizing the need for a cohesive plan moving forward mentioned in T181380.

Deliverables

  1. Update existing Meta pages related to MediaWiki documentation, ensuring accuracy, relevance and remaining content.
  2. Develop new MediaWiki.org pages specifically addressing topics covered in Meta documentation related to MediaWiki usage for Wikimedia projects.
  3. Implement the new structure, ensuring alignment with best practices and community needs.

Having stated the above deliverables, here is my detailed approach to achieving them;

My Approach

1.Comparison and Integration:

  • Begin by conducting a comprehensive comparison between the MediaWiki documentation pages existing on Meta-Wiki and their corresponding pages on MediaWiki.org.
  • Identify any discrepancies or missing information on the MediaWiki.org pages that can be sourced from the Meta-Wiki documentation.
  • Integrate the missing information from Meta-Wiki into the relevant pages on MediaWiki.org, ensuring accuracy, consistency, and completeness of the documentation across both platforms.
  • This process calls for exacting attention to detail and can include revising text to comply with documentation requirements or licensing constraints.

2.Creation of New Pages:

  • For Meta-Wiki documentation pages listed under "No MediaWiki.org equivalent," initiate the creation of new pages on MediaWiki.org to cover the content present on the Meta-Wiki pages.
  • Develop these new pages in alignment with established documentation standards and guidelines, ensuring clarity, coherence, and accessibility of the information presented.
  • Include relevant examples, explanations, and usage instructions to provide users with comprehensive guidance on the topic covered by each page.
  • This step involves both content creation and formatting to ensure consistency with existing documentation on MediaWiki.org.

3.Review and Organization:

  • Conduct a thorough review of Meta-Wiki documentation pages listed under "Actually WMF-specific" to assess their usability and relevance.
  • Determine the most effective organizational structure to enhance the discoverability and maintenance of these pages, considering factors such as topic relevance, user needs, and ease of navigation.
  • Implement the chosen organizational structure, which may involve categorization, tagging, or restructuring of pages to streamline access and management of the content.
  • This step requires careful consideration of user requirements and feedback to optimize the organization of documentation across Meta-Wiki.

4.Documentation, Reporting, and Updated Structure for Maintenance:

  • I will work on documenting the entire migration process, detailing each step taken, challenges encountered, and solutions implemented along the way.
  • Provide clear and concise recommendations for ongoing maintenance and improvement of documentation on both Meta-Wiki and MediaWiki.org, based on insights gained during the migration project.
  • Compile a final report summarizing the outcomes and achievements of the project, including metrics such as the number of pages migrated, improvements made, and impact on user experience.
  • In addition to documentation and reporting, design a new structure for maintenance that facilitates efficient ongoing management and updates of the documentation on both Meta-Wiki and MediaWiki.org.
  • Consider factors such as content organization, version control, access permissions, and contributor workflows when designing the new maintenance structure.
  • Implement the new maintenance structure, ensuring that it aligns with established best practices and addresses the specific needs and challenges of MediaWiki documentation under guidance of mentors.
  • This step ensures the long-term sustainability and effectiveness of the documentation, enabling continued growth and improvement over time while streamlining maintenance processes for contributors.

Timeline

TimelineTaskPriority
May 20 - June 1Onboarding Period: Familiarize with project goals, existing documentation, and community workflows.High
June 2 - June 15Enhance Meta Documentation: Update and refine existing Meta pages related to MediaWiki documentation.Medium
June 16 - June 30Design Maintenance Structure: Develop a streamlined maintenance framework for Meta and MediaWiki.org documentation.Medium
July 1 - August 15Implement Maintenance Structure: Roll out the new maintenance structure, including workflows, version control, and access permissions.Medium
August 16 - October 30Create New MediaWiki Pages: Develop and publish new MediaWiki.org pages, aligning them with existing Meta content and addressing Wikimedia project usage.High

Budget

With a budget of $10,500, and a readiness to negotiate, I aim to optimize resources for maximum project impact and flexibility in adapting to evolving needs.

radhathakare renamed this task from Migrating MediaWiki Documentation to GSOD 2024 Proposal - Migrating MediaWiki Documentation.Sat, Apr 27, 7:58 PM
apaskulin moved this task from To review to Reviewed on the Google Season of Docs 2024 board.
apaskulin subscribed.

Hi @radhathakare, Thanks for your interest in Season of Docs! I like the detail you've put into your approach to the project. Can you move your proposal out of the comment and into the main task description? (Select "Edit task" on the right side of the page.) I'm going to go ahead and move your proposal into the Reviewed column. We'll let you know on May 10 if we've accepted your proposal.

Thanks a lot @apaskulin. I have moved proposal to description.

Hi @radhathakare, Unfortunately, we haven’t selected your proposal for this year’s Season of Docs. We had so many great applications; it was a tough decision. We hope you’ll consider applying next year. If you’re interested in contributing to Wikimedia documentation as a volunteer, check out Documentation/Contribute. If you’d like more specific feedback on your proposal, feel free to send me an email at apaskulin@wikimedia.org. Thanks again for your interest!