ember-learn / cli-guides

Step-by-step guides and tutorials for using the ember-cli to create apps and addons
https://cli.emberjs.com
MIT License
25 stars 76 forks source link

Figure out a plan for https://ember-cli.com/api/ #190

Closed jenweber closed 4 years ago

jenweber commented 4 years ago

Every section on the old website has 2 URLs: https://ember-cli.com/user-guide/#naming-conventions https://ember-cli.com/naming-conventions

Both need to be accounted for to not harm SEO.

Spreadsheet https://docs.google.com/spreadsheets/d/1rVShNyFhUZqS-oeQQDAJC7u2_KU5WPct2kdhCGvBKAg/edit?usp=sharing

Options:

  1. Could make a netlify redirects file that lives in the new guides, but we would have to change hosting for api docs. All pages must have valid content on the new site.
  2. Find out what we use for hosting now and do the redirects. If it's GitHub, we can't do server redirects. It is GitHub.
  3. Could put old site on Netlify. Could do piecemeal walkover. Could leave API docs where they are.
jenweber commented 4 years ago

We are experimenting with pulling the api docs repo into the website repo and hosting on netlify, which would mean we can do incremental redirects. See https://github.com/mansona/ember-cli.github.io/pull/1

jenweber commented 4 years ago

We cannot transfer the repo from ember-cli to ember-learn because that would make the GitHub Pages stop working.

We confirmed that netlify redirects will work ok for our purposes.

The user-guide has all the content on it, so we need to finish moving some of the content that does not have a 1:1 match. This blocks hosting changes.

The easiest way to move forward with hosting appears to be to fork the repo into ember-learn (with the CLI team permission), stand it up in Netlify, and do the DNS change.

jenweber commented 4 years ago

Closed - we made https://github.com/ember-learn/ember-cli.github.io, put the yuidoc files in the public folder, and deployed to Netlify