Page MenuHomePhabricator

Improve documentation for running local-charts and building docker images using the temporary Dockerfiles
Closed, ResolvedPublic

Description

It has come to our attention that the temporary Dockerfile description for mediawiki in local-charts may not work if the user has not already run composer in their mediawiki repository. If the standard mediawiki docker image (work in progress) is not yet complete, this should be fixed.

It was suggested to move the Dockerfile descriptions from the README to their own files. If that is done, the README should be updated with instructions for what to do with the Dockerfiles for each service.

It was also suggested to move instructions for "optional" services to their own section in the README.

Event Timeline

jeena triaged this task as Normal priority.Apr 11 2019, 10:07 PM
jeena created this task.

I am hesitant to create a separate section in the README for services used by Mediawiki core and frame them as second-class members of the environment.

I see the local charts environment as an environment for running any of our containerized services. While we've prioritized getting Mediawiki core running initially, I don't see it as the primary member of the environment. The environment is aimed at all developers, not just those who want to develop on Mediawiki core. I think running any number of services without running Mediawiki core itself should be just as valid a workflow as running Mediawiki core in this environment.

Change 504449 had a related patch set uploaded (by Jeena Huneidi; owner: Kosta Harlan):
[releng/local-charts@master] Fix suggested Dockerfile for MediaWiki core

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

Change 504449 merged by Brennen Bearnes:
[releng/local-charts@master] Fix suggested Dockerfile for MediaWiki core

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

brennen closed this task as Resolved.Jul 18 2019, 11:20 PM
brennen claimed this task.

Since we now have dev-images and Dockerfile contents don't live in the local-charts README, this should no longer be a problem.