Skip to content

Commit ff61a45

Browse files
cytopiacytopia
authored
Merge pull request #255 from devilbox/doc-fixes
Enhance documentation
2 parents 7cc5e25 + 7e77562 commit ff61a45

6 files changed

+69
-174
lines changed

‎doc/available-tools.md

-168
Original file line numberDiff line numberDiff line change
@@ -352,171 +352,3 @@ Additionally to all of the `slim` tools shown above, the following PHP cli tools
352352
[lnk_zsh]: ../php_tools/zsh
353353

354354
<!-- TOOLS_WORK_END -->
355-
356-
357-
### PHP Tools (`work`) - deprecated
358-
359-
> **Disclaimer:** It is currently not clear what tools are available in which PHP image (version-dependent). This documentation was done by hand and work has currently started to automate this and keep exact tools up-to-date for each of the provided PHP version.
360-
361-
<table>
362-
<thead>
363-
<tr>
364-
<th width="200">Tool</th>
365-
<th>Description</th>
366-
</tr>
367-
</thead>
368-
<tr>
369-
<td><a href="https://www.ansible.com/">Ansible</a></td>
370-
<td>Automation tool.</td>
371-
</tr>
372-
<tr>
373-
<td><a href="https://asgardcms.com/install">asgardcms</a></td>
374-
<td>AsgardCMS cli installer.</td>
375-
</tr>
376-
<tr>
377-
<td><a href="https://github.com/cytopia/awesome-ci">awesome-ci</a></td>
378-
<td>Various linting and source code analyzing tools.</td>
379-
</tr>
380-
<tr>
381-
<td><a href="https://codeception.com/">codeception</a></td>
382-
<td>Elegant and efficient testing for PHP.</td>
383-
</tr>
384-
<tr>
385-
<td><a href="https://getcomposer.org">composer</a></td>
386-
<td>Dependency Manager for PHP.</td>
387-
</tr>
388-
<tr>
389-
<td><a href="https://deployer.org/">deployer</a></td>
390-
<td>Deployment tool for PHP.</td>
391-
</tr>
392-
<tr>
393-
<td><a href="https://drupalconsole.com">drupal-console</a></td>
394-
<td>The Drupal CLI. A tool to generate boilerplate code, interact with and debug Drupal.</td>
395-
</tr>
396-
<tr>
397-
<td><a href="http://www.drush.org">drush</a></td>
398-
<td>Drush is a computer software shell-based application used to control, manipulate, and administer Drupal websites.</td>
399-
</tr>
400-
<tr>
401-
<td><a href="https://eslint.org">eslint</a></td>
402-
<td>The pluggable linting utility for JavaScript and JSX.</td>
403-
</tr>
404-
<tr>
405-
<td><a href="https://git-scm.com">git</a></td>
406-
<td>Git is a version control system for tracking changes in source files.</td>
407-
</tr>
408-
<tr>
409-
<td><a href="https://github.com/nvie/gitflow">git-flow</a></td>
410-
<td>Git-flow tools.</td>
411-
</tr>
412-
<tr>
413-
<td><a href="https://gulpjs.com/">gulp</a></td>
414-
<td>Gulp command line JS tool.</td>
415-
</tr>
416-
<tr>
417-
<td><a href="https://gruntjs.com/">grunt</a></td>
418-
<td>Grunt command line JS tool.</td>
419-
</tr>
420-
<tr>
421-
<td><a href="https://brew.sh/">Homebrew</a></td>
422-
<td>The Missing Package Manager for macOS (or Linux).</td>
423-
</tr>
424-
<tr>
425-
<td><a href="https://github.com/zaach/jsonlint">jsonlint</a></td>
426-
<td>Json command line linter.</td>
427-
</tr>
428-
<tr>
429-
<td><a href="https://stedolan.github.io/jq/">jq</a></td>
430-
<td>Command-line JSON processor.</td>
431-
</tr>
432-
<tr>
433-
<td><a href="https://github.com/laravel/installer">laravel installer</a></td>
434-
<td>A CLI tool to easily install and manage the laravel framework.</td>
435-
</tr>
436-
<tr>
437-
<td><a href="https://github.com/cytopia/linkcheck">linkcheck</a></td>
438-
<td>Search for URLs in files (optionally limited by extension) and validate their HTTP status code.</td>
439-
</tr>
440-
<tr>
441-
<td><a href="https://github.com/markdownlint/markdownlint">mdl</a></td>
442-
<td>Markdown command line linter.</td>
443-
</tr>
444-
<tr>
445-
<td><a href="https://github.com/ChrisWren/mdlint">mdlint</a></td>
446-
<td>Markdown command line linter.</td>
447-
</tr>
448-
<tr>
449-
<td><a href="https://mysqldump-secure.org">mysqldump-secure</a></td>
450-
<td>Secury MySQL database backup tool with encryption.</td>
451-
</tr>
452-
<tr>
453-
<td><a href="https://nodejs.org">nodejs</a></td>
454-
<td>Node.js is an open-source, cross-platform JavaScript run-time environment for executing JavaScript code server-side.</td>
455-
</tr>
456-
<tr>
457-
<td><a href="https://www.npmjs.com">npm</a></td>
458-
<td>npm is a package manager for the JavaScript programming language.</td>
459-
</tr>
460-
<tr>
461-
<td><a href="https://github.com/phalcon/phalcon-devtools">phalcon-devtools</a></td>
462-
<td>CLI tool to generate code helping to develop faster and easy applications that use with Phalcon framework.</td>
463-
</tr>
464-
<tr>
465-
<td><a href="https://github.com/squizlabs/PHP_CodeSniffer">phpcs</a></td>
466-
<td>PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.</td>
467-
</tr>
468-
<tr>
469-
<td><a href="https://github.com/squizlabs/PHP_CodeSniffer">phpcbf</a></td>
470-
<td>PHP Code Beautifier and Fixer.</td>
471-
</tr>
472-
<tr>
473-
<td><a href="https://github.com/FriendsOfPHP/PHP-CS-Fixer">php-cs-fixer</a></td>
474-
<td>A tool to automatically fix PHP Coding Standards issues.</td>
475-
</tr>
476-
<tr>
477-
<td><a href="https://phpmd.org">phpmd</a></td>
478-
<td>PHP Mess Detector.</td>
479-
</tr>
480-
<tr>
481-
<td><a href="https://photoncms.com/resources/installing">photon</a></td>
482-
<td>Photon CMS cli.</td>
483-
</tr>
484-
<tr>
485-
<td><a href="http://sass-lang.com/">sass</a></td>
486-
<td>Sass CSS compiler.</td>
487-
</tr>
488-
<tr>
489-
<td><a href="https://github.com/stylelint/stylelint">stylelint</a></td>
490-
<td>Sass/CSS command line linter.</td>
491-
</tr>
492-
<tr>
493-
<td><a href="https://www.openssh.com/">ssh</a></td>
494-
<td>OpenSSH command line client.</td>
495-
</tr>
496-
<tr>
497-
<td><a href="https://github.com/symfony/symfony-installer">symfony installer</a></td>
498-
<td>This is the official installer to start new projects based on the Symfony full-stack framework.</td>
499-
</tr>
500-
<tr>
501-
<td><a href="https://github.com/jonas/tig">tig</a></td>
502-
<td>Text-mode Interface for Git.</td>
503-
</tr>
504-
<tr>
505-
<td><a href="https://github.com/webpack/webpack">webpack</a></td>
506-
<td>A bundler for javascript and friends.</td>
507-
</tr>
508-
<tr>
509-
<td><a href="https://wp-cli.org">wp-cli</a></td>
510-
<td>WP-CLI is the command-line interface for WordPress.</td>
511-
</tr>
512-
<tr>
513-
<td><a href="https://github.com/adrienverge/yamllint">yamllint</a></td>
514-
<td>Yaml command line linter.</td>
515-
</tr>
516-
<tr>
517-
<td><a href="https://yarnpkg.com/en">yarn</a></td>
518-
<td>Fast, reliable and secure dependency management.</td>
519-
</tr>
520-
<tbody>
521-
</tbody>
522-
</table>

‎doc/base-images.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ Have a look at the following Devilbox base images for which no official versions
2121

2222
* [PHP-FPM 5.2](https://github.com/devilbox/docker-php-fpm-5.2)
2323
* [PHP-FPM 5.3](https://github.com/devilbox/docker-php-fpm-5.3)
24-
* [PHP-FPM 7.4](https://github.com/devilbox/docker-php-fpm-7.4)
24+
* [PHP-FPM 5.4](https://github.com/devilbox/docker-php-fpm-5.4)
25+
* [PHP-FPM 5.5](https://github.com/devilbox/docker-php-fpm-5.5)
2526
* [PHP-FPM 8.0](https://github.com/devilbox/docker-php-fpm-8.0)
2627
* [PHP-FPM 8.1](https://github.com/devilbox/docker-php-fpm-8.1)
2728
* [PHP-FPM 8.2](https://github.com/devilbox/docker-php-fpm-8.2)
29+
* [PHP-FPM 8.3](https://github.com/devilbox/docker-php-fpm-8.3)

‎doc/docker-env-variables.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Have a look at the following table to see all supported environment variables fo
3030
</thead>
3131
<tbody>
3232
<tr>
33-
<td rowspan="3"><strong>base</strong><br/><br/><strong>mods</strong><br/><br/><strong>prod</strong><br/><br/><strong>work</strong></td>
33+
<td rowspan="3"><strong>base</strong><br/><br/><strong>mods</strong><br/><br/><strong>prod</strong><br/><br/><strong>slim</strong><br/><br/><strong>work</strong></td>
3434
<td><code>DEBUG_ENTRYPOINT</code></td>
3535
<td>int</td>
3636
<td><code>0</code></td>
@@ -52,7 +52,7 @@ Have a look at the following table to see all supported environment variables fo
5252
<td colspan="5"></td>
5353
</tr>
5454
<tr>
55-
<td rowspan="6"><strong>prod</strong><br/><br/><strong>work</strong></td>
55+
<td rowspan="6"><strong>prod</strong><br/><br/><strong>slim</strong><br/><br/><strong>work</strong></td>
5656
<td><code>TIMEZONE</code></td>
5757
<td>string</td>
5858
<td><code>UTC</code></td>
@@ -92,7 +92,7 @@ Have a look at the following table to see all supported environment variables fo
9292
<td colspan="5"></td>
9393
</tr>
9494
<tr>
95-
<td rowspan="3"><strong>work</strong></td>
95+
<td rowspan="3"><strong>slim</strong><br/><br/><strong>work</strong></td>
9696
<td><code>MYSQL_BACKUP_USER</code></td>
9797
<td>string</td>
9898
<td><code>''</code></td>

‎doc/docker-tags.md

+57
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ This repository uses Docker tags to refer to different flavours and types of the
3838
<code>:X.Y-base</code><br/>
3939
<code>:X.Y-mods</code><br/>
4040
<code>:X.Y-prod</code><br/>
41+
<code>:X.Y-slim</code><br/>
4142
<code>:X.Y-work</code><br/>
4243
</td>
4344
<td>Stable<br/><sub>(rolling)</sub><br/><br/>These tags are produced by the master branch of this repository.</td>
@@ -48,6 +49,7 @@ This repository uses Docker tags to refer to different flavours and types of the
4849
<code>:X.Y-base-&lt;git-tag-name&gt;</code><br/>
4950
<code>:X.Y-mods-&lt;git-tag-name&gt;</code><br/>
5051
<code>:X.Y-prod-&lt;git-tag-name&gt;</code><br/>
52+
<code>:X.Y-slim-&lt;git-tag-name&gt;</code><br/>
5153
<code>:X.Y-work-&lt;git-tag-name&gt;</code><br/>
5254
</td>
5355
<td>Stable<br/><sub>(fixed)</sub><br/><br/>Every git tag will produce and preserve these Docker tags.</td>
@@ -58,6 +60,7 @@ This repository uses Docker tags to refer to different flavours and types of the
5860
<code>:X.Y-base-&lt;git-branch-name&gt;</code><br/>
5961
<code>:X.Y-mods-&lt;git-branch-name&gt;</code><br/>
6062
<code>:X.Y-prod-&lt;git-branch-name&gt;</code><br/>
63+
<code>:X.Y-slim-&lt;git-branch-name&gt;</code><br/>
6164
<code>:X.Y-work-&lt;git-branch-name&gt;</code><br/>
6265
</td>
6366
<td>Feature<br/><sub>(for testing)</sub><br/><br/>Tags produced by unmerged branches. Do not rely on them as they might come and go.</td>
@@ -242,6 +245,60 @@ The following table shows a more complete overview about the offered Docker imag
242245
<td><code>devilbox/php-fpm:8.2-prod-&lt;git-tag&gt;</code></td>
243246
</tr>
244247

248+
<tr>
249+
<td rowspan="13"><strong>slim</strong></td>
250+
<td><code>devilbox/php-fpm:5.2-slim</code></td>
251+
<td><code>devilbox/php-fpm:5.2-slim-&lt;git-tag&gt;</code></td>
252+
</tr>
253+
<tr>
254+
<td><code>devilbox/php-fpm:5.3-slim</code></td>
255+
<td><code>devilbox/php-fpm:5.3-slim-&lt;git-tag&gt;</code></td>
256+
</tr>
257+
<tr>
258+
<td><code>devilbox/php-fpm:5.4-slim</code></td>
259+
<td><code>devilbox/php-fpm:5.4-slim-&lt;git-tag&gt;</code></td>
260+
</tr>
261+
<tr>
262+
<td><code>devilbox/php-fpm:5.5-slim</code></td>
263+
<td><code>devilbox/php-fpm:5.5-slim-&lt;git-tag&gt;</code></td>
264+
</tr>
265+
<tr>
266+
<td><code>devilbox/php-fpm:5.6-slim</code></td>
267+
<td><code>devilbox/php-fpm:5.6-slim-&lt;git-tag&gt;</code></td>
268+
</tr>
269+
<tr>
270+
<td><code>devilbox/php-fpm:7.0-slim</code></td>
271+
<td><code>devilbox/php-fpm:7.0-slim-&lt;git-tag&gt;</code></td>
272+
</tr>
273+
<tr>
274+
<td><code>devilbox/php-fpm:7.1-slim</code></td>
275+
<td><code>devilbox/php-fpm:7.1-slim-&lt;git-tag&gt;</code></td>
276+
</tr>
277+
<tr>
278+
<td><code>devilbox/php-fpm:7.2-slim</code></td>
279+
<td><code>devilbox/php-fpm:7.2-slim-&lt;git-tag&gt;</code></td>
280+
</tr>
281+
<tr>
282+
<td><code>devilbox/php-fpm:7.3-slim</code></td>
283+
<td><code>devilbox/php-fpm:7.3-slim-&lt;git-tag&gt;</code></td>
284+
</tr>
285+
<tr>
286+
<td><code>devilbox/php-fpm:7.4-slim</code></td>
287+
<td><code>devilbox/php-fpm:7.4-slim-&lt;git-tag&gt;</code></td>
288+
</tr>
289+
<tr>
290+
<td><code>devilbox/php-fpm:8.0-slim</code></td>
291+
<td><code>devilbox/php-fpm:8.0-slim-&lt;git-tag&gt;</code></td>
292+
</tr>
293+
<tr>
294+
<td><code>devilbox/php-fpm:8.1-slim</code></td>
295+
<td><code>devilbox/php-fpm:8.1-slim-&lt;git-tag&gt;</code></td>
296+
</tr>
297+
<tr>
298+
<td><code>devilbox/php-fpm:8.2-slim</code></td>
299+
<td><code>devilbox/php-fpm:8.2-slim-&lt;git-tag&gt;</code></td>
300+
</tr>
301+
245302
<tr>
246303
<td rowspan="13"><strong>work</strong></td>
247304
<td><code>devilbox/php-fpm:5.2-work</code></td>

‎doc/docker-volumes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Have a look at the following table to see all offered volumes for each Docker im
2929
</thead>
3030
<tbody>
3131
<tr>
32-
<td rowspan="8"><strong>prod</strong><br/><br/><strong>work</strong></td>
32+
<td rowspan="8"><strong>prod</strong><br/><br/><strong>slim</strong><br/><br/><strong>work</strong></td>
3333
<td><code>/etc/php-custom.d</code></td>
3434
<td>Mount this directory into your host computer and add custom <code>\*.ini</code> files in order to alter php behaviour.</td>
3535
</tr>
@@ -65,7 +65,7 @@ Have a look at the following table to see all offered volumes for each Docker im
6565
<td colspan="3"></td>
6666
</tr>
6767
<tr>
68-
<td rowspan="3"><strong>work</strong></td>
68+
<td rowspan="3"><strong>slim</strong><br/><br/><strong>work</strong></td>
6969
<td><code>/etc/bashrc-devilbox.d</code></td>
7070
<td>Mount this directory into your host computer and add custom configuration files for <code>bash</code> and other tools.</td>
7171
</tr>

‎doc/flavours.md

+4
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,10 @@ Generic PHP-FPM image with fully loaded extensions. Use it to derive your own ph
2929

3030
Devilbox production image. This Docker image comes with many injectables, port-forwardings, mail-catch-all and user/group rewriting.
3131

32+
#### Image: slim
33+
34+
Devilbox intranet-ready image. Similar to `prod`, but contains least subset of required cli tools to make the Devilbox intranet work.
35+
3236
#### Image: work
3337

3438
Devilbox development image. Same as prod, but comes with lots of locally installed tools to make development inside the container as convenient as possible. See [Integrated Development Environment](../README.md#integrated-development-environment) for more information about this.

0 commit comments

Comments
 (0)