Skip to content

Commit 74dfca4

Browse files
author
Alan Kent
committed
Clarified some headings to indicate which sections were optional.
1 parent 6786b5e commit 74dfca4

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -172,15 +172,15 @@ different `auth.json` file per project, move the `auth.json` file into your
172172
project's home directory. Most people add this file to their `.gitignore` file
173173
to help restrict access to the download keys.
174174

175-
**Existing Project**
175+
**Option 1: Existing Project**
176176

177177
If you have an existing project with all the source code already under
178178
`shared/www` on your laptop, no additional configuration is needed. If you use
179179
volume mounting, the code will automatically be visible; if you use Unison,
180180
Unison will copy files on your laptop into the web container when it is
181181
started.
182182

183-
**Creating a New Project with Composer**
183+
**Option 2: Creating a New Project with Composer**
184184

185185
Log into the web container.
186186

@@ -197,7 +197,7 @@ down Composer.)
197197
composer create-project --repository=https://repo.magento.com/ magento/project-community-edition:2.1.8 .
198198
chmod +x bin/magento
199199

200-
**Getting Code from a GitHub Project**
200+
**Option 3: Getting Code from a GitHub Project**
201201

202202
It is strongly recommended to saving your project code in a private git
203203
repository on a hosting provider such as GitHub or BitBucket. The following
@@ -216,7 +216,7 @@ Check out the project from inside the container into the `magento2` directory.
216216
xdebug-off
217217
composer install
218218

219-
**Magento Commerce (Cloud)**
219+
**Option 4: Magento Commerce (Cloud)**
220220

221221
TODO: WARNING: THIS SECTION IS NOT COMPLETE.
222222

@@ -253,7 +253,7 @@ above. `magento-cloud build` runs the `composer install` and patching command,
253253
but also runs additional commands (such as `di-compile`) which you may not want
254254
to run during development.
255255

256-
**Internal Development**
256+
**Option 5: Internal Development**
257257

258258
TODO: THIS SECTION IS INDICATIVE OF FUTURE DIRECTION, NOT SUPPORTED YET.
259259

@@ -328,7 +328,7 @@ be added when the project was created above.
328328

329329
--amqp-virtualhost=/ --ampq-host=ampq --amqp-port=TODO --amqp-user=guest --amqp-password=guest
330330

331-
**Loading Optional Sample Data**
331+
**Loading Sample Data (Optional)**
332332

333333
To download the Luma sample data, you may need to provide Composer
334334
authentication details. If you already have a `~/.composer/auth.json` file you
@@ -353,7 +353,7 @@ purposes, but makes all PHP scripts slower to execute.
353353
magento deploy:mode:set developer
354354
xdebug-on
355355

356-
### 7. Start Unison, if Needed
356+
### 7. Start Unison (Mac, Windows)
357357

358358
If you are using Unison for file syncing, you also need to start up a Unison
359359
process (and keep it running). It is generally recommended to start this up
@@ -379,7 +379,7 @@ Each time you log in, make sure you restart Unison, but be careful to not have
379379
multiple copies running in parallel. It is not recommended to do significant
380380
work on the project without Unison running to avoid merge conflicts (rare).
381381

382-
### 8. Cron
382+
### 8. Cron (Optional)
383383

384384
Cron is disabled by default. Running cron may result in faster draining of
385385
laptop batteries. To manually trigger background index updates, run `magento
@@ -390,8 +390,6 @@ second cron to run).
390390
magento cron:run
391391
magento cron:run
392392

393-
TODO: VERIFY TWO RUNS ARE NEEDED FIRST TIME ONLY. IF SO, CAN SIMPLIFY HERE.
394-
395393
To enable cron permanently run the following shell script.
396394

397395
cron-install
@@ -421,7 +419,7 @@ Be aware that in developer mode the slower PHP debug mode is on and missing
421419
CSS and similar files are created on demand. This means the first time you
422420
load a page you will see significantly longer load times.
423421

424-
### 10. Configure PHP Storm (if appropriate)
422+
### 10. Configure PHP Storm (Optional)
425423

426424
TODO: WARNING: THIS SECTION IS NOT COMPLETE.
427425

@@ -470,7 +468,7 @@ completed.
470468
8. Select "Tools" / "SSH Terminal", and select the "Default Remote
471469
Interpreter" radio button.
472470

473-
### 11. Varnish Configuration
471+
### 11. Varnish Configuration (Optional)
474472

475473
TODO: WARNING: THIS SECTION IS NOT COMPLETE.
476474

@@ -490,7 +488,7 @@ number, use
490488

491489
docker-compose port varnish 6081
492490

493-
### 12. Redis Configuration
491+
### 12. Redis Configuration (Optional)
494492

495493
Uncomment the Redis service in the `docker-compose.yml` if you wish to use
496494
Redis during development, keeping your local development environment closer to
@@ -516,7 +514,9 @@ To turn on usage of Redis for page caching (not needed if using Varnish), run
516514

517515
magento setup:config:set --page-cache=redis --page-cache-redis-server=redis --page-cache-redis-db=2
518516

519-
### 13. Grunt and Gulp Configuration
517+
### 13. ElasticSearch Configuration (Optional)
518+
### 14. ElasticSearch Configuration (Optional)
519+
### 15. Grunt and Gulp Configuration (Optional)
520520

521521
Grunt and Gulp are both frontend tool chains to speed up frontend development.
522522
They can both auto-recompile CSS files as soon as a file is written to disk.

0 commit comments

Comments
 (0)