Wikimedia

Improve the documentation of ZppixBot (an IRC bot)

Document ZppixBot, which is an IRC bot.

You will have to create a Wikimedia developer (LDAP) account and request access to Toolforge

You can find the source code on GitHub (this is what you are documenting) but you have to use Wikimedia Gerrit for proposing your changes: In the project labs/tools/zppixbot, there is a file named documentation.php which welcomes your improvements.

You are done with this task when you have done one or more of the following:

  • Document the function of at least 5 commands. (How to issue the command, what it does, additional information for developers (function explanations))
  • Document how the bot operates. (Setup on toolforge, config vars)
  • Document how to properly operate the bot on toolforge. (Kubernetes process to start/stop/restart, document the file dir setup on toolforge)

Task tags

  • toolforge
  • html
  • irc
  • php
  • documentation

Students who completed this task

MacFan4000

Task type

  • code Code
  • chrome_reader_mode Documentation / Training
close

2017