Skip to content

Commit 78a9363

Browse files
committed
address doc review feedback
1 parent 8da9835 commit 78a9363

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

CHANGELOG.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66

77
### Significant changes
88

9-
Validation information is now exposed as a dict at the /api/bookstore endpoint.
9+
Validation information is now exposed as a dict at the `/api/bookstore` endpoint.
1010

1111
This allows us to distinguish whether different features have been enabled on bookstore.
1212

13-
The structure now is
13+
The structure for 2.3.0 is:
1414

1515
```python
1616
validation_checks = {
@@ -19,6 +19,7 @@ The structure now is
1919
"publish_valid": all(published_settings),
2020
}
2121
```
22+
2223
## Releases prior to 2.3.0
2324

2425
[2.2.1 (2019-02-03)](https://github.com/nteract/bookstore/releases/tag/2.2.1)

CONTRIBUTING.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Good commit messages serve at least three important purposes:
6161

6262
Structure your commit message like this:
6363

64-
```
64+
```text
6565
> Short (50 chars or less) summary of changes
6666
>
6767
> More detailed explanatory text, if necessary. Wrap it to about 72
@@ -79,7 +79,8 @@ Structure your commit message like this:
7979
> single space, with blank lines in between, but conventions vary here
8080
>
8181
```
82-
*Source: http://git-scm.com/book/ch5-2.html*
82+
83+
*Source:* https://git-scm.com/book/ch5-2.html
8384

8485
### DO
8586

running_ci_locally.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,9 @@ To run the ci tests locally, you will need to have a few things set up:
2323
1. Open two terminals with the current working directory as the root `bookstore`
2424
directory.
2525

26-
2. In one terminal run `ci/local.sh`. This will start up minio.
26+
2. In one terminal run `yarn test:server`. This will start up minio.
2727

28-
3. In the other terminal run `node ci/integration.js`. This will run the
29-
integration tests
28+
3. In the other terminal run `yarn test`. This will run the integration tests.
3029

3130
## Interactive python tests
3231

@@ -43,7 +42,7 @@ It's often difficult to judge whether what is being served makes sense from a UI
4342
without being able to investigate it directly. At the same time we'll need to access it as an
4443
API to ensure that the responses are well-behaved from an API standpoint. By using python to
4544
query a live server and a browser to visit the landing page, we can rapidly iterate between
46-
the API and UI contexts from the same live server's endpoint.
45+
the API and UI contexts from the same live server's endpoint.
4746

4847
We provide examples of `jupyter notebook` commands needed in that file as well for both
4948
accessing the `nteract-notebooks` S3 bucket as well as the Minio provided `bookstore` bucket

0 commit comments

Comments
 (0)