Skip to content

Commit 8a34672

Browse files
fix linting issues in readme
1 parent e89287d commit 8a34672

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,24 @@ The script pulls yuidoc build output from all Ember versions from Amazon S3, con
1111

1212
## Running the app
1313

14-
1. Fork/Clone [ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs)
15-
1. Run `yarn`
16-
1. Install the [aws cli](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html)
17-
1. Set up AWS access
14+
1. Fork/Clone [ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs)
15+
1. Run `yarn`
16+
1. Install the [aws cli](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html)
17+
1. Set up AWS access
1818

19-
```shell
20-
export AWS_ACCESS_KEY_ID=xxxxxx
21-
export AWS_SECRET_ACCESS_KEY=xxxxx
22-
```
19+
```shell
20+
export AWS_ACCESS_KEY_ID=xxxxxx
21+
export AWS_SECRET_ACCESS_KEY=xxxxx
22+
```
2323

24-
The app accesses builds.emberjs.com (an Amazon S3 bucket) in read-only mode, which is public. This requires any valid AWS credentials.
24+
The app accesses builds.emberjs.com (an Amazon S3 bucket) in read-only mode, which is public. This requires any valid AWS credentials.
2525

26-
You can get your credentials by logging into your [AWS console](https://console.aws.amazon.com) and navigating to "_My Security Credentials_" under your profile name. You can generate a new pair under the "_Access Keys (Access Key ID and Secret Access Key)_" section.
26+
You can get your credentials by logging into your [AWS console](https://console.aws.amazon.com) and navigating to "_My Security Credentials_" under your profile name. You can generate a new pair under the "_Access Keys (Access Key ID and Secret Access Key)_" section.
2727

28-
1. To test your changes in the app run,
29-
`yarn start`
30-
The app tries to process all ember & ember-data versions since 1.0 which takes high memory & time to complete. If you intend it, then run `yarn start --max_old_space_size=8192`.
31-
You are setting your node max heap space to 8GB, so make sure you have that much space available on your machine.
28+
1. To test your changes in the app run,
29+
`yarn start`
30+
The app tries to process all ember & ember-data versions since 1.0 which takes high memory & time to complete. If you intend it, then run `yarn start --max_old_space_size=8192`.
31+
You are setting your node max heap space to 8GB, so make sure you have that much space available on your machine.
3232

3333
## To Generate docs for a specific project and/or version for development
3434

@@ -50,16 +50,16 @@ You need an additional flag `AWS_SHOULD_PUBLISH=true` for publishing the docs.
5050
These steps are only necessary if you are trying to run the ember-api-docs
5151
app with documentation pulled from a local copy of ember.js.
5252

53-
1. Clone the following 4 repositories into a single parent directory. Install dependencies for each app as described in their respective `README` files.
54-
- [ember.js](https://github.com/emberjs/ember.js)
55-
- [data (ember data)](https://github.com/emberjs/data)
56-
- [ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs)
57-
- [ember-api-docs](https://github.com/ember-learn/ember-api-docs)
58-
1. Set up the project according to the instructions above in `Running the app`.
59-
1. From the `ember-jsonapi-docs` directory, run `yarn gen --project ember --version 2.18.0`. This command runs the Ember documentation build, generates jsonapi output, copies it to the `ember-api-docs` directory & runs this app. To build ember data documentation, run `yarn gen --project ember-data --version 2.18.0`.
60-
- 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.\_
61-
1. Run `yarn server` in this app to serve the content locally.
62-
1. Run the API app with the newly generated local data by running `yarn server` in this app & then run `yarn start:local` in the `ember-api-docs` directory.
53+
1. Clone the following 4 repositories into a single parent directory. Install dependencies for each app as described in their respective `README` files.
54+
- [ember.js](https://github.com/emberjs/ember.js)
55+
- [data (ember data)](https://github.com/emberjs/data)
56+
- [ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs)
57+
- [ember-api-docs](https://github.com/ember-learn/ember-api-docs)
58+
1. Set up the project according to the instructions above in `Running the app`.
59+
1. From the `ember-jsonapi-docs` directory, run `yarn gen --project ember --version 2.18.0`. This command runs the Ember documentation build, generates jsonapi output, copies it to the `ember-api-docs` directory & runs this app. To build ember data documentation, run `yarn gen --project ember-data --version 2.18.0`.
60+
- 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.
61+
1. Run `yarn server` in this app to serve the content locally.
62+
1. Run the API app with the newly generated local data by running `yarn server` in this app & then run `yarn start:local` in the `ember-api-docs` directory.
6363

6464
## Backing up docs before running major migrations
6565

0 commit comments

Comments
 (0)