From 3b608b99be7b970debddc96f95b1adaa0eefcc13 Mon Sep 17 00:00:00 2001 From: Jared Galanis Date: Fri, 10 Nov 2023 16:32:46 -0500 Subject: [PATCH 1/3] Clean up readme - Some things weren't accurate anymore, so this cleans that up - There are too many places that describe how to spin up a local environment so this moves to pointing to the instructions in ember-jsonapi-docs --- README.md | 28 +++++----------------------- 1 file changed, 5 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 0b0121cf7..0a02b9f65 100644 --- a/README.md +++ b/README.md @@ -3,28 +3,10 @@ ![Sync with S3](https://github.com/ember-learn/ember-api-docs-data/workflows/Sync%20with%20S3/badge.svg) 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). +S3 bucket via a [GitHub Action](./github/workflows/sync.yml). That data is +consumed by the [ember-api-docs frontend](https://github.com/ember-learn/ember-api-docs). -These files are auto-generated via -https://github.com/ember-learn/ember-jsonapi-docs +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). -## 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](). +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-jsonapi-docs#optional-view-the-generated-docs-in-a-web-app). From d93179bd75ef6c4f350c89c136736fe4e7a1912b Mon Sep 17 00:00:00 2001 From: Jared Galanis Date: Fri, 10 Nov 2023 17:15:44 -0500 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a02b9f65..11fed1af1 100644 --- a/README.md +++ b/README.md @@ -9,4 +9,4 @@ consumed by the [ember-api-docs frontend](https://github.com/ember-learn/ember-a 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). -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-jsonapi-docs#optional-view-the-generated-docs-in-a-web-app). +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). From e8979b53a9b3931627c2b94f7796b62e390cd0e6 Mon Sep 17 00:00:00 2001 From: Jared Galanis Date: Tue, 14 Nov 2023 09:16:03 -0500 Subject: [PATCH 3/3] Update README.md --- README.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/README.md b/README.md index 11fed1af1..3a30ae97c 100644 --- a/README.md +++ b/README.md @@ -1,12 +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 of this repository is synced to the `s3://api-docs.emberjs.com` -S3 bucket via a [GitHub Action](./github/workflows/sync.yml). That data is -consumed by the [ember-api-docs frontend](https://github.com/ember-learn/ember-api-docs). - 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). -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). +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).