Page MenuHomePhabricator
Create Task
Maniphest T362825

GSoD'24 Proposal - Consolidating and Organizing MediaWiki Documentation on MediaWiki.org
Open, Needs TriagePublic
Actions

Description

Profile Information

Name: Mahfuza Humayra Mohona
IRC nickname on Zulip: mhmohona
Resume | GIthub | LinkedIn
Location: Bangladesh (GMT +6)
Availability: 20-25 hours per week

References and Inspiration:

This proposal draws inspiration and serves as a reference from the following sources:

Introduction

The MediaWiki documentation hosted across Meta-Wiki and MediaWiki.org has become fragmented and difficult to navigate for both users and contributors. While MediaWiki.org was established as the central repository for MediaWiki documentation, there are still numerous pages on Meta-Wiki that contain relevant MediaWiki information. This duplication creates challenges in maintaining consistent and up-to-date documentation.

The goal of this project is to consolidate MediaWiki's help documentation by identifying duplicate content between MediaWiki.org and Meta-Wiki, and migrating relevant content from Meta-Wiki to MediaWiki.org. This involves auditing each Meta page to find its MediaWiki.org equivalent, identifying any information that needs to be added to the MediaWiki.org page, and any information that is specific to Wikimedia and needs to stay on Meta. The primary goal is to improve the accessibility and usability of MediaWiki's documentation for both new and existing users.

Deliverables

  • Audit Report: A comprehensive report detailing the audit of each Meta page, including its MediaWiki.org equivalent, any additional information that needs to be added to MediaWiki.org, and any information that is specific to Wikimedia and needs to stay on Meta.
  • Migrated Content: Content migrated from Meta-Wiki to MediaWiki.org, ensuring that MediaWiki.org has a comprehensive and up-to-date documentation base, correctly connected pages and all the links.
  • Feedback and Revision Documentation: Documentation of the feedback received during the project, including any revisions made to the migrated content based on this feedback.
  • Finalized Documentation: The finalized version of the documentation on MediaWiki.org, reflecting all migrated content and any necessary adjustments based on feedback.

Stretch Goal

Develop a sustainable process for maintaining and updating the consolidated MediaWiki documentation on MediaWiki.org, ensuring that the information remains current and accessible.

Mentors

Alex Paskulin

Participation

Communication Medium: Zullip
Communication Frequency: Attending Community meeting, 1:1 call with mentors

Project Details

This project is going to have 3 phases -

  • Phase 1: De-duplication
  • Phase 2: New content
  • Phase 3: Organize
Phase 1: Addressing Pages with MediaWiki.org Equivalents
  1. Comprehensive Review of Pages:
    • Review each page listed under the "Has MediaWiki.org equivalent" section on the "Project:MediaWiki_documentation_on_Meta-Wiki/List" page.
    • For each page, identify the corresponding MediaWiki.org page that serves as the equivalent.
  1. Content Comparison and Migration:
    • Conduct a detailed comparison of the content between the Meta-Wiki page and the MediaWiki.org equivalent page.
    • Identify any information on the Meta-Wiki page that is missing from or needs to be added to the MediaWiki.org page.
    • Migrate the relevant content from the Meta-Wiki page to the MediaWiki.org page, ensuring the information is accurate and up-to-date.
  1. Licensing Considerations:
    • Verify that the content being migrated from Meta-Wiki to MediaWiki.org is properly licensed under the MIT license, as required by MediaWiki.org.
    • If necessary, work with the Wikimedia community to relicense the content from the CC-BY-SA license used on Meta-Wiki.
  1. Redirects and Cross-linking:
    • Set up appropriate redirects from the Meta-Wiki page to the corresponding MediaWiki.org page.
    • Ensure there are clear cross-links between the two pages to maintain the seamless flow of information for users.
  1. Community Feedback and Validation:
    • Engage with the Wikimedia community to gather feedback on the proposed content migrations and changes.
    • Incorporate the community's suggestions and validate the changes to ensure they meet the users' needs.
  1. Documentation Maintenance:
    • Establish a sustainable process for the ongoing maintenance and update of the consolidated MediaWiki documentation on MediaWiki.org.
    • Identify and train a team of contributors responsible for maintaining the documentation in the long term.
Phase 2: Addressing Pages with No MediaWiki.org Equivalents
  1. Create MediaWiki.org Pages:
    • For each page listed under Project:MediaWiki_documentation_on_Meta-Wiki/List#No_MediaWiki.org_equivalent, create a corresponding MediaWiki.org page that covers the content on the Meta page.
  1. Review and Group Pages:
    • Review the newly created pages and group them into subject areas for better organization and navigation.
  1. Audit Pages in Subject Areas:
    • Audit pages in each subject area and identify:
      • Any information that needs to be added to MediaWiki.org.
      • Where the information should be added in the context of the related MediaWiki.org documentation.
      • Any information that is specific to Wikimedia and needs to stay on Meta.
  1. Transferral of Images:
    • Images located on Wikimedia Commons do not need any changes and can be used directly in MediaWiki.org pages.
    • Images on Meta that are used solely within pages that will be exported can be transferred to MediaWiki.org. In this case, tag them appropriately.
    • Images that are used in pages to be transferred but also in other pages on Meta should be moved to Commons, as well as other images allowed by Commons' guidelines.
  1. Licensing Considerations:
    • Most content on MediaWiki.org is licensed under the GFDL, allowing direct movement of content from Meta to MediaWiki.org. However, be cautious with the 'PD Help' project, as the licenses are not compatible.
    • When transferring pages, ensure to follow the protocol outlined in Meta:MetaProject_to_transfer_content_to_MediaWiki.org/si, including not moving any page that has not been displaying the 'MoveToMediaWiki' template for at least 2 weeks and not moving pages into the Help: namespace due to license incompatibility.
  1. Write Content and Get Feedback:
    • Write the necessary content for each new page on MediaWiki.org, ensuring it is original and not copied from Meta without proper consideration of copyright and licensing issues.
    • Seek feedback from the community on the new content. This could involve posting drafts on the MediaWiki.org talk pages or seeking input from other contributors.
  1. Publish:
    • Once the content has been reviewed and approved, publish the updates on MediaWiki.org.

Phase 3: Organizing Wikimedia-Specific Content

  1. Review Wikimedia-Specific Content on Meta
    • Review the content on Meta, including the content in the "Project:MediaWiki documentation on Meta-Wiki/List#Actually WMF-specific" category identified during Phases 1 and 2
    • Carefully examine this Wikimedia-specific content to understand its purpose and relevance
  1. Design an Information Architecture
    • Based on the review, design an information architecture for the Wikimedia-specific content on Meta
    • Organize the content into logical, user-friendly categories and subcategories
    • Ensure the structure makes it easy for users to navigate and discover the information they need
  1. Get Feedback
    • Share the proposed information architecture with the Wikimedia community and gather feedback
    • Incorporate the community's suggestions to refine the design and ensure it meets their needs
  1. Implement Changes to meta:Help
    • For the pages listed under "Project:MediaWiki documentation on Meta-Wiki/List#Actually WMF-specific":
      • Review the pages for usability and identify areas for improvement
      • Design and implement an organization structure to make these pages easy to discover and maintain
    • Publish the updated meta:Help pages with the new organizational structure
  1. Ongoing Maintenance
    • Establish a process for regularly reviewing and updating the Wikimedia-specific content on Meta
    • Identify a team of contributors responsible for maintaining the content and information architecture over time
    • Monitor user feedback and adjust the organization as needed to ensure the content remains accessible and relevant

Tentative timeline

Project kickoff and onboarding (May 20 - June 1)

  • Analyze the project in detail with mentor and finalize the project scope.
  • Discuss about:
    • How often the tasks should be reviewed.
    • Share schedules and decide on a weekly/daily workflow.
    • Bi-weekly and daily project reports.
    • Create the required tasks and subtasks on Phabricator.

Week 1 (June 2 - June 8)

  1. Comprehensive Review of Pages:
    • Review the 20 pages listed under the "Has MediaWiki.org equivalent" section on the "Project:MediaWiki_documentation_on_Meta-Wiki/List" page.
    • Identify the corresponding MediaWiki.org page that serves as the equivalent for each page.
  1. Licensing Considerations:
    • Verify that the content being migrated from all 20 Meta-Wiki pages is properly licensed under the MIT license, as required by MediaWiki.org.
    • Identify any content that needs to be relicensed from the CC-BY-SA license used on Meta-Wiki.
  1. Community Engagement:
    • Inform the Wikimedia community about the project and gather initial feedback.
    • Address any concerns or questions raised by the community.

Week 2 (June 9 - June 15)

  1. Licensing Considerations (continued):
    • Work with the Wikimedia community to relicense any content that needs to be relicensed from CC-BY-SA to MIT.
  1. Content Comparison and Migration:
    • Conduct a detailed comparison of the content between the first 4-5 Meta-Wiki pages and their MediaWiki.org equivalents.
    • Identify and migrate any relevant information from the Meta-Wiki pages to the MediaWiki.org pages, ensuring accuracy and up-to-dateness.
  1. Feedback Review and Incorporation:
    • Review and incorporate community feedback related to the project and the initial set of pages.

Week 3 (June 16 - June 22)

  1. Content Comparison and Migration (continued):
    • Conduct a detailed comparison of the content between the next 4-5 Meta-Wiki pages and their MediaWiki.org equivalents.
    • Identify and migrate any relevant information from the Meta-Wiki pages to the MediaWiki.org pages, ensuring accuracy and up-to-dateness.
  1. Redirects and Cross-linking:
    • Set up appropriate redirects from the Meta-Wiki pages to the corresponding MediaWiki.org pages for the completed set of pages.
    • Ensure there are clear cross-links between the two pages to maintain the seamless flow of information for users.
    • Gather community feedback on the proposed redirects and cross-links.
  1. Feedback Review and Incorporation:
    • Review and incorporate community feedback related to the content migration and redirects/cross-links for the completed set of pages.

Week 4 (June 23 - June 29)

  1. Content Comparison and Migration (continued):
    • Conduct a detailed comparison of the content between the remaining Meta-Wiki pages and their MediaWiki.org equivalents.
    • Identify and migrate any relevant information from the Meta-Wiki pages to the MediaWiki.org pages, ensuring accuracy and up-to-dateness.
  1. Testing and Quality Assurance:
    • Thoroughly review the migrated content, redirects, and cross-links for all 20 pages.
    • Involve the project team and select community members to ensure the migrated documentation meets the required standards and user expectations.
  1. Address Backlog and Blockers:
    • Address any remaining tasks, feedback, or blockers related to the content migration for the 20 pages.
  1. Documentation Maintenance:
    • Establish a sustainable process for the ongoing maintenance and update of the consolidated MediaWiki documentation on MediaWiki.org.
    • Identify and train a team of contributors responsible for maintaining the documentation in the long term.
  1. Buffer Time:
    • Allocate buffer time to accommodate any unforeseen delays or additional tasks that may arise during the project.

Week 5 (June 30 - July 6)

  1. Create MediaWiki.org Pages:
    • For each page listed under Project:MediaWiki_documentation_on_Meta-Wiki/List#No_MediaWiki.org_equivalent, create a corresponding MediaWiki.org page.
    • These new pages should cover the content from the Meta pages.
  1. Review and Group Pages:
    • Review the newly created MediaWiki.org pages.
    • Group them into subject areas for better organization and navigation.

Week 6 (July 7 - July 13)

  1. Audit Pages in Subject Areas:
    • Audit pages in each subject area and identify:
      • Any information that needs to be added to MediaWiki.org.
      • Where the information should be added in the context of the related MediaWiki.org documentation.
      • Any information that is specific to Wikimedia and needs to stay on Meta.
  1. Feedback Review and Incorporation:
    • Review and incorporate community feedback related to the newly created MediaWiki.org pages and subject area grouping.

Week 7 (July 14 - July 20)

  1. Transferral of Images:
    • Identify images located on Wikimedia Commons that can be used directly in the new MediaWiki.org pages.
    • Identify images on Meta that are used solely within pages being exported and tag them appropriately for transfer to MediaWiki.org.
    • Move images that are used in pages being transferred but also in other Meta pages to Wikimedia Commons, following the guidelines.
  1. Licensing Considerations:
    • Ensure that the content being transferred from Meta to MediaWiki.org is properly licensed under the GFDL.
    • Be cautious with the 'PD Help' project, as the licenses are not compatible.
    • Follow the protocol outlined in Meta:MetaProject_to_transfer_content_to_MediaWiki.org/si, including not moving any page that has not been displaying the 'MoveToMediaWiki' template for at least 2 weeks and not moving pages into the Help: namespace due to license incompatibility.

Week 8 (July 21 - July 27)

  1. Write Content and Get Feedback:
    • Write the necessary content for each new page on MediaWiki.org, ensuring it is original and not copied from Meta without proper consideration of copyright and licensing issues.
    • Seek feedback from the community on the new content by posting drafts on the MediaWiki.org talk pages or seeking input from other contributors.
  1. Feedback Review and Incorporation:
    • Review and incorporate community feedback related to the new content written for the MediaWiki.org pages.

Week 9 (July 28 - August 3)

  1. Write Content and Get Feedback (continued):
    • Continue writing and seeking feedback on the remaining new content for the MediaWiki.org pages.
  1. Feedback Review and Incorporation (continued):
    • Review and incorporate community feedback related to the remaining new content.

Week 10 (August 4 - August 10)

  1. Publish:
    • Once the content has been reviewed and approved, publish the updates on MediaWiki.org.
  1. Testing and Quality Assurance:
    • Thoroughly review the published content, including links, formatting, and overall quality.
    • Involve the project team and select community members to ensure the documentation meets the required standards and user expectations.

Week 11 (August 11 - August 17)

  1. Address Backlog and Blockers:
    • Address any remaining tasks, feedback, or blockers related to the content migration for the pages with no MediaWiki.org equivalents.
  1. Buffer Time:
    • Allocate buffer time to accommodate any unforeseen delays or additional tasks that may arise during the project.

Week 12 (August 18 - August 24)

  1. Documentation Maintenance:
    • Establish a sustainable process for the ongoing maintenance and update of the newly added MediaWiki documentation.
    • Identify and train a team of contributors responsible for maintaining the documentation in the long term.

Week 13 (August 25 - August 31)

  1. Buffer Week:
    • Allocate this week as a buffer to address any remaining tasks or issues that may arise during the project.

Week 14 (September 1 - September 7)

  1. Review Wikimedia-Specific Content on Meta:
    • Review the content on Meta, including the content in the "Project:MediaWiki documentation on Meta-Wiki/List#Actually WMF-specific" category identified during Phases 1 and 2.
    • Carefully examine this Wikimedia-specific content to understand its purpose and relevance.
  1. Design an Information Architecture:
    • Based on the review, design an information architecture for the Wikimedia-specific content on Meta.
    • Organize the content into logical, user-friendly categories and subcategories.
    • Ensure the structure makes it easy for users to navigate and discover the information they need.

Week 15 (September 8 - September 14)

  1. Get Feedback:
    • Share the proposed information architecture with the Wikimedia community and gather feedback.
    • Incorporate the community's suggestions to refine the design and ensure it meets their needs.
  1. Implement Changes to meta:Help:
    • For the pages listed under "Project:MediaWiki documentation on Meta-Wiki/List#Actually WMF-specific":
      • Review the pages for usability and identify areas for improvement.
      • Design and implement an organization structure to make these pages easy to discover and maintain.

Week 16 (September 15 - September 21)

  1. Implement Changes to meta:Help (continued):
    • Continue implementing the organization structure for the meta:Help pages.
  1. Feedback Review and Incorporation:
    • Review and incorporate community feedback related to the proposed changes to meta:Help.

Week 17 (September 22 - September 28)

  1. Publish Updated meta:Help Pages:
    • Once the changes have been reviewed and approved, publish the updated meta:Help pages with the new organizational structure.
  1. Testing and Quality Assurance:
    • Thoroughly review the published changes to meta:Help, including navigation, links, and overall user experience.
    • Involve the project team and select community members to ensure the changes meet the required standards and user expectations.
  1. Ongoing Maintenance:
    • Establish a process for regularly reviewing and updating the Wikimedia-specific content on Meta.
    • Identify a team of contributors responsible for maintaining the content and information architecture over time.

Week 18 (September 29 - October 5)

  1. Ongoing Maintenance (continued):
    • Continue setting up the ongoing maintenance process for the Wikimedia-specific content on Meta.
  1. Monitor User Feedback:
    • Monitor user feedback on the updated meta:Help pages and the new organizational structure.
    • Adjust the organization as needed to ensure the content remains accessible and relevant.
  1. Address Backlog and Blockers:
    • Address any remaining tasks, feedback, or blockers related to the organization of Wikimedia-specific content on Meta.
  1. Buffer Time:
    • Allocate buffer time to accommodate any unforeseen delays or additional tasks that may arise during the project.

Week 19 - 21 (October 6 - October 26)

  1. Identify Cleanup Tasks:
    • Conduct a thorough review of the project to identify any remaining cleanup tasks that need to be completed.
    • Examples of cleanup tasks may include:
      • Resolving any outstanding issues or bugs
      • Updating documentation or guides
      • Addressing any remaining feedback or concerns from the community
  1. Identify Follow-up Work:
    • Identify any follow-up work that may be required after the completion of the project.
    • Examples of follow-up work may include:
      • Ongoing maintenance and updates to the documentation
      • Future enhancements or improvements to the documentation
  1. Prioritize and Plan Follow-up Work:
    • Prioritize the identified follow-up work based on its importance and urgency.
    • Develop a plan or schedule for addressing the follow-up work in the future.
  1. Write Project Report:
    • Write a comprehensive project report describing the outcomes, learning, best practices, and recommendations for future projects.
    • The report will cover the following areas:
      • Project overview and objectives
      • Key milestones and achievements
      • Challenges faced and how they were addressed
      • Lessons learned and best practices
      • Recommendations for future projects or improvements
      • Next steps and follow-up work
  1. Review and Finalize Project Report:
    • Review the project report with the project team and other stakeholders.
    • Incorporate any feedback or additional input.
    • Finalize the report and distribute it to relevant parties.

Past Experience

Writing Portfolio - github/mhmohona/writing-portfolio

Google Season of Doc -2023
AsyncAPI Initiative

Documentation

Killercoda Tutorial

WasmEdge Runtime
Season Of KDE - 2024
Labplot Documentation

Newly Created pages

Event Timeline

Mhmohona created this task.Wed, Apr 17, 8:29 PM
Mhmohona updated the task description. (Show Details)Wed, Apr 17, 8:42 PM
apaskulin moved this task from To review to Reviewed on the Google Season of Docs 2024 board.Thu, Apr 18, 4:33 PM

Hi @Mhmohona, Thanks for your interest in Season of Docs! I really like the detail you put into your proposal, especially in the schedule. I also appreciate that you added a stretch goal to develop a maintenance process. I'm going to move your proposal into the Reviewed column. We'll let you know on May 10 if we've selected your proposal.

Mhmohona updated the task description. (Show Details)Fri, Apr 19, 6:19 PM
Mhmohona added a subscriber: Maryann-Onyinye.
Mhmohona added a comment.Fri, Apr 19, 6:48 PM

Thank you so much for reviewing my proposal and for your kind feedback @apaskulin!

I have added one section - References and Inspiration section at the top of the proposal.

I was also wondering if you could spare a moment to review the spreadsheet which I want to use to track audit report. I would greatly appreciate any feedback or suggestions you may have to improve it further.

Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL