Skip to content
This repository has been archived by the owner on May 26, 2019. It is now read-only.

URLs to the API docs updated (#2177) #2186

Merged
merged 4 commits into from
Mar 9, 2018

Conversation

danielfernau
Copy link
Contributor

URLs to missing API docs added (#2085)

Copy link
Contributor

@acorncom acorncom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@danielfernau Thanks very much for your work here, that's a labor of love. Before we merge this, I'd like to get the input of some other @emberjs/learning-team-managers on whether we want to be linking to 2.15 docs for some of the older classes.

@toddjordan @jenweber any thoughts here?

My inclination would be to merge this PR and then consider going through and removing some of those older links over time. But interested in your takes ...

@@ -147,7 +147,7 @@ fullNameDidChange: observer('fullName', function() {
})
```

Evented functions are annotated using `Ember.on()`:
Evented functions are annotated using [`Ember.on()`](https://emberjs.com/api/ember/2.15/namespaces/Ember/methods/on?anchor=on):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Whoops, this seems to have gone the wrong way ... Mind fixing that? 😀

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one doesn't exist on release

@@ -10,7 +10,7 @@ Fortunately, Ember provides a way for projects to deal with deprecations in an o
## Filtering Deprecations

When your project has a lot of deprecations, you can start by filtering out deprecations that do not have to be addressed right away. You
can use the [deprecation handlers](http://emberjs.com/api/classes/Ember.Debug.html#method_registerDeprecationHandler) API to check for what
can use the [deprecation handlers](https://emberjs.com/api/ember/2.15/classes/Ember.Debug/methods/registerDeprecationHandler?anchor=registerDeprecationHandler) API to check for what
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should remain on 2.15

@@ -27,7 +27,7 @@ this.get('store').findRecord('person', 1).then(function(tyrion) {

All of the Ember.js conveniences are available for
modifying attributes. For example, you can use `Ember.Object`'s
[`incrementProperty`](http://emberjs.com/api/classes/Ember.Object.html#method_incrementProperty) helper:
[`incrementProperty`](https://emberjs.com/api/ember/2.15/classes/Ember.Object/methods/incrementProperty?anchor=incrementProperty) helper:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should remain on 2.15

@@ -32,14 +32,14 @@ let blogPosts = this.get('store').peekAll('blog-post'); // => no network request

`store.findAll()` returns a `DS.PromiseArray` that fulfills to a `DS.RecordArray` and `store.peekAll` directly returns a `DS.RecordArray`.

It's important to note that `DS.RecordArray` is not a JavaScript array, it's an object that implements [`Ember.Enumerable`](http://emberjs.com/api/classes/Ember.Enumerable.html).
It's important to note that `DS.RecordArray` is not a JavaScript array, it's an object that implements [`Ember.Enumerable`](https://emberjs.com/api/ember/2.15/classes/Ember.Enumerable).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And this as well

@@ -1,6 +1,6 @@
In Ember.js, an enumerable is any object that contains a number of child
objects, and which allows you to work with those children using the
[Ember.Enumerable](http://emberjs.com/api/classes/Ember.Enumerable.html) API. The most common
[Ember.Enumerable](https://emberjs.com/api/ember/2.15/classes/Ember.Enumerable) API. The most common
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And this

@@ -46,11 +46,11 @@ in an observable fashion, you should use `myArray.get('firstObject')` and

In the rest of this guide, we'll explore some of the most common enumerable
conveniences. For the full list, please see the [Ember.Enumerable API
reference documentation.](http://emberjs.com/api/classes/Ember.Enumerable.html)
reference documentation.](https://emberjs.com/api/ember/2.15/classes/Ember.Enumerable)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, this one doesn't exist at release, is that why some of these still reference 2.15? @toddjordan any thoughts on whether we want to support those in the future?

@acorncom
Copy link
Contributor

acorncom commented Feb 3, 2018

This PR fixes #2177

@danielfernau
Copy link
Contributor Author

@acorncom Thanks for your feedback!

I used the 2.15 docs there because opening, for example,
http://emberjs.com/api/classes/Ember.Debug.html#method_registerDeprecationHandler
in a web browser redirects to
https://emberjs.com/api/ember/2.15/classes/Ember.Debug/methods/registerDeprecationHandler?anchor=registerDeprecationHandler

For now, I'll wait until we know the opinion of the other two learning team managers you mentioned...
Just let me know if I need to change anything!

@jenweber
Copy link
Contributor

jenweber commented Feb 3, 2018

@acorncom I agree - we can fix the older links later. It's a big improvement!

I'd like to hear from Todd as well before merging.

Daniel, thanks so much for taking this on :D

@MelSumner MelSumner requested a review from toddjordan February 10, 2018 17:52
Copy link
Member

@sivakumar-kailasam sivakumar-kailasam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@danielfernau Great PR. If you could resolve the conflicts, we can merge this and run .a broken link scanner on the deployed changes.

@sivakumar-kailasam sivakumar-kailasam merged commit ffa6f22 into emberjs:master Mar 9, 2018
@danielfernau
Copy link
Contributor Author

@jenweber You're welcome, I'm glad I was able to help :)

@sivakumar-kailasam Thanks for resolving the conflicts and merging my PR!

@danielfernau danielfernau deleted the update-api-docs-url branch March 9, 2018 17:35
@sivakumar-kailasam
Copy link
Member

@danielfernau We'll make sure to review things quicker the next time you send out a PR 😉

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants