Page MenuHomePhabricator

Improve documentation for pywikibot
Closed, DeclinedPublic

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.)

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript
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.

@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.)

No comments; boldly declining.