Page MenuHomePhabricator
Create Task
Maniphest T288833

Improve documentation for pywikibot
Closed, DeclinedPublic
Actions

Description

pywikibot (particularly via PAWS, Toolforge, and CookieCutter) is a key product for developing Wikidata and Wikipedia curation tools.

Currently there is very little documentation, mostly created by volunteers for specific tasks. Most functionality has no documentation or tutorial beyond the source code comments.

This is intended as a tracking task for WMF Cloud Services team to deploy staff labour to write documentation and tutorials for pywikibot and Wikimedia's cookiecutter mod.

(This ticket was created following Wikimania-Hackathon-2021 discussion T287602.)

Related Objects

Event Timeline

deryckchan created this task.Aug 13 2021, 3:36 PM
Restricted Application edited projects, added cloud-services-team (Kanban); removed cloud-services-team. · View Herald TranscriptAug 13 2021, 3:36 PM
Restricted Application added a subscriber: Aklapper. · View Herald Transcript
Jane023 subscribed.Aug 13 2021, 3:37 PM
Premeditated subscribed.Aug 13 2021, 3:58 PM
deryckchan added a project: Pywikibot-Documentation.Aug 13 2021, 4:05 PM
Restricted Application added a subscriber: pywikibot-bugs-list. · View Herald TranscriptAug 13 2021, 4:05 PM
Maintenance_bot added a project: Pywikibot.Aug 13 2021, 4:45 PM
Aklapper moved this task from Backlog to Projects on the Wikimania-Hackathon-2021 board.Aug 18 2021, 10:14 AM
• nskaggs triaged this task as High priority.Aug 19 2021, 7:56 PM
• nskaggs moved this task from Inbox to Soon! on the cloud-services-team (Kanban) board.
• nskaggs added a project: Developer-Advocacy.
Holybiber subscribed.Aug 29 2021, 12:06 PM
Aklapper added a subscriber: • nskaggs.EditedJan 10 2022, 6:43 PM

@nskaggs: I know this task was created as an outcome of a conversation at the Wikimania Hackathon and I appreciate the intention.
However without actionable items or criteria when to call a task resolved, this task should be declined.
People are free to pick up specific tasks tagged with Pywikibot-Documentation. An additional disconnected epic task like this one won't help with that. :-/ We don't need more tasks which are merely tasks which state to please work on tasks, basically. :P
(This task reminded me of T101659: Run a documentation sprint for Cloud VPS and Toolforge and other tasks with similar intentions, and a good list of subtasks.)

Aklapper mentioned this in T293713: Review [[mw:Manual:Creating a bot]].Jan 10 2022, 6:44 PM
• nskaggs moved this task from Soon! to Graveyard on the cloud-services-team (Kanban) board.Jan 13 2022, 7:44 PM
Aklapper closed this task as Declined.Apr 15 2022, 11:02 PM

No comments; boldly declining.

Aklapper mentioned this in T308063: Pywikibot: Insufficient documentation.May 11 2022, 12:51 AM
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