Page MenuHomePhabricator

Review & improve bot documentation on meta & mediawiki
Open, LowPublic

Description

Bot documentation on English Wikipedia: https://en.wikipedia.org/wiki/Wikipedia:Bots has a nice flow to it. The sections are well-explained, it's "How to create a bot" section also points to a thorough guide and lists Pywikibot framework, but this document is specific to English Wikipedia (especially the policy and the approval process listed on it).

And, then we have https://meta.wikimedia.org/wiki/Bot and https://www.mediawiki.org/wiki/Manual:Bots which seem to be incomplete or lacking a structure. Probably, both the docs should be linked and have the same information. The intended audience for this doc should be all Wikimedia wikis, both bot users and developers, etc.

This task would require someone to review all the three tutorials and use the good pieces from English Wikipedia to improve the other two. For example, in the doc on meta-wiki, the "Frameworks and interfaces for bot development" section could be reviewed to ensure that all the frameworks listed are still used/useful. The section "Current and proposed bots" feels unnecessary and it is also missing the bot creation process.

Event Timeline

Hi all,
Regarding this : "The section "Current and proposed bots" feels unnecessary and it is also missing the bot creation process." May I know why this section ain't useful?
Thanks

Regarding this : "The section "Current and proposed bots" feels unnecessary and it is also missing the bot creation process." May I know why this section ain't useful?

@Hqrshguptq: Cannot speak for Srishti, but IMO: That section is incomplete; there are hundreds of bots and that page only lists five with unknown criteria. Furthermore the next section "Miscellaneous bot pages" (also vague and bad name) already has an item called "Lists of bots" (whether that is useful... well...).

IMO currently that entire meta page is a rather unhelpful link collection - when to go to which link and why (am I a developer? which links are relevant if I am not?).

@Hqrshguptq: Hi, how is this task going? Any problems, or is there anything we can help with? :)

Yea @Aklapper , will get into it in a day or two. Couldn't find time..

Hi, is this issue still open? I would like to contribute in it. Thanks!

I would like to contribute if the task is still open. Please reply. Thanks!

@Diwanshu885, @Shubham656jain: Hi and welcome. Please read the previous comments and check the "Assigned To" field. Please also see https://www.mediawiki.org/wiki/How_to_become_a_MediaWiki_hacker#Feedback,_questions_and_support - thanks!

Hi again, @Hqrshguptq are you working on this??? I would like to help

@Hqrshguptq: Hi! This task has been assigned to you a while ago. Could you maybe share an update? Do you still plan to work on this task, or do you need any help?

@Hqrshguptq: I am resetting the assignee of this task because there has not been progress lately (please correct me if I am wrong!). Resetting the assignee avoids the impression that somebody is already working on this task. It also allows others to potentially work towards fixing this task. Please claim this task again when you plan to work on it (via Add Action...Assign / Claim in the dropdown menu) - it would be welcome. Thanks for your understanding!