Skip to content

Commit 31bf49a

Browse files
authored
Clarify README
- this updates the README to be more explicit so that any one following the release steps is the handbook can perform the steps described in this README without issues
1 parent e8741c5 commit 31bf49a

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

Diff for: README.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ Then, in `ember.js` and/or `ember-data` repositories, check out the version
2929
tags you want to generate docs for. For example:
3030

3131
```sh
32+
cd ../ember.js
33+
get fetch --all
34+
git checkout v5.2.0
35+
36+
AND/OR
37+
38+
cd ../data
3239
get fetch --all
3340
git checkout v5.2.0
3441
```
@@ -37,29 +44,29 @@ Generate the JSON docs for `ember` and/or `ember-data`. This will add new JSON
3744
files into the `s3-docs` directory of `ember-api-docs-data`:
3845

3946
```sh
47+
cd ../ember-jsonapi-docs
4048
yarn
4149
yarn gen --project ember --version "5.2.0"
4250
```
4351

44-
I would recommend committing at this stage so that you can see that the following steps work.
52+
I would recommend committing in ember-api-docs-data at this stage so that you can see that the following steps work.
4553

4654
```sh
4755
cd ../ember-api-docs-data/
4856
git add .
4957
git commit -m "add docs for ember v5.2.0"
5058
```
5159

52-
Next we need to fix the generated files. (Note: this step could probably be incorporated into ember-jsonapi-docs
60+
Next, we need to fix the generated files in ember-api-docs-data. (Note: this step could probably be incorporated into ember-jsonapi-docs
5361
but for now this step works).
5462

5563
```sh
56-
node ./clean-urls.js
57-
node ./fix-rev-index.js
64+
npm run fix:files
5865
git add .
5966
git commit -m "fix urls and rev-index for ember"
6067
```
6168

62-
Lastly we need to make sure that each of the new files are valid. You need to run the test suite in `ember-api-docs-data`
69+
Lastly, we need to make sure that each of the new files are valid. You need to run the test suite in `ember-api-docs-data`
6370

6471
```sh
6572
npm i
@@ -88,8 +95,7 @@ cd ../ember-api-docs-data
8895
git add .
8996
git commit -m "add docs for ember-data v5.2.0"
9097

91-
node ./clean-urls.js
92-
node ./fix-rev-index.js
98+
npm run fix:files
9399
git add .
94100
git commit -m "fix urls and rev-index for ember-data"
95101

0 commit comments

Comments
 (0)