Skip to content

Commit ab5264d

Browse files
committed
Update contributor docs
1 parent 7101c8c commit ab5264d

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

php_modules/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ All PHP modules/extensions (for all PHP versions and both for `amd64` and `arm64
1818

1919
## How to add PHP modules?
2020

21+
> **Note:** The below listed steps require you to have the following on your local machine installed: `python3`, `PyYAML` Python module, `docker` and `make`.
22+
2123
1. **Inside `php_modules/` directory:**
2224
1. Create a new directory with the name of the PHP module in `php_modules/`
2325
2. Add `build.yml`, `options.yml` and `test.yml` into your newly created directory
@@ -28,7 +30,7 @@ All PHP modules/extensions (for all PHP versions and both for `amd64` and `arm64
2830
2. Run `make gen-dockerfiles` to generate Dockerfiles via Ansible
2931
3. Run `make build STAGE=mods VERSION=8.1 ARCH=linux/amd64` to build the `mods` Docker image with version `8.1` for platform `linux/amd64`
3032

31-
**Note:** If you want to test if your new module builds correctly, you can generate Dockerfiles which only contain this one module and all others removed. This allows for much faster Docker builds and you don't have to wait for all other modules to be built. To do so, you generate group_vars for your one module only via:
33+
**Note:** If you want to test if your new module builds correctly, you can generate Dockerfiles which only contain this one module and all others removed. This allows for much faster Docker builds and you don't have to wait for all other modules to be built. To do so, generate only group_vars for your one module via:
3234

3335
```bash
3436
# Commands shown here are executed from root of this repository
@@ -42,14 +44,14 @@ make gen-dockerfiles
4244

4345
## Extension definition: `build.yml`
4446

45-
See **[PHP-EXT-build.yml.md](../doc/PHP-EXT-build.yml.md)** how to alter the `build.yml` file.
47+
See **[PHP-EXT-build.yml.md](../doc/contributor/PHP-EXT-build.yml.md)** how to alter the `build.yml` file.
4648

4749

4850
## Extension definition: `options.yml`
4951

50-
See **[PHP-EXT-options.yml.md](../doc/PHP-EXT-options.yml.md)** how to alter the `options.yml` file.
52+
See **[PHP-EXT-options.yml.md](../doc/contributor/PHP-EXT-options.yml.md)** how to alter the `options.yml` file.
5153

5254

5355
## Extension definition: `test.yml`
5456

55-
See **[PHP-EXT-test.yml.md](../doc/PHP-EXT-test.yml.md)** how to alter the `test.yml` file.
57+
See **[PHP-EXT-test.yml.md](../doc/contributor/PHP-EXT-test.yml.md)** how to alter the `test.yml` file.

0 commit comments

Comments
 (0)