diff --git a/docs/_includes/all.rst b/docs/_includes/all.rst index 763ca4d9..55605e6e 100644 --- a/docs/_includes/all.rst +++ b/docs/_includes/all.rst @@ -22,5 +22,9 @@ ============================================================ .. include:: /_includes/links/docker.rst +.. include:: /_includes/links/docker-compose.rst +.. include:: /_includes/links/examples.rst +.. include:: /_includes/links/git.rst .. include:: /_includes/links/ssh.rst +.. include:: /_includes/links/tools.rst .. include:: /_includes/links/uid.rst diff --git a/docs/_includes/links/docker-compose.rst b/docs/_includes/links/docker-compose.rst new file mode 100644 index 00000000..91f7dc4b --- /dev/null +++ b/docs/_includes/links/docker-compose.rst @@ -0,0 +1,69 @@ +.. + ============================================================ + Commands + ============================================================ + +.. |ext_lnk_docker_compose_cmd_reference| raw:: html + + + Compose command-line reference overview + + +.. |ext_lnk_docker_compose_cmd_overview| raw:: html + + + overview + + +.. |ext_lnk_docker_compose_cmd_up| raw:: html + + + up + + +.. |ext_lnk_docker_compose_cmd_stop| raw:: html + + + stop + + +.. |ext_lnk_docker_compose_cmd_kill| raw:: html + + + kill + + +.. |ext_lnk_docker_compose_cmd_logs| raw:: html + + + logs + + +.. |ext_lnk_docker_compose_cmd_rm| raw:: html + + + rm + + +.. |ext_lnk_docker_compose_cmd_pull| raw:: html + + + pull + + +.. + ============================================================ + Install guides + ============================================================ + +.. |ext_lnk_docker_compose_install| raw:: html + + + Install Docker Compose + + +.. |ext_lnk_docker_compose_env_file| raw:: html + + + Declare default environment variables in file + diff --git a/docs/_includes/links/docker.rst b/docs/_includes/links/docker.rst index defe4a73..d84b7ebd 100644 --- a/docs/_includes/links/docker.rst +++ b/docs/_includes/links/docker.rst @@ -71,7 +71,7 @@ .. |ext_lnk_install_docker_toolbox_mac| raw:: html - Install Docker Toolbox on macOS + Install Docker Toolbox on MacOS .. |ext_lnk_install_docker_toolbox_mac_native_vs_toolbox| raw:: html @@ -115,27 +115,3 @@ Docker Toolbox on Windows: add shared directories - - -.. - ============================================================ - Docker Compose - ============================================================ - -.. |ext_lnk_install_docker_compose| raw:: html - - - Install Docker Compose - - -.. |ext_lnk_docker_cmpose_cmd_reference| raw:: html - - - Compose command-line reference - - -.. |ext_lnk_docker_cmpose_env_file| raw:: html - - - Declare default environment variables in file - diff --git a/docs/_includes/links/git.rst b/docs/_includes/links/git.rst new file mode 100644 index 00000000..0025fd79 --- /dev/null +++ b/docs/_includes/links/git.rst @@ -0,0 +1,5 @@ +.. |ext_lnk_download_git_win| raw:: html + + + Download Git for Windows + diff --git a/docs/_includes/links/tools.rst b/docs/_includes/links/tools.rst new file mode 100644 index 00000000..2bd66f6b --- /dev/null +++ b/docs/_includes/links/tools.rst @@ -0,0 +1,208 @@ +.. + ============================================================ + Command line tools + ============================================================ + +.. |ext_lnk_tool_awesome_ci| raw:: html + + + awesome-ci + + +.. |ext_lnk_tool_linuxbrew| raw:: html + + + Linux brew + + +.. |ext_lnk_tool_composer| raw:: html + + + Composer + + +.. |ext_lnk_tool_drush| raw:: html + + + Drush + + +.. |ext_lnk_tool_drupal_console| raw:: html + + + Drupal Console + + +.. |ext_lnk_tool_eslint| raw:: html + + + ESLint + + +.. |ext_lnk_tool_git| raw:: html + + + Git + + +.. |ext_lnk_tool_git_flow| raw:: html + + + Git flow + + +.. |ext_lnk_tool_gulp| raw:: html + + + Gulp + + +.. |ext_lnk_tool_grunt| raw:: html + + + Grunt + + +.. |ext_lnk_tool_jsonlint| raw:: html + + + JSON lint + + +.. |ext_lnk_tool_laravel| raw:: html + + + Laravel installer + + +.. |ext_lnk_tool_mdl| raw:: html + + + Markdown lint + + +.. |ext_lnk_tool_mdlint| raw:: html + + + MD linter + + +.. |ext_lnk_tool_mysqldump_secure| raw:: html + + + mysqldump-secure + + +.. |ext_lnk_tool_node| raw:: html + + + Node + + +.. |ext_lnk_tool_npm| raw:: html + + + Node + + +.. |ext_lnk_tool_phalcon| raw:: html + + + Phalcon DevTools + + +.. |ext_lnk_tool_phpcs| raw:: html + + + PHP CodeSniffer + + +.. |ext_lnk_tool_phpcbf| raw:: html + + + PHP Code Beautifier and Fixer + + +.. |ext_lnk_tool_photon| raw:: html + + + Photon CMS cli + + +.. |ext_lnk_tool_sass| raw:: html + + + Sass + + +.. |ext_lnk_tool_scss_lint| raw:: html + + + SCSS Lint + + +.. |ext_lnk_tool_ssh| raw:: html + + + OpenSSH + + +.. |ext_lnk_tool_symfony| raw:: html + + + Symfony installer + + +.. |ext_lnk_tool_tig| raw:: html + + + Text-mode Interface for Git + + +.. |ext_lnk_tool_webpack| raw:: html + + + Webpack + + +.. |ext_lnk_tool_wp| raw:: html + + + Wordpress CLI + + +.. |ext_lnk_tool_yamllint| raw:: html + + + Yamllint + + +.. |ext_lnk_tool_yarn| raw:: html + + + Yarn + + + +.. + ============================================================ + Web tools + ============================================================ + +.. |ext_lnk_tool_phpmyadmin| raw:: html + + + phpMyAdmin + + +.. |ext_lnk_tool_adminer| raw:: html + + + Adminer + + +.. |ext_lnk_tool_opcachegui| raw:: html + + + OpcacheGui + diff --git a/docs/getting-started/create-your-first-project.rst b/docs/getting-started/create-your-first-project.rst index f197d069..2cd74a32 100644 --- a/docs/getting-started/create-your-first-project.rst +++ b/docs/getting-started/create-your-first-project.rst @@ -201,6 +201,7 @@ their articles: * :ref:`example_setup_laravel` * :ref:`example_setup_phalcon` * :ref:`example_setup_photon_cms` + * :ref:`example_setup_shopware` * :ref:`example_setup_symfony` * :ref:`example_setup_typo3` * :ref:`example_setup_wordpress` diff --git a/docs/getting-started/devilbox-intranet.rst b/docs/getting-started/devilbox-intranet.rst index da52c020..64d4e12f 100644 --- a/docs/getting-started/devilbox-intranet.rst +++ b/docs/getting-started/devilbox-intranet.rst @@ -1,3 +1,7 @@ +.. include:: /_includes/all.rst + +.. _devilbox_intranet: + ***************** Devilbox intranet ***************** @@ -75,7 +79,7 @@ Third-party tools phpMyAdmin ---------- -`phpMyAdmin `_ is a free software tool written in PHP, +|ext_lnk_tool_phpmyadmin| is a free software tool written in PHP, intended to handle the administration of MySQL over the Web. phpMyAdmin supports a wide range of operations on MySQL and MariaDB. Frequently used operations (managing databases, tables, columns, relations, indexes, users, permissions, etc) can be performed via the user interface, @@ -85,7 +89,7 @@ while you still have the ability to directly execute any SQL statement. Adminer ------- -`Adminer `_ (formerly phpMinAdmin) is a full-featured database +|ext_lnk_tool_adminer| (formerly phpMinAdmin) is a full-featured database management tool written in PHP. Conversely to phpMyAdmin, it consist of a single file ready to deploy to the target server. Adminer is available for MySQL, MariaDB, PostgreSQL, SQLite, MS SQL, Oracle, Firebird, SimpleDB, Elasticsearch and MongoDB. @@ -94,7 +98,7 @@ Oracle, Firebird, SimpleDB, Elasticsearch and MongoDB. OpcacheGUI ---------- -`OpcacheGui `_ is a clean and responsive interface for +|ext_lnk_tool_opcachegui| is a clean and responsive interface for Zend OPcache information, showing statistics, settings and cached files, and providing a real-time update for the information (using jQuery and React). diff --git a/docs/getting-started/install-the-devilbox.rst b/docs/getting-started/install-the-devilbox.rst index 34c6bffc..e8a71aa2 100644 --- a/docs/getting-started/install-the-devilbox.rst +++ b/docs/getting-started/install-the-devilbox.rst @@ -48,7 +48,7 @@ and in this case it is used as the main configuration file for the Devilbox by p of settings (such as which version to start up). .. seealso:: - * |ext_lnk_docker_cmpose_env_file| + * |ext_lnk_docker_compose_env_file| * :ref:`env_file` diff --git a/docs/getting-started/prerequisites.rst b/docs/getting-started/prerequisites.rst index 39630c1e..e34857bc 100644 --- a/docs/getting-started/prerequisites.rst +++ b/docs/getting-started/prerequisites.rst @@ -98,7 +98,8 @@ Additionally you will require ``git`` in order to clone the devilbox project. .. seealso:: * |ext_lnk_install_docker| - * |ext_lnk_install_docker_compose| + * |ext_lnk_docker_compose_install| + * |ext_lnk_download_git_win| * :ref:`howto_find_docker_and_docker_compose_version` @@ -255,12 +256,17 @@ Optional previous knowledge In order to easily work with the Devilbox you should already be familiar with the following: * Navigate on the command line -* Docker Compose commands (``up``, ``stop``, ``kill``, ``rm``, ``logs``, ``pull``) +* Docker Compose commands (|ext_lnk_docker_compose_cmd_up|, |ext_lnk_docker_compose_cmd_stop|, + |ext_lnk_docker_compose_cmd_kill|, |ext_lnk_docker_compose_cmd_rm|, + |ext_lnk_docker_compose_cmd_logs| and |ext_lnk_docker_compose_cmd_pull|) * Docker Compose ``.env`` file * Know how to use ``git`` + + + .. seealso:: - * |ext_lnk_docker_cmpose_cmd_reference| - * |ext_lnk_docker_cmpose_env_file| + * |ext_lnk_docker_compose_cmd_reference| + * |ext_lnk_docker_compose_env_file| * :ref:`troubleshooting` diff --git a/docs/getting-started/start-the-devilbox.rst b/docs/getting-started/start-the-devilbox.rst index a6e55107..de6880e6 100644 --- a/docs/getting-started/start-the-devilbox.rst +++ b/docs/getting-started/start-the-devilbox.rst @@ -1,3 +1,5 @@ +.. include:: /_includes/all.rst + .. _start_the_devilbox: ****************** @@ -10,10 +12,11 @@ your hands dirty. .. note:: Starting and stopping containers is done via ``docker-compose``. If you have never worked with - it before, have a look at their documentation for an - `overview `_, - `up `_ and - `stop `_ commands. + it before, have a look at their documentation for + |ext_lnk_docker_compose_cmd_overview|, |ext_lnk_docker_compose_cmd_up|, + |ext_lnk_docker_compose_cmd_stop|, |ext_lnk_docker_compose_cmd_kill|, + |ext_lnk_docker_compose_cmd_rm|, |ext_lnk_docker_compose_cmd_logs| and + |ext_lnk_docker_compose_cmd_pull| commands. **Table of Contents** diff --git a/docs/intermediate/source-code-analysis.rst b/docs/intermediate/source-code-analysis.rst index 83d5597c..be3a29db 100644 --- a/docs/intermediate/source-code-analysis.rst +++ b/docs/intermediate/source-code-analysis.rst @@ -1,3 +1,5 @@ +.. include:: /_includes/all.rst + .. _source_code_analysis: ******************** @@ -36,7 +38,7 @@ workspace and its files. You can for example check for: Some of the bundled tools even allow for automatic fixing. -.. seealso:: `awesome-ci `_ +.. seealso:: |ext_lnk_tool_awesome_ci| .. code-block:: bash @@ -75,7 +77,7 @@ PHPCS PHPCS is a code style analyser for PHP. -.. seealso:: `PHPCS `_ +.. seealso:: |ext_lnk_tool_phpcs| .. code-block:: bash @@ -94,7 +96,7 @@ ESLint ESLint is a Javascript static source code analyzer. -.. seealso:: `ESLint `_ +.. seealso:: |ext_lnk_tool_eslint| .. code-block:: bash diff --git a/docs/readings/available-tools.rst b/docs/readings/available-tools.rst index 75f25460..5a1aad25 100644 --- a/docs/readings/available-tools.rst +++ b/docs/readings/available-tools.rst @@ -1,3 +1,5 @@ +.. include:: /_includes/all.rst + .. _available_tools: *************** @@ -11,77 +13,77 @@ to worry to have less or more tools available. The PHP container is your workhorse and these are your tools: -+----------------------+-----------------------------------------------------------------------------------+ -| Binary | Tool | -+======================+===================================================================================+ -| various binaries | `awesome-ci `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``brew`` | `Linux brew `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``composer`` | `Composer `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``drush`` | `Drush `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``drupal`` | `Drupal Console `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``eslint`` | `ESLint `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``git`` | `Git `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``git-flow`` | `Git flow `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``gulp`` | `Gulp `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``grunt`` | `Grunt `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``jsonlint`` | `JSON lint `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``laravel`` | `Laravel installer `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``mdl`` | `Markdown lint `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``mdlint`` | `MD Linter `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``mongo*`` | Various MongoDB client tools | -+----------------------+-----------------------------------------------------------------------------------+ -| ``mysql*`` | Various MySQL client tools | -+----------------------+-----------------------------------------------------------------------------------+ -| ``mysqldump-secure`` | `mysqldump-secure `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``node`` | `Node `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``npm`` | `NPM `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``pg*`` | Various PostgreSQL client tools | -+----------------------+-----------------------------------------------------------------------------------+ -| ``phalcon`` | `Phalcon DevTools `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``phpcs`` | `PHP CodeSniffer `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``phpcbf`` | `PHP Code Beautifier and Fixer `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``photon`` | `Photon CMS cli `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``redis*`` | Various Redis client tools | -+----------------------+-----------------------------------------------------------------------------------+ -| ``sass`` | `Sass `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``scss-lint`` | `SCSS Lint `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``ssh`` | `OpenSSH `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``symfony`` | `Symfony installer `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``tig`` | `Text-mode Interface for Git `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``webpack`` | `Webpack `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``wp`` | `Wordpress CLI `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``yamllint`` | `Yamllint `_ | -+----------------------+-----------------------------------------------------------------------------------+ -| ``yarn`` | `Yarn `_ | -+----------------------+-----------------------------------------------------------------------------------+ ++----------------------+---------------------------------------+ +| Binary | Tool | ++======================+=======================================+ +| various binaries | |ext_lnk_tool_awesome_ci| | ++----------------------+---------------------------------------+ +| ``brew`` | |ext_lnk_tool_linuxbrew| | ++----------------------+---------------------------------------+ +| ``composer`` | |ext_lnk_tool_composer| | ++----------------------+---------------------------------------+ +| ``drush`` | |ext_lnk_tool_drush| | ++----------------------+---------------------------------------+ +| ``drupal`` | |ext_lnk_tool_drupal_console| | ++----------------------+---------------------------------------+ +| ``eslint`` | |ext_lnk_tool_eslint| | ++----------------------+---------------------------------------+ +| ``git`` | |ext_lnk_tool_git| | ++----------------------+---------------------------------------+ +| ``git-flow`` | |ext_lnk_tool_git_flow| | ++----------------------+---------------------------------------+ +| ``gulp`` | |ext_lnk_tool_gulp| | ++----------------------+---------------------------------------+ +| ``grunt`` | |ext_lnk_tool_grunt| | ++----------------------+---------------------------------------+ +| ``jsonlint`` | |ext_lnk_tool_jsonlint| | ++----------------------+---------------------------------------+ +| ``laravel`` | |ext_lnk_tool_laravel| | ++----------------------+---------------------------------------+ +| ``mdl`` | |ext_lnk_tool_mdl| | ++----------------------+---------------------------------------+ +| ``mdlint`` | |ext_lnk_tool_mdlint| | ++----------------------+---------------------------------------+ +| ``mongo*`` | Various MongoDB client tools | ++----------------------+---------------------------------------+ +| ``mysql*`` | Various MySQL client tools | ++----------------------+---------------------------------------+ +| ``mysqldump-secure`` | |ext_lnk_tool_mysqldump_secure| | ++----------------------+---------------------------------------+ +| ``node`` | |ext_lnk_tool_node| | ++----------------------+---------------------------------------+ +| ``npm`` | |ext_lnk_tool_npm| | ++----------------------+---------------------------------------+ +| ``pg*`` | Various PostgreSQL client tools | ++----------------------+---------------------------------------+ +| ``phalcon`` | |ext_lnk_tool_phalcon| | ++----------------------+---------------------------------------+ +| ``phpcs`` | |ext_lnk_tool_phpcs| | ++----------------------+---------------------------------------+ +| ``phpcbf`` | |ext_lnk_tool_phpcbf| | ++----------------------+---------------------------------------+ +| ``photon`` | |ext_lnk_tool_photon| | ++----------------------+---------------------------------------+ +| ``redis*`` | Various Redis client tools | ++----------------------+---------------------------------------+ +| ``sass`` | |ext_lnk_tool_sass| | ++----------------------+---------------------------------------+ +| ``scss-lint`` | |ext_lnk_tool_scss_lint| | ++----------------------+---------------------------------------+ +| ``ssh`` | |ext_lnk_tool_ssh| | ++----------------------+---------------------------------------+ +| ``symfony`` | |ext_lnk_tool_symfony| | ++----------------------+---------------------------------------+ +| ``tig`` | |ext_lnk_tool_tig| | ++----------------------+---------------------------------------+ +| ``webpack`` | |ext_lnk_tool_webpack| | ++----------------------+---------------------------------------+ +| ``wp`` | |ext_lnk_tool_wp| | ++----------------------+---------------------------------------+ +| ``yamllint`` | |ext_lnk_tool_yamllint| | ++----------------------+---------------------------------------+ +| ``yarn`` | |ext_lnk_tool_yarn| | ++----------------------+---------------------------------------+ .. note:: If you are in need of other tools, open up an issue at