From 55b5906efe7e14690f90eb1c9064d95405691304 Mon Sep 17 00:00:00 2001 From: Dharizza Espinach B Date: Thu, 25 Oct 2018 18:37:34 -0600 Subject: [PATCH 1/3] Improve section listing. --- docs/index.md | 82 +++++++++++++++++++++++++-------------------------- 1 file changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/index.md b/docs/index.md index b2a883c..cc20690 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,50 +6,50 @@ This is the official documentation for the Humpback tool. - [Home](index.md) - About: - - [About Humpback](about/about-humpback.md) - - [What's in the box](about/whats-in-the-box.md) + - [About Humpback](about/about-humpback.md) + - [What's in the box](about/whats-in-the-box.md) - Get started with Humpback: - - Get Humpback: - - [Linux](get-started-with-humpback/get-humpback/linux.md) - - [Mac Os](get-started-with-humpback/get-humpback/mac-os.md) - - [Windows](get-started-with-humpback/get-humpback/windows.md) - - [Creating our first site](get-started-with-humpback/creating-our-first-site.md) + - Get Humpback: + - [Linux](get-started-with-humpback/get-humpback/linux.md) + - [Mac Os](get-started-with-humpback/get-humpback/mac-os.md) + - [Windows](get-started-with-humpback/get-humpback/windows.md) + - [Creating our first site](get-started-with-humpback/creating-our-first-site.md) - Working with humpback: - - [Project structure](working-with-humpback/project-structure.md) - - [Configure CircleCI + Pantheon](working-with-humpback/configure-circleci-pantheon.md) - - [Using different installation profile](working-with-humpback/using-different-installation-profile.md) - - [Profiling your project with Blackfire](working-with-humpback/profiling-your-project-with-blackfire.md) - - [Debugging your code with Xdebug](working-with-humpback/debugging-your-code-with-xdebug.md) + - [Project structure](working-with-humpback/project-structure.md) + - [Configure CircleCI + Pantheon](working-with-humpback/configure-circleci-pantheon.md) + - [Using different installation profile](working-with-humpback/using-different-installation-profile.md) + - [Profiling your project with Blackfire](working-with-humpback/profiling-your-project-with-blackfire.md) + - [Debugging your code with Xdebug](working-with-humpback/debugging-your-code-with-xdebug.md) - Developing for humpback: - [Using your local version of the Humpback generator](developing-for-humpback/using-your-local-version-of-the-generator.md) - Humpback commands: - - [ahoy up](humpback-commands/ahoy-up.md) - - [ahoy stop](humpback-commands/ahoy-stop.md) - - [ahoy down](humpback-commands/ahoy-down.md) - - [ahoy site](humpback-commands/ahoy-site.md) - - [ahoy site install](humpback-commands/ahoy-site-install.md) - - [ahoy composer](humpback-commands/ahoy-composer.md) - - [ahoy help](humpback-commands/ahoy-help.md) - - [ahoy drush](humpback-commands/ahoy-drush.md) - - [ahoy bash](humpback-commands/ahoy-bash.md) - - [ahoy docker](humpback-commands/ahoy-docker.md) - - [ahoy docker mailhog-url](humpback-commands/ahoy-docker-mailhog-url.md) - - [ahoy docker share-url](humpback-commands/ahoy-docker-share-url.md) - - [ahoy docker url](humpback-commands/ahoy-docker-url.md) - - [ahoy docker vnc-url](humpback-commands/ahoy-docker-vnc-url.md) - - [ahoy docker varnish-url](humpback-commands/ahoy-docker-varnish-url.md) + - [ahoy up](humpback-commands/ahoy-up.md) + - [ahoy stop](humpback-commands/ahoy-stop.md) + - [ahoy down](humpback-commands/ahoy-down.md) + - [ahoy site](humpback-commands/ahoy-site.md) + - [ahoy site install](humpback-commands/ahoy-site-install.md) + - [ahoy composer](humpback-commands/ahoy-composer.md) + - [ahoy help](humpback-commands/ahoy-help.md) + - [ahoy drush](humpback-commands/ahoy-drush.md) + - [ahoy bash](humpback-commands/ahoy-bash.md) + - [ahoy docker](humpback-commands/ahoy-docker.md) + - [ahoy docker mailhog-url](humpback-commands/ahoy-docker-mailhog-url.md) + - [ahoy docker share-url](humpback-commands/ahoy-docker-share-url.md) + - [ahoy docker url](humpback-commands/ahoy-docker-url.md) + - [ahoy docker vnc-url](humpback-commands/ahoy-docker-vnc-url.md) + - [ahoy docker varnish-url](humpback-commands/ahoy-docker-varnish-url.md) - Toolset details: - - [Nginx](tool-set-details/nginx.md) - - [Mailhog](tool-set-details/mailhog.md) - - [MariaDb](tool-set-details/mariadb.md) - - [Ngrok](tool-set-details/ngrok.md) - - [PHP-FPM](tool-set-details/php-fpm.md) - - [Selenium](tool-set-details/selenium.md) - - [Solr](tool-set-details/solr.md) - - [Traefik](tool-set-details/traefik.md) - - [varnish](tool-set-details/varnish.md) - - [Custom CLI](tool-set-details/custom-cli.md) - - [Blackfire](tool-set-details/blackfire.md) - - [Lighthouse](tool-set-details/lighthouse.md) - - [Xdebug](tool-set-details/xdebug.md) - - [BackstopJS](tool-set-details/backstop.md) + - [Nginx](tool-set-details/nginx.md) + - [Mailhog](tool-set-details/mailhog.md) + - [MariaDb](tool-set-details/mariadb.md) + - [Ngrok](tool-set-details/ngrok.md) + - [PHP-FPM](tool-set-details/php-fpm.md) + - [Selenium](tool-set-details/selenium.md) + - [Solr](tool-set-details/solr.md) + - [Traefik](tool-set-details/traefik.md) + - [varnish](tool-set-details/varnish.md) + - [Custom CLI](tool-set-details/custom-cli.md) + - [Blackfire](tool-set-details/blackfire.md) + - [Lighthouse](tool-set-details/lighthouse.md) + - [Xdebug](tool-set-details/xdebug.md) + - [BackstopJS](tool-set-details/backstop.md) From c7b2c9125bca26ea8d00a4dd0914ad8f5b934a72 Mon Sep 17 00:00:00 2001 From: Dharizza Espinach B Date: Thu, 25 Oct 2018 18:46:50 -0600 Subject: [PATCH 2/3] Added docs for gulp commands. --- docs/humpback-commands/gulp-commands.md | 19 +++++++++++++++ docs/index.md | 32 +++++++++++++------------ mkdocs.yml | 32 +++++++++++++------------ 3 files changed, 53 insertions(+), 30 deletions(-) create mode 100644 docs/humpback-commands/gulp-commands.md diff --git a/docs/humpback-commands/gulp-commands.md b/docs/humpback-commands/gulp-commands.md new file mode 100644 index 0000000..b444766 --- /dev/null +++ b/docs/humpback-commands/gulp-commands.md @@ -0,0 +1,19 @@ +## Gulp Commands included + +When you generate your project you'll get the following commands: + +#### gulp drupalcs + +This command validates all the custom files with Drupal Coding Standards. + +#### gulp eslint + +When you run this, it will validate the custom Javascript in the project with best practices and Drupal Coding Standards. + +#### gulp phplint + +This commands checks the syntax of PHP files in the project. + +#### gulp help + +This command will show you all the existings tasks for the project. diff --git a/docs/index.md b/docs/index.md index cc20690..e4df7b0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,21 +23,23 @@ This is the official documentation for the Humpback tool. - Developing for humpback: - [Using your local version of the Humpback generator](developing-for-humpback/using-your-local-version-of-the-generator.md) - Humpback commands: - - [ahoy up](humpback-commands/ahoy-up.md) - - [ahoy stop](humpback-commands/ahoy-stop.md) - - [ahoy down](humpback-commands/ahoy-down.md) - - [ahoy site](humpback-commands/ahoy-site.md) - - [ahoy site install](humpback-commands/ahoy-site-install.md) - - [ahoy composer](humpback-commands/ahoy-composer.md) - - [ahoy help](humpback-commands/ahoy-help.md) - - [ahoy drush](humpback-commands/ahoy-drush.md) - - [ahoy bash](humpback-commands/ahoy-bash.md) - - [ahoy docker](humpback-commands/ahoy-docker.md) - - [ahoy docker mailhog-url](humpback-commands/ahoy-docker-mailhog-url.md) - - [ahoy docker share-url](humpback-commands/ahoy-docker-share-url.md) - - [ahoy docker url](humpback-commands/ahoy-docker-url.md) - - [ahoy docker vnc-url](humpback-commands/ahoy-docker-vnc-url.md) - - [ahoy docker varnish-url](humpback-commands/ahoy-docker-varnish-url.md) + - Ahoy commands: + - [ahoy up](humpback-commands/ahoy-up.md) + - [ahoy stop](humpback-commands/ahoy-stop.md) + - [ahoy down](humpback-commands/ahoy-down.md) + - [ahoy site](humpback-commands/ahoy-site.md) + - [ahoy site install](humpback-commands/ahoy-site-install.md) + - [ahoy composer](humpback-commands/ahoy-composer.md) + - [ahoy help](humpback-commands/ahoy-help.md) + - [ahoy drush](humpback-commands/ahoy-drush.md) + - [ahoy bash](humpback-commands/ahoy-bash.md) + - [ahoy docker](humpback-commands/ahoy-docker.md) + - [ahoy docker mailhog-url](humpback-commands/ahoy-docker-mailhog-url.md) + - [ahoy docker share-url](humpback-commands/ahoy-docker-share-url.md) + - [ahoy docker url](humpback-commands/ahoy-docker-url.md) + - [ahoy docker vnc-url](humpback-commands/ahoy-docker-vnc-url.md) + - [ahoy docker varnish-url](humpback-commands/ahoy-docker-varnish-url.md) + - [Gulp commands](humpback-commands/gulp-commands.md) - Toolset details: - [Nginx](tool-set-details/nginx.md) - [Mailhog](tool-set-details/mailhog.md) diff --git a/mkdocs.yml b/mkdocs.yml index 5d6c791..e22c9ef 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -22,21 +22,23 @@ pages: - Developing for humpback: - Using your local version of the Humpback generator: developing-for-humpback/using-your-local-version-of-the-generator.md - Humpback commands: - - ahoy up: humpback-commands/ahoy-up.md - - ahoy stop: humpback-commands/ahoy-stop.md - - ahoy down: humpback-commands/ahoy-down.md - - ahoy composer: humpback-commands/ahoy-composer.md - - ahoy help: humpback-commands/ahoy-help.md - - ahoy site: humpback-commands/ahoy-site.md - - ahoy site install: humpback-commands/ahoy-site-install.md - - ahoy drush: humpback-commands/ahoy-drush.md - - ahoy bash: humpback-commands/ahoy-bash.md - - ahoy docker: humpback-commands/ahoy-docker.md - - ahoy docker mailhog-url: humpback-commands/ahoy-docker-mailhog-url.md - - ahoy docker share-url: humpback-commands/ahoy-docker-share-url.md - - ahoy docker url: humpback-commands/ahoy-docker-url.md - - ahoy docker vnc-url: humpback-commands/ahoy-docker-vnc-url.md - - ahoy docker varnish-url: humpback-commands/ahoy-docker-varnish-url.md + - Ahoy commands: + - ahoy up: humpback-commands/ahoy-up.md + - ahoy stop: humpback-commands/ahoy-stop.md + - ahoy down: humpback-commands/ahoy-down.md + - ahoy composer: humpback-commands/ahoy-composer.md + - ahoy help: humpback-commands/ahoy-help.md + - ahoy site: humpback-commands/ahoy-site.md + - ahoy site install: humpback-commands/ahoy-site-install.md + - ahoy drush: humpback-commands/ahoy-drush.md + - ahoy bash: humpback-commands/ahoy-bash.md + - ahoy docker: humpback-commands/ahoy-docker.md + - ahoy docker mailhog-url: humpback-commands/ahoy-docker-mailhog-url.md + - ahoy docker share-url: humpback-commands/ahoy-docker-share-url.md + - ahoy docker url: humpback-commands/ahoy-docker-url.md + - ahoy docker vnc-url: humpback-commands/ahoy-docker-vnc-url.md + - ahoy docker varnish-url: humpback-commands/ahoy-docker-varnish-url.md + - Gulp commands: humpback-commands/gulp-commands.md - Toolset details: - Nginx: tool-set-details/nginx.md - Mailhog: tool-set-details/mailhog.md From 351be41021a952e83e126fdd2b7b5a59ae8a9167 Mon Sep 17 00:00:00 2001 From: Dharizza Espinach B Date: Thu, 25 Oct 2018 18:54:45 -0600 Subject: [PATCH 3/3] Improve commands listing. --- docs/index.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/index.md b/docs/index.md index e4df7b0..9575f00 100644 --- a/docs/index.md +++ b/docs/index.md @@ -24,21 +24,21 @@ This is the official documentation for the Humpback tool. - [Using your local version of the Humpback generator](developing-for-humpback/using-your-local-version-of-the-generator.md) - Humpback commands: - Ahoy commands: - - [ahoy up](humpback-commands/ahoy-up.md) - - [ahoy stop](humpback-commands/ahoy-stop.md) - - [ahoy down](humpback-commands/ahoy-down.md) - - [ahoy site](humpback-commands/ahoy-site.md) - - [ahoy site install](humpback-commands/ahoy-site-install.md) - - [ahoy composer](humpback-commands/ahoy-composer.md) - - [ahoy help](humpback-commands/ahoy-help.md) - - [ahoy drush](humpback-commands/ahoy-drush.md) - - [ahoy bash](humpback-commands/ahoy-bash.md) - - [ahoy docker](humpback-commands/ahoy-docker.md) - - [ahoy docker mailhog-url](humpback-commands/ahoy-docker-mailhog-url.md) - - [ahoy docker share-url](humpback-commands/ahoy-docker-share-url.md) - - [ahoy docker url](humpback-commands/ahoy-docker-url.md) - - [ahoy docker vnc-url](humpback-commands/ahoy-docker-vnc-url.md) - - [ahoy docker varnish-url](humpback-commands/ahoy-docker-varnish-url.md) + - [ahoy up](humpback-commands/ahoy-up.md) + - [ahoy stop](humpback-commands/ahoy-stop.md) + - [ahoy down](humpback-commands/ahoy-down.md) + - [ahoy site](humpback-commands/ahoy-site.md) + - [ahoy site install](humpback-commands/ahoy-site-install.md) + - [ahoy composer](humpback-commands/ahoy-composer.md) + - [ahoy help](humpback-commands/ahoy-help.md) + - [ahoy drush](humpback-commands/ahoy-drush.md) + - [ahoy bash](humpback-commands/ahoy-bash.md) + - [ahoy docker](humpback-commands/ahoy-docker.md) + - [ahoy docker mailhog-url](humpback-commands/ahoy-docker-mailhog-url.md) + - [ahoy docker share-url](humpback-commands/ahoy-docker-share-url.md) + - [ahoy docker url](humpback-commands/ahoy-docker-url.md) + - [ahoy docker vnc-url](humpback-commands/ahoy-docker-vnc-url.md) + - [ahoy docker varnish-url](humpback-commands/ahoy-docker-varnish-url.md) - [Gulp commands](humpback-commands/gulp-commands.md) - Toolset details: - [Nginx](tool-set-details/nginx.md)