Skip to content
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.

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

Update & fix api doc urls #952

Merged
merged 28 commits into from Jul 25, 2019

Conversation

@sivakumar-kailasam
Copy link
Member

commented Jul 25, 2019

Background

Until the end of 2.x series, we were using the versioned API doc URLs in the guides. This ensured that the API URLs always existed. But in the 3.x series, we started using the /release paths in the guides. Since there have been multiple reorgs of APIs in the 3.x series on both ember and ember-data, most of those URLs would lead nowhere.

Also in 3.11 ember-data restructured its packages which isn't completely represented in the API docs. Until it is sorted out, the release docs will point to the 3.10 ember-data docs instead of the 3.11 docs.

what's here

  • Rewrote old URL patterns to API docs to the latest pattern (eg., http://www.emberjs.com/api, http://emberjs.com/api).
  • Rewrote /release API URLs in the 3.x folders to use their corresponding versioned URLs instead.
  • Rewrote /ember/release API URLs in the 3.x folder to use /ember/3.11 API URLs & /ember-data/release API URLs to use /ember-data/3.10 instead.

sivakumar-kailasam added some commits Jul 25, 2019

Pin api urls in release docs to 3.11 ember api docs & 3.10 ember-data…
… api docs instead of release docs

we're pinning ember-data to 3.10's docs since package restructuring isn't properly represented on the api app

@sivakumar-kailasam sivakumar-kailasam requested a review from jenweber Jul 25, 2019

@jenweber

This comment has been minimized.

Copy link
Contributor

commented Jul 25, 2019

#yolo
ariel the mermaid signing a contract with ursula

@jenweber jenweber merged commit 3137ea0 into master Jul 25, 2019

5 of 7 checks passed

Header rules - ember-guides No header rules processed
Details
Pages changed - ember-guides 3743 new files uploaded
Details
Mixed content - ember-guides No mixed content detected
Details
Redirect rules - ember-guides 202 redirect rules processed
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
netlify/ember-guides/deploy-preview Deploy preview ready!
Details
percy/guides-app Visual review approved by Jen Weber
Details

@amyrlam amyrlam referenced this pull request Aug 5, 2019

Merged

The Ember Times No. 110 - August 9th 2019 #220

7 of 10 tasks complete

@sivakumar-kailasam sivakumar-kailasam deleted the fix/update-api-doc-urls branch Aug 13, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.