Skip to content

Commit

Permalink
docs: fix minor website typos
Browse files Browse the repository at this point in the history
  • Loading branch information
marisademeglio committed Jan 29, 2018
1 parent 94040b5 commit eba12cb
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions website/content/contributing/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ When filing an issue, please provide the following details:
- the version of Ace impacted by the issue (it can be retrieved by running `ace -v` in a command shell).
- the version of Node used to run Ace (it can be retrieved by running `node -v` in a command shell).
- your operating system and version
- if possible, provide the error details as produced in the [logfile]({{<relref "docs/logging.md">}}). Run Ace with the `--verbose` option to produce a detailed log.
- if possible, provide the error details as produced in the [log file]({{<relref "docs/logging.md">}}). Run Ace with the `--verbose` option to produce a detailed log.
- if you are having trouble with the HTML report produced by Ace, please specify the browser(s) and version(s) where you notice the issue

## Contributing code
Expand All @@ -31,11 +31,11 @@ Please make sure your branch is reasonably up-to-date with the `master` branch (

### Tests

Please make surre to provided tests for any change you’re proposing.
Please make sure to provide tests for any change you’re proposing.

### Code style

We do not yet have formal code style guidelines, so please try to respect the style of the code files you are editting!
We do not yet have formal code style guidelines, so please try to respect the style of the code files you are editing!

We may change your code style when merging a pull request.

Expand Down
18 changes: 9 additions & 9 deletions website/content/docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ The defaults for Ace configuration are:
"force": false,
"subdir": false
},
"runtime": {
"concurrencyLevel": 4
},
"report": {
"use-relative-paths": true
},
"runtime": {
"concurrencyLevel": 4
}
}
```
Expand Down Expand Up @@ -68,14 +68,14 @@ Default: "`false`"

Indicates whether to save reports in a subdirectory of the output directory. If set to `true`, the subdirectory will be named after the input EPUB document.

### `runtime.concurrencyLevel`

Default: "`4`"

The number of concurrent headless browser instances used to check HTML content.

### `report.use-relative-paths`

Default: "`true`"

Indicates whether the report uses relative or absolute paths.

### `runtime.concurrencyLevel`

Default: "`4`"

The number of concurrent headless browser instances used to check HTML content.
2 changes: 1 addition & 1 deletion website/content/docs/http-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ This API is available to client applications.
* `GET /jobs/`: list all the jobs
* `GET /job/:jobid/`: return information about a job
* `POST /jobs/`: attach an EPUB file to run Ace
* `GET /job/:jobid/report/?type=[zip|json]`: return a zipfile containing the report
* `GET /job/:jobid/report/?type=[zip|json]`: return a zip file containing the report

Note that failing to specify `type` of report will return the default format (`zip`).

Expand Down
4 changes: 2 additions & 2 deletions website/content/help/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Erm… you probably just hit a bug in Ace. Follow the [guidelines for submitting

## I receive an `EACCESS` error when trying to install Ace

You may receive an `EACCESS` error when you try to isntall Ace, for instance when installing the `puppeteer` dependency. This indicates the you do not have write permissions to the `npm` installation directories. You can fix this by following the [instructions in the `npm` documentation](https://docs.npmjs.com/getting-started/fixing-npm-permissions).
You may receive an `EACCESS` error when you try to install Ace, for instance when installing the `puppeteer` dependency. This indicates the you do not have write permissions to the `npm` installation directories. You can fix this by following the [instructions in the `npm` documentation](https://docs.npmjs.com/getting-started/fixing-npm-permissions).

## I receive an `EACCESS` error when trying to install Ace as a super-user with `sudo`

Expand Down Expand Up @@ -39,6 +39,6 @@ You need to tell the installation scripts to enforce the super-user permissions.
sudo npm install -g ace-core --unsafe-perm=true --allow-root
```

## I receive an `ELIFECYCLE` error when trying to install Ace on Windows version `Windows_NT 10.0.16299`
## I receive an `ELIFECYCLE` error when trying to install Ace on Windows version `Windows_NT 10.0.16299`

This seems to be a [bug in `npm`](https://github.com/npm/npm/issues/18979). You can fix it by updating to more recent Node and npm versions.

0 comments on commit eba12cb

Please sign in to comment.