|
30 | 30 | 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/).
|
31 | 31 |
|
32 | 32 | ```bash
|
33 |
| -# Clone Ember.js and Ember Data repositories. |
| 33 | +# Clone Ember.js and Ember Data repositories into the same root folder. |
34 | 34 | git clone https://github.com/emberjs/ember.js/
|
35 | 35 | git clone https://github.com/emberjs/data
|
36 | 36 |
|
37 |
| -# Clone the repository into the same root folder. |
| 37 | +# Clone this repository into the same root folder. |
38 | 38 | git clone https://github.com/ember-learn/ember-jsonapi-docs
|
39 | 39 | cd ember-jsonapi-docs
|
40 | 40 |
|
41 | 41 | # Install the dependencies.
|
42 | 42 | yarn
|
43 | 43 |
|
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. |
45 | 46 | yarn gen --project ember --version 3.17.0
|
46 | 47 | yarn gen --project ember-data --version 3.17.0
|
47 | 48 |
|
48 | 49 | # Run API locally.
|
49 | 50 | yarn serve
|
50 | 51 | ```
|
51 | 52 |
|
| 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 | +
|
52 | 55 | > ✅ **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.
|
53 | 56 |
|
54 | 57 | ### Generate Docs from YUIDoc Files Stored in AWS
|
@@ -83,6 +86,8 @@ yarn start --project ember-data --version 3.17.0
|
83 | 86 | yarn serve
|
84 | 87 | ```
|
85 | 88 |
|
| 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 | +
|
86 | 91 | ## Overriding a specific version of YUIDoc file with a local copy (for core contributors).
|
87 | 92 |
|
88 | 93 | 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