Skip to content

Commit 9db2f78

Browse files
committed
Adjust documentation
1 parent e40b801 commit 9db2f78

File tree

8 files changed

+59
-11
lines changed

8 files changed

+59
-11
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
This repository will provide you fully functional PHP-FPM Docker images in different flavours,
2222
versions and packed with different types of integrated PHP modules. It also solves the problem of **[syncronizing file permissions](doc/syncronize-file-permissions.md)** of mounted volumes between the host and the container.
2323

24-
:information_source: For detauls see **[Documentation: Syncronize File Permissions](doc/syncronize-file-permissions.md)**
24+
:information_source: For details see **[Documentation: Syncronize File Permissions](doc/syncronize-file-permissions.md)**
2525

2626

2727
<h2><img id="docker-tags" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Docker Tags</h2>
@@ -190,7 +190,8 @@ cat doc/php_modules.md | grep href | sed 's|</a.*||g' | sed 's|.*">||g' | xargs
190190
[`zip`](php_modules/zip/)
191191
[`zlib`](php_modules/zlib/)
192192

193-
:information_source: For detauls see **[Documentation: PHP Modules](doc/php-modules.md)**
193+
:information_source: For details see **[Documentation: PHP Modules](doc/php-modules.md)**<br/>
194+
:information_source: For details see **[Contributor Documentation: PHP Modules](php_modules/README.md)**
194195

195196

196197

@@ -447,6 +448,8 @@ Docker images are built and tested every night by **[GitHub Actions](https://git
447448

448449
Contributors are welcome. Feel free to star and clone this repository and submit issues and pull-requests. Add examples and show what you have created with the provided images. If you see any errors or ways to improve this repository in any way, please do so.
449450

451+
:information_source: For details see **[Contributor Documentation: PHP Modules](php_modules/README.md)**
452+
450453

451454
<h2><img id="community" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Community</h2>
452455

doc/PHP-EXT-options.yml.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

doc/PHP-EXT-test.yml.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

doc/PHP-EXT-build.yml.md renamed to doc/contributor/PHP-EXT-build.yml.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
[PHP Mods: Overview](../../php_modules/README.md) |
2+
[PHP Mods: `options.yml`](PHP-EXT-options.yml.md) |
3+
PHP Mods: `build.yml` |
4+
[PHP Mods: `test.yml`](PHP-EXT-test.yml.md)
5+
6+
---
7+
8+
<h2><img name="Documentation" title="Documentation" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Contributor Documentation: PHP Modules</h2>
9+
10+
11+
112
# Extension definition: `build.yml`
213

314

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[PHP Mods: Overview](../../php_modules/README.md) |
2+
PHP Mods: `options.yml` |
3+
[PHP Mods: `build.yml`](PHP-EXT-build.yml.md) |
4+
[PHP Mods: `test.yml`](PHP-EXT-test.yml.md)
5+
6+
---
7+
8+
<h2><img name="Documentation" title="Documentation" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Contributor Documentation: PHP Modules</h2>
9+
10+
11+
12+
# Extension definition: `options.yml`
13+
14+
To be done
15+
16+
17+
For now have a look at the existing modules into the respective `options.yml` files as they are mostly the same.

doc/contributor/PHP-EXT-test.yml.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[PHP Mods: Overview](../../php_modules/README.md) |
2+
[PHP Mods: `options.yml`](PHP-EXT-options.yml.md) |
3+
[PHP Mods: `build.yml`](PHP-EXT-build.yml.md) |
4+
PHP Mods: `test.yml`
5+
6+
---
7+
8+
<h2><img name="Documentation" title="Documentation" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Contributor Documentation: PHP Modules</h2>
9+
10+
11+
12+
# Extension definition: `test.yml`
13+
14+
This is not yet implemented and thus no documentation exists.

doc/php-modules.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Extensions |
1414
<h2><img name="Documentation" title="Documentation" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Documentation</h2>
1515

1616

17+
:information_source: For details on how to add/edit modules see **[Contributor Documentation: PHP Modules](../php_modules/README.md)**
1718

1819
#### PHP Modules (`base`)
1920

php_modules/README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
PHP Mods: Overview |
2+
[PHP Mods: `options.yml`](../doc/contributor/PHP-EXT-options.yml.md) |
3+
[PHP Mods: `build.yml`](../doc/contributor/PHP-EXT-build.yml.md) |
4+
[PHP Mods: `test.yml`](../doc/contributor/PHP-EXT-test.yml.md)
5+
6+
---
7+
8+
<h2><img name="Documentation" title="Documentation" width="20" src="https://github.com/devilbox/artwork/raw/master/submissions_logo/cytopia/01/png/logo_64_trans.png"> Contributor Documentation: PHP Modules</h2>
9+
10+
11+
112
# PHP Module definitions
213

314
This document describes how to create new or alter existing PHP module definitions.

0 commit comments

Comments
 (0)