-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #22 from ember-learn/jaredgalanis-patch-2
Clean up readme
- Loading branch information
Showing
1 changed file
with
3 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,30 +1,6 @@ | ||
# Ember API Docs Data | ||
|
||
![Sync with S3](https://github.com/ember-learn/ember-api-docs-data/workflows/Sync%20with%20S3/badge.svg) | ||
The content in this repository is generated via | ||
[ember-jsonapi-docs](https://github.com/ember-learn/ember-jsonapi-docs). To build new versions of the files for this repository follow the instructions in `ember-jsonapi-docs`'s [README](https://github.com/ember-learn/ember-jsonapi-docs). | ||
|
||
The content of this repository is synced to the `s3://api-docs.emberjs.com` | ||
S3 bucket via a [GitHub Action](./github/workflows/sync.yml). The data is | ||
consumed by the [API Docs Viewer](https://github.com/ember-learn/ember-api-docs). | ||
|
||
These files are auto-generated via | ||
https://github.com/ember-learn/ember-jsonapi-docs | ||
|
||
## Previewing these docs in the front end | ||
|
||
If you want to see how these docs will look in the | ||
front end app: | ||
|
||
``` | ||
git clone https://github.com/ember-learn/ember-api-docs-data | ||
cd ember-api-docs-data | ||
yarn install | ||
yarn serve | ||
cd .. | ||
git clone https://github.com/ember-learn/ember-api-docs | ||
cd ember-api-docs-data | ||
yarn install | ||
yarn start:local | ||
``` | ||
|
||
The JSON files will be served at `http://localhost:5050` and the app can be viewed in the browser at [http://localhost:4200](). | ||
That content is consumed by the [`ember-api-docs` frontend](https://github.com/ember-learn/ember-api-docs). If you want to see how this content will look in the `ember-api-docs` frontend in your local environment follow [these instructions](https://github.com/ember-learn/ember-api-docs). |