diff --git a/README.md b/README.md index 5a4e51b..e3d29c0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ -# This is a temporary fork of the old ember-cli website codebase +# Legacy Ember CLI Website -We are using this fork to set up the redirects from the [old site](https://ember-cli.com) to the [new]((https://cli.emberjs.com)). -If you are looking for Ember CLI documentation, please visit [cli.emberjs.com](https://cli.emberjs.com), -which has the most up-to-date information. The source code for the CLI guides can be found [here](https://github.com/ember-learn/cli-guides). +This repository contains the built API documentation for `ember-cli`, and redirects that point the legacy URLs to [https://cli.emberjs.com](https://cli.emberjs.com) +The source code for the active CLI guides can be found [here](https://github.com/ember-learn/cli-guides). + +# About the API docs + +This repository's content is hosted via Netlify, and unlike the guides content which is redirected, the built API docs are still used in production. + +## To update the API docs + +1. Clone this repository +2. Clone https://github.com/ember-cli/ember-cli and `yarn install` +3. In `ember-cli`, run `npx yuidoc .` to generate the API docs +4. Copy the contents of the `docs` folder into the `api` folder of this website repo +5. Run the app locally with `http-server .` and make sure that they show up as they should +6. Open a PR to this repository + +## About the redirects + +The redirect behavior is managed by Netlify. You can see the list of redirects [here](https://github.com/ember-learn/ember-cli.github.io/blob/master/_redirects). + +## Deploying + +PRs merged to this repository will be deployed automatically via Netlify's GitHub integration. The project name is `ember-cli.com` under the Ember org.