Updating BLT README template to include more basic info. #2735
Conversation
template/README.md
Outdated
| * Local environment: DrupalVM | ||
| * Local drush alias: @my-project.local | ||
| * Local site URL: http://local.my-project.com | ||
| * Ensure that your computer meets the minimum installation requirements (and then install the required applications). See the [System Requirements](http://blt.readthedocs.io/en/8.x/INSTALL/). |
f6c2b14 to
00a00d2
Compare
template/README.md
Outdated
| ``` | ||
| $ git clone git@github.com:<account>/<project>.git | ||
| ``` | ||
| * Add the parent repository as an upstream |
There was a problem hiding this comment.
Wouldn't this already be done by the git clone?
There was a problem hiding this comment.
will make this clearer in regards to origin == fork and upstream == original repository
template/README.md
Outdated
| ``` | ||
| * Setup Local Environment | ||
|
|
||
| Note: Drupal VM is OPTIONAL but templated within BLT. If using Drupal VM, BLT 9 assumes all commands are run INSIDE the VM (this is a change from BLT 8). |
There was a problem hiding this comment.
I would link to http://blt.readthedocs.io/en/9.x/readme/local-development/#using-drupal-vm-for-blt-generated-projects, which lists system level requirements for using Drupal VM.
There was a problem hiding this comment.
good call, we can then also include other locals in the future as/if we begin supporting them.
template/README.md
Outdated
| * Access the site and do necessary work at \<project local url> by running | ||
|
|
||
| ``` | ||
| $ drush @<project>.local uli |
There was a problem hiding this comment.
We're trying to move away from using drush aliases for the VM. This also assumes that drush is globally installed.
template/README.md
Outdated
| Note the following properties of this project: | ||
| * Primary development branch: \<branch> | ||
| * Local environment: \<local environment> | ||
| * Local drush alias: @\<project>.local |
There was a problem hiding this comment.
Again, I wouldn't use a local drush alias.
template/README.md
Outdated
| * Local drush alias: @\<project>.local | ||
| * Local site URL: \<project local url> | ||
|
|
||
| ## Working With a BLT Project |
There was a problem hiding this comment.
This doesn't feel like it belongs in a read me. Isn't this type of information in the onboarding doc?
There was a problem hiding this comment.
@grasmash this level of specificity is NOT in the onboarding doc, but i'm happy to link to that in this section instead and move this detail over. i think it needs to be in our docs "somewhere" but could be convinced that "here" isn't the right place.
452df96 to
150ccbb
Compare
|
@grasmash this should be ready for another review, i addressed all previous comments |
c782ace to
f9d2c98
Compare
…g with BLT + Git.
f9d2c98 to
d375486
Compare
Changes proposed: