Skip to content

Commit 937f72b

Browse files
alexeykostevichsivakumar-kailasam
authored andcommitted
Update README.md
1 parent fc205d1 commit 937f72b

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,28 @@ tmp
3030
You can generate docs from your local copies of [emberjs/ember.js](https://github.com/emberjs/ember.js/) and [emberjs/data](https://github.com/emberjs/data) repositories and serve them locally as [JSON:API](http://jsonapi.org/).
3131

3232
```bash
33-
# Clone Ember.js and Ember Data repositories.
33+
# Clone Ember.js and Ember Data repositories into the same root folder.
3434
git clone https://github.com/emberjs/ember.js/
3535
git clone https://github.com/emberjs/data
3636

37-
# Clone the repository into the same root folder.
37+
# Clone this repository into the same root folder.
3838
git clone https://github.com/ember-learn/ember-jsonapi-docs
3939
cd ember-jsonapi-docs
4040

4141
# Install the dependencies.
4242
yarn
4343

44-
# Generate docs for a particular project/release.
44+
# Generate docs for a particular project from its local repository.
45+
# Version should match the one in `package.json` of a target project.
4546
yarn gen --project ember --version 3.17.0
4647
yarn gen --project ember-data --version 3.17.0
4748

4849
# Run API locally.
4950
yarn serve
5051
```
5152

53+
> ℹ️ **NOTE:** `--version` should match the one in the `package.json` of a target Ember project. If `package.json` uses a release name (e.g. `beta` or `canary`), omit it and use only numbers. For example, if the `package.json` says `3.19.0-beta.2`, use `3.19.0`.
54+
5255
> **TIP:** If you are debugging failed builds, periodically clear out the contents of the `tmp` directory, and run the script again. Past failed runs can cause subsequent runs to fail in unexpected ways.
5356
5457
### Generate Docs from YUIDoc Files Stored in AWS
@@ -83,6 +86,8 @@ yarn start --project ember-data --version 3.17.0
8386
yarn serve
8487
```
8588

89+
> ℹ️ **NOTE:** If docs for a particular version are missing in `s3://api-docs.emberjs.com`, the tool downloads them from npm (e.g. https://unpkg.com/[email protected]/docs/data.json) as a fallback.
90+
8691
## Overriding a specific version of YUIDoc file with a local copy (for core contributors).
8792

8893
To proceed, you need AWS Access Keys to publish to [api-docs.emberjs.com](http://api-docs.emberjs.com/) and all necessary environemnt variables set.

0 commit comments

Comments
 (0)