Page MenuHomePhabricator

[Documentation] Write user docs for Page Collection Report
Closed, ResolvedPublic

Description

This task involves creating on-wiki documentation for the Page Collection Report tool.

Steps:

Explore the tool: Click the "Go to Tool" button on its Toolhub page.

Note: Please use this wiki-text template: https://www.mediawiki.org/wiki/Documentation/Tool_doc_template

Create on-wiki docs:

  • In your user space, create a new subpage (for example https://meta.wikimedia.org/wiki/User:{YOUR USERNAME}/New_page
  • Write clear user guides (e.g., installation, troubleshooting).
  • Get feedback from another hackathon participant - have them review your documents and provide suggestions.
  • Reach out to the maintainer of the tool to tell them about your documentation and suggest publishing it with the tool. You need to work with the tool maintainer to decide where they want to publish the documentation.

Skills Required: Technical writing, MediaWiki editing, Toolhub navigation.

Details

Due Date
Mar 29 2025, 11:00 PM

Event Timeline

This tool is deprecated: see the warning on Toolhub that says it shouldn't be used https://toolhub.wikimedia.org/tools/toolforge-created-articles-mapper
I think this group should pick a different tool to work on documenting!

Yeah, I am suggesting they go through the list of tools on the spreadsheet to pick up a tool once they are done they should let me know. so that we change the task for them to work on.

So we will change the name of this current tool to the new tool they are supposed to work on.

TBurmeister renamed this task from [Documentation] Write user docs for Created Articles Mapper to [Documentation] Write user docs for Page Collection Report .Mar 29 2025, 1:57 PM
TBurmeister updated the task description. (Show Details)
KingChristLike changed the task status from Open to In Progress.Mar 30 2025, 6:35 AM
Toontak92 set Due Date to Mar 29 2025, 11:00 PM.Mar 30 2025, 3:49 PM

Great job during the Hackathon, everyone! If you want to keep learning and keep contributing to technical documentation, here are instructions: https://www.mediawiki.org/wiki/Documentation/Contribute.
If you want to reach out to the maintainers of the tool you documented, to talk to them about where to add what you wrote in "official" documentation for the Page Collection Report tool, I suggest you should:

I also added @santhosh as a subscriber to this task.

Thanks again for your amazing work this weekend.