Skip to content

Clarify README #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 10, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ Then, in `ember.js` and/or `ember-data` repositories, check out the version
tags you want to generate docs for. For example:

```sh
cd ../ember.js
get fetch --all
git checkout v5.2.0

AND/OR

cd ../data
get fetch --all
git checkout v5.2.0
```
Expand All @@ -37,29 +44,29 @@ Generate the JSON docs for `ember` and/or `ember-data`. This will add new JSON
files into the `s3-docs` directory of `ember-api-docs-data`:

```sh
cd ../ember-jsonapi-docs
yarn
yarn gen --project ember --version "5.2.0"
```

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

```sh
cd ../ember-api-docs-data/
git add .
git commit -m "add docs for ember v5.2.0"
```

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

```sh
node ./clean-urls.js
node ./fix-rev-index.js
npm run fix:files
git add .
git commit -m "fix urls and rev-index for ember"
```

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`
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`

```sh
npm i
Expand Down Expand Up @@ -88,8 +95,7 @@ cd ../ember-api-docs-data
git add .
git commit -m "add docs for ember-data v5.2.0"

node ./clean-urls.js
node ./fix-rev-index.js
npm run fix:files
git add .
git commit -m "fix urls and rev-index for ember-data"

Expand Down