Docker compose instruction for adding LocalSettings.php could be clarified

Open Beginner friendly
#2,669 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
docker-compose
Domain
documentation

Research direction

Open docker-compose.yml and find the comments describing how to add LocalSettings.php. Clarify that uncommenting the volume requires running docker compose up --build, and that docker compose down is not needed. Done means the documented steps accurately describe applying the new volume.

Written by the indexing model from the issue text.

Description

The comments within docker-compose.yml contain the following:

# After initial setup, download LocalSettings.php to the same directory as
# this yaml and uncomment the following line and use compose to restart
# the mediawiki service

Simply restarting the service is insufficient. To add the new volume you need to use the following command:

docker compose up --build

It is not necessary to first do docker compose down.

Dominant language
Shell
Stars
5.3k
Forks
2.2k
Avg merge
1d 18h
Merged PRs (30d)
11

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from docker-library/docs

All issues in docker-library/docs

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.