Wikimedia

Convert two plain text files in MediaWiki core in /doc to Markdown format (I)

Context

The /docs directory in MediaWiki core contains various documentation files in plain text (.txt) format. Since Doxygen doesn't index txt files, these docs aren't included in the generated documentation, making them difficult to access. Following the implementation of T232104, Doxygen now indexes files in Markdown format, allowing us to pull these docs into https://doc.wikimedia.org by converting them to Markdown. See the discussion in T111298.

To do

  • Your task is to convert two files, put your patch (changes) for review into Wikimedia Gerrit.
  • The files to convert are: docs/memcached.txt and docs/magicword.txt
  • If you have not done yet, set up your developer account to be able to propose code changes in Wikimedia Gerrit. Follow the Gerrit tutorial to check out (clone) the mediawiki/core repository
  • Convert two files in /docs from txt format to Doxygen-supported Markdown format, adjusting formatting where necessary
  • Also update the Doxygen mainpage to link to helpful resources
  • Follow the Gerrit tutorial to put your patch into Gerrit, where it will get reviewed. Also follow our commit message guidelines.

If you have general questions about this task, please ask them in the Wikimedia Phabricator task. To create an account in Phabricator, follow our Phabricator help.

Task tags

  • markdown
  • documentation
  • doxygen

Students who completed this task

Artur

Task type

  • code Code
  • chrome_reader_mode Documentation / Training
close

2019