Skip to content

Update README.md #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 12, 2020
Merged

Update README.md #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
48e9396
Update README.md
jenweber Nov 12, 2020
8180227
Add a note about deploying
jenweber Nov 12, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.