Skip to content

Commit c338024

Browse files
authored
Update dev-environment.md and docker-compose/README.md (#537)
* Update dev-environment.md Bug: T416479 * Update dev-environment.md * Revert "Update dev-environment.md" This reverts commit b036562. * update docker-compose/fake-api/README.md * Use "blob" URLs * Use "blob" URL in docker-compose/fake-api/README.md
1 parent aaa3185 commit c338024

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

docker-compose/fake-api/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
This is a fake platform API used during local docker-compose based development & also using some CI.
44

5-
The docker image simply serves PHP, and server.php is a very simple fake of the `getWikiForDomain` API responses.
5+
The docker image simply serves PHP, and [index.php](https://github.com/wbstack/mediawiki/blob/main/docker-compose/fake-api/index.php) is a very simple fake of the `getWikiForDomain` API responses.

docs/dev-environment.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## Development Environment
22

3-
There is a [docker-compose file](../docker-compose.yml) in the root directory that allows for serving multiple development sites locally.
3+
There is a [docker-compose file](https://github.com/wbstack/mediawiki/blob/main/docker-compose.yml) in the root directory that allows for serving multiple development sites locally.
44

5-
These are currently not using the real API but instead get their settings from the static JSON files included in the data folder.
5+
These are currently not using the real API but instead get their settings from static JSON files in [docker-compose/fake-api](https://github.com/wbstack/mediawiki/blob/main/docker-compose/fake-api).
66

7-
The fake API is served by the [server.php](test/server.php) script and reads the corresponding [subdomain](data/WikiInfo-site1.json) from each request.
7+
The fake API is served by [index.php](https://github.com/wbstack/mediawiki/blob/main/docker-compose/fake-api/index.php) and reads the JSON matching the requested subdomain (for example [WikiInfo-site1.json](https://github.com/wbstack/mediawiki/blob/main/docker-compose/fake-api/WikiInfo-site1.json)).
88

99
> [!NOTE]
1010
> You may find you have to refresh the page a few times before changes are reflected in Elasticsearch. Unlike [wmde/wbaas-deploy](https://github.com/wmde/wbaas-deploy/), this setup doesn't have a dedicated job runner. Jobs queued up, such as ones from CirrusSearch and WikibaseCirrusSearch, are completed as part of web requests (see [wbstack/src/Settings/LocalSettings.php#L147-L151](https://github.com/wbstack/mediawiki/blob/ebac07a4a4096d8fd973ebd43ebe342f34b87803/dist-persist/wbstack/src/Settings/LocalSettings.php#L147-L151)), so refreshing the page ensures that all jobs in the queue are run.

0 commit comments

Comments
 (0)