From d69f1fc28f7eaaa644004fd8b20ac0dbfbb5c4c6 Mon Sep 17 00:00:00 2001 From: TravisCarden Date: Tue, 7 Aug 2018 11:14:48 -0500 Subject: [PATCH 1/5] Fixed some broken Markdown in template/README.md. --- template/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/template/README.md b/template/README.md index f1c5cece4..2c927fbd6 100644 --- a/template/README.md +++ b/template/README.md @@ -44,7 +44,7 @@ $ composer install BLT requires "some sort" of local environment that implements a LAMP stack. While we provide out of the box templates for Drupal VM, if you prefer you can use another tool such as Docker, Docksal, Lando, (other) Vagrant, or your own custom LAMP stack. BLT works with any local environment, however support is limited for these solutions. -For instructions on setting up Drupal VM, (read our documentation here)[http://blt.readthedocs.io/en/9.x/readme/local-development/#using-drupal-vm-for-blt-generated-projects]. +For instructions on setting up Drupal VM, [read our documentation here](http://blt.readthedocs.io/en/9.x/readme/local-development/#using-drupal-vm-for-blt-generated-projects). * Run the initial Setup ``` @@ -71,7 +71,7 @@ Note the following properties of this project: BLT projects are designed to instill software development best practices (including git workflows). -Our BLT Developer documentation includes an (example workflow)[http://blt.readthedocs.io/en/latest/readme/dev-workflow/#workflow-example-local-development]. +Our BLT Developer documentation includes an [example workflow](http://blt.readthedocs.io/en/latest/readme/dev-workflow/#workflow-example-local-development). ### Important Configuration Files From 28407178468a8170df22acae62b73f2bb54f83cb Mon Sep 17 00:00:00 2001 From: TravisCarden Date: Tue, 7 Aug 2018 11:14:08 -0500 Subject: [PATCH 2/5] Clarified and made more consistent use of placeholders. --- template/README.md | 41 ++++++++++++++++++++++------------------- 1 file changed, 22 insertions(+), 19 deletions(-) diff --git a/template/README.md b/template/README.md index 2c927fbd6..8fa946543 100644 --- a/template/README.md +++ b/template/README.md @@ -6,15 +6,18 @@ A brief description of My Project. Remove this section after initial setup! -Search for and replace the following placeholders: - -* \ -* \ -* \ -* \ -* \ -* \ -* \ +Search for and replace the following placeholders within this file: + +| Placeholder | Example | +| --- | --- | +| `#ACQUIA_CLOUD_URL` | https://cloud.acquia.com/app/develop/applications/12345678-1234-1234-12345678901234567 | +| `#GIT_PRIMARY_DEV_BRANCH` | `master` or `develop` | +| `#GITHUB_ORG` | The "org" in https://github.com/org/project | +| `#GITHUB_PROJECT` | The "project" in https://github.com/org/project | +| `#JIRA_URL` | https://org.atlassian.net/projects/PROJ | +| `#LOCAL_DEV_SITE_ALIAS` | `@example.local` | +| `#LOCAL_DEV_URL` | http://local.example.com/ | +| `#TRAVIS_URL` | https://travis-ci.com/org/PROJ | ## Getting Started @@ -30,11 +33,11 @@ This project is based on BLT, an open-source project template and tool that enab * [Setup Acquia Cloud SSH Keys](https://docs.acquia.com/acquia-cloud/ssh/generate) * Clone your forked repository. By default, Git names this "origin" on your local. ``` -$ git clone git@github.com:/.git +$ git clone git@github.com:/#GITHUB_PROJECT.git ``` * To ensure that upstream changes to the parent repository may be tracked, add the upstream locally as well. ``` -$ git remote add upstream git@github.com:/.git +$ git remote add upstream git@github.com:#GITHUB_ORG/#GITHUB_PROJECT.git ``` * Install Composer Dependencies (warning: this can take some time based on internet speeds) ``` @@ -51,7 +54,7 @@ For instructions on setting up Drupal VM, [read our documentation here](http://b $ vagrant ssh $ blt setup ``` -* Access the site and do necessary work at \ by running +* Access the site and do necessary work at #LOCAL_DEV_URL by running ``` $ drush uli @@ -63,9 +66,9 @@ $ blt ``` Note the following properties of this project: -* Primary development branch: \ -* Local environment: \ -* Local site URL: \ +* Primary development branch: #GIT_PRIMARY_DEV_BRANCH +* Local environment: #LOCAL_DEV_SITE_ALIAS +* Local site URL: #LOCAL_DEV_URL ## Working With a BLT Project @@ -85,7 +88,7 @@ BLT uses a number of configuration (.yml or .json) files to define and customize ## Resources -* JIRA - \ -* GitHub - \ -* Acquia Cloud subscription - \ -* TravisCI - \ +* JIRA - #JIRA_URL +* GitHub - https://github.com/#GITHUB_ORG/#GITHUB_PROJECT +* Acquia Cloud subscription - #ACQUIA_CLOUD_URL +* TravisCI - #TRAVIS_URL From 27d7926d06fe42fdc354a57ec3796c51f646d69d Mon Sep 17 00:00:00 2001 From: TravisCarden Date: Tue, 7 Aug 2018 12:30:37 -0500 Subject: [PATCH 3/5] Fixed incorrect and inconsistent indentation. --- template/README.md | 39 +++++++++++++++++++-------------------- 1 file changed, 19 insertions(+), 20 deletions(-) diff --git a/template/README.md b/template/README.md index 8fa946543..2f760be78 100644 --- a/template/README.md +++ b/template/README.md @@ -32,33 +32,32 @@ This project is based on BLT, an open-source project template and tool that enab * [Setup GitHub SSH Keys](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/) * [Setup Acquia Cloud SSH Keys](https://docs.acquia.com/acquia-cloud/ssh/generate) * Clone your forked repository. By default, Git names this "origin" on your local. -``` -$ git clone git@github.com:/#GITHUB_PROJECT.git -``` + ``` + $ git clone git@github.com:/#GITHUB_PROJECT.git + ``` * To ensure that upstream changes to the parent repository may be tracked, add the upstream locally as well. -``` -$ git remote add upstream git@github.com:#GITHUB_ORG/#GITHUB_PROJECT.git -``` + ``` + $ git remote add upstream git@github.com:#GITHUB_ORG/#GITHUB_PROJECT.git + ``` * Install Composer Dependencies (warning: this can take some time based on internet speeds) -``` -$ composer install -``` + ``` + $ composer install + ``` * Setup Local Environment -BLT requires "some sort" of local environment that implements a LAMP stack. While we provide out of the box templates for Drupal VM, if you prefer you can use another tool such as Docker, Docksal, Lando, (other) Vagrant, or your own custom LAMP stack. BLT works with any local environment, however support is limited for these solutions. - -For instructions on setting up Drupal VM, [read our documentation here](http://blt.readthedocs.io/en/9.x/readme/local-development/#using-drupal-vm-for-blt-generated-projects). + BLT requires "some sort" of local environment that implements a LAMP stack. While we provide out of the box templates for Drupal VM, if you prefer you can use another tool such as Docker, Docksal, Lando, (other) Vagrant, or your own custom LAMP stack. BLT works with any local environment, however support is limited for these solutions. + + For instructions on setting up Drupal VM, [read our documentation here](http://blt.readthedocs.io/en/9.x/readme/local-development/#using-drupal-vm-for-blt-generated-projects). * Run the initial Setup -``` -$ vagrant ssh -$ blt setup -``` + ``` + $ vagrant ssh + $ blt setup + ``` * Access the site and do necessary work at #LOCAL_DEV_URL by running - -``` -$ drush uli -``` + ``` + $ drush uli + ``` Additional [BLT documentation](http://blt.readthedocs.io) may be useful. You may also access a list of BLT commands by running: ``` From 177749830555c92836166ecad6f6155dac24ea5f Mon Sep 17 00:00:00 2001 From: TravisCarden Date: Tue, 7 Aug 2018 12:36:51 -0500 Subject: [PATCH 4/5] Changed bullets to numbers (as ordered lists ought to use) and normalized punctuation. --- template/README.md | 73 +++++++++++++++++++++++----------------------- 1 file changed, 36 insertions(+), 37 deletions(-) diff --git a/template/README.md b/template/README.md index 2f760be78..3b8ff97cc 100644 --- a/template/README.md +++ b/template/README.md @@ -23,43 +23,42 @@ Search for and replace the following placeholders within this file: This project is based on BLT, an open-source project template and tool that enables building, testing, and deploying Drupal installations following Acquia Professional Services best practices. While this is one of many methodologies, it is our recommended methodology. -* Review the [Required / Recommended Skills](http://blt.readthedocs.io/en/latest/readme/skills) for working with a BLT project -* Ensure that your computer meets the minimum installation requirements (and then install the required applications). See the [System Requirements](http://blt.readthedocs.io/en/latest/INSTALL/#system-requirements). -* Request access to organization that owns the project repo in GitHub (if needed) -* Fork the project repository in GitHub -* Request access to the Acquia Cloud Environment for your project (if needed) -* Setup a SSH key that can be used for GitHub and the Acquia Cloud (you CAN use the same key) - * [Setup GitHub SSH Keys](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/) - * [Setup Acquia Cloud SSH Keys](https://docs.acquia.com/acquia-cloud/ssh/generate) -* Clone your forked repository. By default, Git names this "origin" on your local. - ``` - $ git clone git@github.com:/#GITHUB_PROJECT.git - ``` -* To ensure that upstream changes to the parent repository may be tracked, add the upstream locally as well. - ``` - $ git remote add upstream git@github.com:#GITHUB_ORG/#GITHUB_PROJECT.git - ``` -* Install Composer Dependencies (warning: this can take some time based on internet speeds) - ``` - $ composer install - ``` -* Setup Local Environment - - BLT requires "some sort" of local environment that implements a LAMP stack. While we provide out of the box templates for Drupal VM, if you prefer you can use another tool such as Docker, Docksal, Lando, (other) Vagrant, or your own custom LAMP stack. BLT works with any local environment, however support is limited for these solutions. - - For instructions on setting up Drupal VM, [read our documentation here](http://blt.readthedocs.io/en/9.x/readme/local-development/#using-drupal-vm-for-blt-generated-projects). - -* Run the initial Setup - ``` - $ vagrant ssh - $ blt setup - ``` -* Access the site and do necessary work at #LOCAL_DEV_URL by running - ``` - $ drush uli - ``` - -Additional [BLT documentation](http://blt.readthedocs.io) may be useful. You may also access a list of BLT commands by running: +1. Review the [Required / Recommended Skills](http://blt.readthedocs.io/en/latest/readme/skills) for working with a BLT project. +1. Ensure that your computer meets the minimum installation requirements (and then install the required applications). See the [System Requirements](http://blt.readthedocs.io/en/latest/INSTALL/#system-requirements). +1. Request access to organization that owns the project repo in GitHub (if needed). +1. Fork the project repository in GitHub. +1. Request access to the Acquia Cloud Environment for your project (if needed). +1. Setup a SSH key that can be used for GitHub and the Acquia Cloud (you CAN use the same key). + 1. [Setup GitHub SSH Keys](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/) + 1. [Setup Acquia Cloud SSH Keys](https://docs.acquia.com/acquia-cloud/ssh/generate) +1. Clone your forked repository. By default, Git names this "origin" on your local. + ``` + $ git clone git@github.com:/#GITHUB_PROJECT.git +1. To ensure that upstream changes to the parent repository may be tracked, add the upstream locally as well. + ``` + $ git remote add upstream git@github.com:#GITHUB_ORG/#GITHUB_PROJECT.git + ``` +1. Install Composer Dependencies. (Warning: this can take some time based on internet speeds.) + ``` + $ composer install + ``` +1. Setup local environment. + + BLT requires "some sort" of local environment that implements a LAMP stack. While we provide out of the box templates for Drupal VM, if you prefer you can use another tool such as Docker, Docksal, Lando, (other) Vagrant, or your own custom LAMP stack. BLT works with any local environment, however support is limited for these solutions. + + For instructions on setting up Drupal VM, [read our documentation here](http://blt.readthedocs.io/en/9.x/readme/local-development/#using-drupal-vm-for-blt-generated-projects). + +1. Run the initial setup: + ``` + $ vagrant ssh + $ blt setup + ``` +1. Access the site and do necessary work at #LOCAL_DEV_URL by running this: + ``` + $ drush uli + ``` + +Additional [BLT documentation](http://blt.readthedocs.io) may be useful. You may also access a list of BLT commands by running this: ``` $ blt ``` From dfe3e7e6b22fa6b4e4f60db6fb0db3cdd29687f5 Mon Sep 17 00:00:00 2001 From: TravisCarden Date: Tue, 7 Aug 2018 11:19:16 -0500 Subject: [PATCH 5/5] Marked up filenames as code. --- template/README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/template/README.md b/template/README.md index 3b8ff97cc..7ed8191f4 100644 --- a/template/README.md +++ b/template/README.md @@ -76,13 +76,13 @@ Our BLT Developer documentation includes an [example workflow](http://blt.readth ### Important Configuration Files -BLT uses a number of configuration (.yml or .json) files to define and customize behaviors. Some examples of these are: +BLT uses a number of configuration (`.yml` or `.json`) files to define and customize behaviors. Some examples of these are: -* blt/blt.yml (formerly blt/project.yml prior to BLT 9.x) -* blt/local.blt.yml -* box/config.yml (if using Drupal VM) -* drush/sites (contains Drush aliases for this project) -* composer.json (includes required components, including Drupal Modules, for this project) +* `blt/blt.yml` (formerly blt/project.yml prior to BLT 9.x) +* `blt/local.blt.yml` +* `box/config.yml` (if using Drupal VM) +* `drush/sites` (contains Drush aliases for this project) +* `composer.json` (includes required components, including Drupal Modules, for this project) ## Resources