Merge pull request #551 from joaocsilva/feature/DQA-0

DQA-0: Update documentation.

README.md

@@ -29,20 +29,23 @@ locally and can be used in CI tools like Jenkins, Drone or Travis.
 - [Continuous integration](/docs/continuous-integration.md)
 - [Available tasks](/docs/available-tasks.md)
 - [Building assets](/docs/building-assets.md)
-- [Changelog](/changelog.md)
+- [Update Project Documentation](/docs/project-documentation.md)
+- [Changelog](/CHANGELOG.md)
 
 ## Contributing
-Please read [CONTRIBUTING.md](/CONTRIBUTING.MD) for details on our code of conduct and the process to submit pull-request to us.
+Please read [CONTRIBUTING.md](/CONTRIBUTING.md) for details on our code of conduct and the process to submit pull-request to us.
 
 ## License
-This project is licensed under the EUROPEAN UNION PUBLIC LICENCE v. 1.2 - see the [LICENSE.md](/LICENSE.md) for details.
+This project is licensed under the EUROPEAN UNION PUBLIC LICENCE v. 1.2 - see the [LICENSE.txt](/LICENSE.txt) for details.
 
 ## Maintainers
 This project is maintained by members of the Quality Assurance team who review
 incoming pull requests for the NextEuropa project. The board on which they
 operate can be found at [https://webgate.ec.europa.eu/CITnet/jira].
 
 <details><summary><b>Contact list</b></summary>
+
 - [Alex Verbruggen](https://github.com/verbruggenalex): Maintainer - Quality Assurance
+
 - [Joao Santos](https://github.com/jonhy81): Maintainer - Quality Assurance
 </details>

docs/available-tasks.md

@@ -2,48 +2,60 @@
 
 To list all available tasks, please run:
 ```
-✔ ~/Projects/cnect-eurohpc-reference [master|✔]
-15:12 $ docker-composer exec web ./vendor/bin/run
+docker-composer exec web ./vendor/bin/run
 ```
 
-See bellow current list for version `4.0.0-beta8`.
+See bellow current list for version `8.6.19`.
 ```
 Available commands:
-  help                          Displays help for a command
-  list                          Lists commands
+  help                           Displays help for a command
+  list                           Lists commands
  changelog
-  changelog:generate            [changelog:g|cg] Generate a changelog based on GitHub issues and pull requests.
+  changelog:generate             [changelog:g|cg] Generate a changelog based on GitHub issues and pull requests.
  drupal
-  drupal:drush-setup            Write Drush configuration files to given directories.
-  drupal:permissions-setup      Setup Drupal permissions.
-  drupal:settings-setup         Setup Drupal settings.php file in compliance with Toolkit conventions.
+  drupal:drush-setup             Write Drush configuration files to given directories.
+  drupal:permissions-setup       Setup Drupal permissions.
+  drupal:settings-setup          Setup Drupal settings.php file in compliance with Toolkit conventions.
   drupal:setup-test
-  drupal:site-install           [drupal:si|dsi] Install target site.
-  drupal:site-post-install      Run Drupal post-install commands.
-  drupal:site-pre-install       Run Drupal pre-install commands.
+  drupal:site-install            [drupal:si|dsi] Install target site.
+  drupal:site-post-install       Run Drupal post-install commands.
+  drupal:site-pre-install        Run Drupal pre-install commands.
  release
-  release:create-archive        [release:ca|rca] Create a release for the current project.
+  release:create-archive         [release:ca|rca] Create a release for the current project.
  toolkit
-  toolkit:build-assets          [tba] Build theme assets (Css/Js).
-  toolkit:build-dev             Build site for local development.
-  toolkit:build-dev-reset       Build site for local development from scratch with a clean git.
-  toolkit:build-dist            Build the distribution package.
-  toolkit:component-check       Check composer.json for components that are not whitelisted/blacklisted.
-  toolkit:disable-drupal-cache  Disable aggregation and clear cache.
-  toolkit:download-dump         Download ASDA snapshot.
-  toolkit:import-config         Import config.
-  toolkit:install-clean         Install a clean website.
-  toolkit:install-clean-dev     Install a clean website in dev mode.
-  toolkit:install-clone         Install a clone website.
-  toolkit:install-clone-dev     Install a clone website in dev mode.
-  toolkit:install-dump          Install clone from production snapshot.
-  toolkit:run-deploy            Run deployment sequence.
-  toolkit:run-phpcbf            [tpb] Run PHP code autofixing.
-  toolkit:test-behat            [tb] Run Behat tests.
-  toolkit:test-phpcs            [tp] Run PHP code review.
-  toolkit:drupal-upgrade-status [tdus] Check project compatibility for Drupal 9/10 upgrade.
-
-
+  toolkit:build-assets           [tba] Build theme assets (Css and Js).
+  toolkit:build-dev              Build site for local development.
+  toolkit:build-dev-reset        Build site for local development from scratch with a clean git.
+  toolkit:build-dist             Build the distribution package.
+  toolkit:check-version          Check the Toolkit version.
+  toolkit:code-review            This command will execute all the testing tools.
+  toolkit:complock-check         Check if 'composer.lock' exists on the project root folder.
+  toolkit:component-check        Check composer.json for components that are not whitelisted/blacklisted.
+  toolkit:disable-drupal-cache   Disable aggregation and clear cache.
+  toolkit:download-dump          Download ASDA snapshot.
+  toolkit:drupal-upgrade-status  [tdus] Check project compatibility for Drupal 9/10 upgrade.
+  toolkit:fix-permissions        Run script to fix permissions (experimental).
+  toolkit:import-config          Import config.
+  toolkit:install-clean          Install a clean website.
+  toolkit:install-clone          Install a clone website.
+  toolkit:install-dependencies   Install packages present in the opts.yml file under extra_pkgs section.
+  toolkit:install-dump           Import the production snapshot.
+  toolkit:lint-php               [tlp] Run lint PHP.
+  toolkit:lint-yaml              [tly] Run lint YAML.
+  toolkit:notifications          Display toolkit notifications.
+  toolkit:opts-review            Check project's .opts.yml file for forbidden commands.
+  toolkit:requirements           Check the Toolkit Requirements.
+  toolkit:run-blackfire          [tbf] Run Blackfire.
+  toolkit:run-deploy             Run deployment sequence.
+  toolkit:run-phpcbf             [tpb] Run PHP code autofixing.
+  toolkit:run-phpcbf-standalone  Run PHP code autofixing in standalone mode.
+  toolkit:setup-blackfire-behat  Copy the needed resources to run Behat with Blackfire.
+  toolkit:setup-phpcs            Setup PHP code sniffer for standalone execution.
+  toolkit:test-behat             [tb] Run Behat tests.
+  toolkit:test-phpcs             [tp] Run PHP code sniffer.
+  toolkit:test-phpmd             Run PHPMD standalone.
+  toolkit:test-phpunit           [tp] Run PHPUnit tests.
+  toolkit:vendor-list            Check 'Vendor' packages being monitorised.
 ```
 
 ### Other topics
@@ -53,6 +65,7 @@ Available commands:
 - [Testing the project](/docs/testing-project.md)
 - [Using Docker environment](/docs/docker-environment.md)
 - [Continuous integration](/docs/continuous-integration.md)
+- Available tasks
 - [Building assets](/docs/building-assets.md)
 - [Update Project Documentation](/docs/project-documentation.md)
-- [Changelog](/changelog.md)
+- [Changelog](/CHANGELOG.md)

docs/building-assets.md

@@ -4,7 +4,7 @@
 
 Toolkit provides a way to build theme assets with Gulp.js.
 
-By default a gulpfile is included and as well some npm packages in order to:
+By default, a gulpfile is included and as well some npm packages in order to:
 
 - Look for Scss files and convert them into Css
 - Minify Css and Js
@@ -47,7 +47,7 @@ docker-compose vendor/bin/run toolkit:build-assets --default-theme=your-theme
 
 ### Define 'custom-code-folder'
 
-If for some reason your project is running custom code in other folder then 'lib', it's possible to make it configurable with the following:
+If for some reason your project is running custom code in other folder then `lib`, it's possible to make it configurable with the following:
 ```
 toolkit:
   build:
@@ -68,7 +68,7 @@ docker-compose exec web ./vendor/bin/run tba
 This will (re)generate the /assets folder.
 
 ## Enable build assets during CI
-To enable auto build of assets you should extend the tasks buidl-dev and build-dist. See example bellow.
+To enable auto build of assets you should extend the tasks `build-dev` and `build-dist`. See example bellow.
 ```
 toolkit:
   project_id: "my-project"
@@ -93,7 +93,7 @@ If the file do not exists, toolkit will create one using the default template.
 ### Install additional npm packages
 
 Additional npm packages can be installed to extend the functionality.
-In order to do that add them in the file 'runner.yml' like the example bellow:
+In order to do that add them in the file `runner.yml` like the example bellow:
 
 ```
 toolkit:
@@ -104,8 +104,8 @@ toolkit:
 
 #### npm install --save-dev
 
-By default the npm packages are installed with the option '--save-dev' and will appear in the devDependencies.
-To override this behavior add in the file 'runner.yml' the following property:
+By default, the npm packages are installed with the option `--save-dev` and will appear in the devDependencies.
+To override this behavior add in the file `runner.yml` the following property:
 
 ```
 toolkit:
@@ -134,13 +134,14 @@ Automatically fix, where possible, violations reported.
 docker-compose exec web ./vendor/bin/run toolkit:build-assets --validate=fix
 ```
 
-### Others topics
+### Other topics
+- [Setting up a project](/docs/setting-up-project.md)
 - [Configuring a project](/docs/configuring-project.md)
 - [Installing the project](/docs/installing-project.md)
 - [Testing the project](/docs/testing-project.md)
 - [Using Docker environment](/docs/docker-environment.md)
 - [Continuous integration](/docs/continuous-integration.md)
-- [Building assets](/docs/building-assets.md)
 - [Available tasks](/docs/available-tasks.md)
+- Building assets
 - [Update Project Documentation](/docs/project-documentation.md)
 - [Changelog](/CHANGELOG.md)

docs/configuring-project.md

@@ -7,10 +7,10 @@ The override file, as its name implies, can contain configuration overrides for
 services.
 If a service is defined in both files, Docker Compose merges the configurations.
 
-Find more information on Docker Compose extension mechanism on 
+Find more information on Docker Compose extension mechanism on
 [the official Docker Compose documentation](https://docs.docker.com/compose/extends/).
 
-The following configuration parameters are provided as environment variables in the [/.env](.env) file:
+The following configuration parameters are provided as environment variables in the `./.env` file:
 
 | Name                                  | Description                                               |
 |---------------------------------------|-----------------------------------------------------------|
@@ -30,7 +30,7 @@ The following configuration parameters are provided as environment variables in
 | `DRUPAL_WEBTOOLS_ANALYTICS_SITE_ID`   | Drupal site unique identifier                             |
 | `DRUPAL_WEBTOOLS_ANALYTICS_SITE_PATH` | The domain + root path without protocol.                  |
 
-Environment variables will be loaded by Docker Compose when running `docker-compose up -d`.  
+Environment variables will be loaded by Docker Compose when running `docker-compose up -d`.
 
 ### Subsite configuration
 By default, subsite configuration go into file `runner.yml.dist`, see bellow an example.
@@ -63,12 +63,14 @@ Toolkit will load the credentials necessary to clone your subsite from your envi
 - ASDA_USER
 - ASDA_PASSWORD
 
-### Others topics
+### Other topics
 - [Setting up a project](/docs/setting-up-project.md)
+- Configuring a project
 - [Installing the project](/docs/installing-project.md)
 - [Testing the project](/docs/testing-project.md)
 - [Using Docker environment](/docs/docker-environment.md)
 - [Continuous integration](/docs/continuous-integration.md)
+- [Available tasks](/docs/available-tasks.md)
 - [Building assets](/docs/building-assets.md)
 - [Update Project Documentation](/docs/project-documentation.md)
 - [Changelog](/CHANGELOG.md)

docs/continuous-integration.md

@@ -16,7 +16,7 @@ Starting tunnel at https://user:[email protected]
 2019/08/06 06:20:17 [I] [control.go:411] [b6a48e313c53a474] [reponame-buildid1-buildid2--demo] start proxy success
 ```
 
-You can simply copy paste the tunnel url and visit your site. When appending /shell to your tunnel url you get access to the build through a web shell.
+You can simply copy/paste the tunnel url and visit your site.
 
 ## Deploy mode
 
@@ -28,7 +28,8 @@ The pipeline allows for an automatic deployment to the acceptance environment. T
 - [Installing the project](/docs/installing-project.md)
 - [Testing the project](/docs/testing-project.md)
 - [Using Docker environment](/docs/docker-environment.md)
-- [Building assets](/docs/building-assets.md)
+- Continuous integration
 - [Available tasks](/docs/available-tasks.md)
+- [Building assets](/docs/building-assets.md)
 - [Update Project Documentation](/docs/project-documentation.md)
 - [Changelog](/CHANGELOG.md)

docs/docker-environment.md

@@ -6,10 +6,10 @@ The override file, as its name implies, can contain configuration overrides for
 services.
 If a service is defined in both files, Docker Compose merges the configurations.
 
-Find more information on Docker Compose extension mechanism on 
+Find more information on Docker Compose extension mechanism on
 [the official Docker Compose documentation](https://docs.docker.com/compose/extends/).
 
-The following configuration parameters are provided as environment variables in the [/.env](.env) file:
+The following configuration parameters are provided as environment variables in the `./.env` file:
 
 | Name                                  | Description                                               |
 |---------------------------------------|-----------------------------------------------------------|
@@ -29,7 +29,7 @@ The following configuration parameters are provided as environment variables in
 | `DRUPAL_WEBTOOLS_ANALYTICS_SITE_ID`   | Drupal site unique identifier                             |
 | `DRUPAL_WEBTOOLS_ANALYTICS_SITE_PATH` | The domain + root path without protocol.                  |
 
-Environment variables will be loaded by Docker Compose when running `docker-compose up -d`.  
+Environment variables will be loaded by Docker Compose when running `docker-compose up -d`.
 
 ### Subsite configuration
 By default, subsite configuration go into file `runner.yml.dist`, see bellow an example.
@@ -57,8 +57,9 @@ selenium:
 - [Configuring a project](/docs/configuring-project.md)
 - [Installing the project](/docs/installing-project.md)
 - [Testing the project](/docs/testing-project.md)
+- Using Docker environment
 - [Continuous integration](/docs/continuous-integration.md)
-- [Building assets](/docs/building-assets.md)
 - [Available tasks](/docs/available-tasks.md)
+- [Building assets](/docs/building-assets.md)
 - [Update Project Documentation](/docs/project-documentation.md)
-- [Changelog](/CHANGELOG.md)
+- [Changelog](/CHANGELOG.md)

docs/installing-project.md

@@ -3,8 +3,11 @@
 ### Before install
 To start, run:
 
+```
 docker-compose up
-It's advised to not daemonize docker-compose so you can turn it off (CTRL+C) quickly when you're done working. However, if you'd like to daemonize it, you have to add the flag -d:
+```
+
+It's advised to not daemonize docker-compose, so you can turn it off (CTRL+C) quickly when you're done working. However, if you'd like to daemonize it, you have to add the flag -d:
 
 ```
 docker-compose up -d
@@ -28,7 +31,9 @@ docker-compose exec web ./vendor/bin/run toolkit:install-clean
 
 To install the site from existing configuration run:
 
+```
 docker-compose exec web ./vendor/bin/run drupal:site-install --existing-config
+```
 
 
 ### Clone installation
@@ -75,10 +80,11 @@ These commands simulate the automated deployment that Drone provides through its
 ### Other topics
 - [Setting up a project](/docs/setting-up-project.md)
 - [Configuring a project](/docs/configuring-project.md)
+- Installing the project
 - [Testing the project](/docs/testing-project.md)
 - [Using Docker environment](/docs/docker-environment.md)
 - [Continuous integration](/docs/continuous-integration.md)
-- [Building assets](/docs/building-assets.md)
 - [Available tasks](/docs/available-tasks.md)
+- [Building assets](/docs/building-assets.md)
 - [Update Project Documentation](/docs/project-documentation.md)
-- [Changelog](/CHANGELOG.md)
+- [Changelog](/CHANGELOG.md)

docs/project-documentation.md

@@ -9,20 +9,19 @@ To update the documentation run the following command. This will update
 the content inside the folder ‘docs’.
 
 ```
-
-   docker run --rm -v $(pwd):/data phpdoc/phpdoc run -d ./  -t ./docs
-   
+docker run --rm -v $(pwd):/data phpdoc/phpdoc run -d ./  -t ./docs
 ```
 
 Then push the changes generated.
 
 ### Other topics
-- [Available tasks](/docs/available-tasks.md)
 - [Setting up a project](/docs/setting-up-project.md)
 - [Configuring a project](/docs/configuring-project.md)
 - [Installing the project](/docs/installing-project.md)
 - [Testing the project](/docs/testing-project.md)
 - [Using Docker environment](/docs/docker-environment.md)
 - [Continuous integration](/docs/continuous-integration.md)
+- [Available tasks](/docs/available-tasks.md)
 - [Building assets](/docs/building-assets.md)
-- [Changelog](/changelog.md)
+- Update Project Documentation
+- [Changelog](/CHANGELOG.md)

docs/setting-up-project.md

@@ -25,13 +25,14 @@ docker-compose exec web composer install
 docker-compose exec web vendor/bin/run
 ```
 
-### Others topics
+### Other topics
+- Setting up a project
 - [Configuring a project](/docs/configuring-project.md)
 - [Installing the project](/docs/installing-project.md)
 - [Testing the project](/docs/testing-project.md)
 - [Using Docker environment](/docs/docker-environment.md)
 - [Continuous integration](/docs/continuous-integration.md)
-- [Building assets](/docs/building-assets.md)
 - [Available tasks](/docs/available-tasks.md)
+- [Building assets](/docs/building-assets.md)
 - [Update Project Documentation](/docs/project-documentation.md)
 - [Changelog](/CHANGELOG.md)

docs/testing-project.md

@@ -178,7 +178,7 @@ toolkit:
 ```
 
 ## Testing in CI
-Toolkit is full integrated with oficial pipeline that currently requires minimum
+Toolkit is full integrated with official pipeline that currently requires minimum
 of 1 behat test and a clean report for phpcs check.
 
 Any customization done in your project will be respected in Drone build.
@@ -187,8 +187,10 @@ Any customization done in your project will be respected in Drone build.
 - [Setting up a project](/docs/setting-up-project.md)
 - [Configuring a project](/docs/configuring-project.md)
 - [Installing the project](/docs/installing-project.md)
+- Testing the project
 - [Using Docker environment](/docs/docker-environment.md)
 - [Continuous integration](/docs/continuous-integration.md)
+- [Available tasks](/docs/available-tasks.md)
 - [Building assets](/docs/building-assets.md)
 - [Update Project Documentation](/docs/project-documentation.md)
 - [Changelog](/CHANGELOG.md)