8000 Merge pull request #4982 from jbampton/lint-markdown-and-fix-links · plotly/plotly.js@55813e4 · GitHub
[go: up one dir, main page]

Skip to content

Commit 55813e4

Browse files
authored
Merge pull request #4982 from jbampton/lint-markdown-and-fix-links
Lint Markdown. Fix missing HTTPS on links.
2 parents 839b775 + dede459 commit 55813e4

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

test/image/README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
Test plotly.js with Plotly's image testing docker container.
44

55
Requirements:
6+
67
- `docker` | [installation guidelines][docker-install]
78
- `docker-machine` (for Mac and Windows users only) | [installation guidelines][docker-machine-install]
89

@@ -28,7 +29,6 @@ eval $(docker-machine env default)
2829

2930
the above evaluates the output of `docker-machine env default`.
3031

31-
3232
### Step 1: Setup the testing container
3333

3434
After `cd` into your `plotly.js` directory, pull the latest docker image with
@@ -49,7 +49,6 @@ npm run docker -- run
4949
which calls [`docker-run`][docker-run] or [`docker-start`][docker-start] with
5050
the correct arguments.
5151

52-
5352
### Step 2: Run the image tests
5453

5554
The image testing docker container allows plotly.js developers to
@@ -60,7 +59,7 @@ The image testing docker container allows plotly.js developers to
6059
Before starting, don't forget to [set up your testing environment](https://github.com/plotly/plotly.js/blob/master/CONTRIBUTING.md#development):
6160

6261
```bash
63-
$ npm run pretest
62+
npm run pretest
6463
```
6564

6665
**IMPORTANT:** the image tests scripts do **not** bundle the source files before
@@ -91,10 +90,10 @@ For example,
9190

9291
```bash
9392
# Run one test (e.g. the 'contour_nolines' test):
94-
$ npm run test-image -- contour_nolines
93+
npm run test-image -- contour_nolines
9594

9695
# Run all gl3d image tests in batch:
97-
$ npm run test-image -- gl3d_*
96+
npm run test-image -- gl3d_*
9897

9998
# Run all image tests that are not gl3d in batch:
10099
npm run test-image -- "\!\(gl3d_\)*"
@@ -106,7 +105,7 @@ comparison tests in queue (i.e. with no concurrency) is recommended:
106105

107106
```bash
108107
# Run all gl3d image test in queue:
109-
$ npm run test-image -- gl3d_* --queue
108+
npm run test-image -- gl3d_* --queue
110109
```
111110

112111
##### B: Run image export tests
@@ -141,7 +140,6 @@ To update existing baseline image(s), run
141140
npm run baseline -- <glob-of-mocks-to-update>
142141
```
143142

144-
145143
### Step 3: Stop your testing container
146144

147145
Once done testing, inside your `plotly.js` directory, run
@@ -204,11 +202,11 @@ If named `default`:
204202
docker-machine kill default
205203
```
206204

207-
For more comprehensive information about docker, please refer to the [docker docs](http://docs.docker.com/).
205+
For more comprehensive information about docker, please refer to the [docker docs](https://docs.docker.com/).
208206

209207
[mocks]: https://github.com/plotly/plotly.js/tree/master/test/image/mocks
210208
[baselines]: https://github.com/plotly/plotly.js/tree/master/test/image/baselines
211-
[docker-install]: http://docs.docker.com/engine/installation/
209+
[docker-install]: https://docs.docker.com/engine/installation/
212210
[docker-machine-install]: https://docs.docker.com/machine/install-machine/
213211
[docker-hub]: https://hub.docker.com/r/plotly/testbed/tags/
214212
[docker-pull]: https://docs.docker.com/engine/reference/commandline/pull/

0 commit comments

Comments
 (0)
0