Page MenuHomePhabricator

Improve documentation for MediaWiki Docker environment
Closed, ResolvedPublic

Description

While updating https://www.mediawiki.org/wiki/Hackathons/Laptop_setup#Goal_%238%3A_Fetch_Mediawiki_codebase_and_setup_the_development_environment to add a reference to the Docker environment, it felt a bit awkward that our documentation is spread out in three locations: mw:Docker, mw:Docker/Recipes, and DEVELOPERS.md. I'd like to propose the following:

  • mw:Docker can stay as a general page that links to all the things
  • create mw:MediaWiki-Docker which is the landing page for the development environment. The intro basically points to DEVELOPERS.md.
  • Move the contents of mw:Docker/Recipes onto the new mw:MediaWiki-Docker page, so all the content is in one place.
  • update DEVELOPERS.md to reference mw:MediaWiki-Docker (instead of how it currently points to mw:Docker and mw:Docker/Recipes)

Event Timeline

Moving mw:Docker/Recipes to mw:MediaWiki-Docker seems fine, though I think we'll want to split it up soon enough as ways to use it grow.

Change 575743 had a related patch set uploaded (by Kosta Harlan; owner: Kosta Harlan):
[mediawiki/core@master] DEVELOPERS.md: Remove reference to Docker/Recipes

https://gerrit.wikimedia.org/r/575743

Change 575743 merged by jenkins-bot:
[mediawiki/core@master] DEVELOPERS.md: Remove reference to Docker/Recipes

https://gerrit.wikimedia.org/r/575743