@ember-learn/guides-source - npm Package Compare versions

Comparing version 3.4.2 to 3.5.0

CONTRIBUTING.md

@@ -101,2 +101,22 @@ # Contributing
 
+When linking to topics from guide md files:
+
+* use relative links when referencing a topic.
+  * Incorrect: `https://guides.emberjs.com/release/routing/query-params/`
+  * Correct: `../routing/query-params`
+
+* to reference a topic when you are in `index.md`, you only have to go up one level to reference another topics md file, `../main-topic/sub-topic`.
+  * example from `index.md` to `routing/query-params.md`:
+    * `../routing/query-params`
+
+* to reference a md file in a different main topic to the one you are in, you need to go two levels up, `../../main-topic/sub-topic`.
+  * example from `routing/query-params.md` to `components/block-params.md`:
+    * `../../components/block-params`
+
+* to reference a md file within the topic you are currently in, you need to go up one level, `../sub-topic`.
+  * example from `routing/query-params.md` to `routing/redirection.md`:
+    * `../redirection`
+
+* always use `/release/` when linking API docs.
+
 When linking to API pages:
@@ -103,0 +123,0 @@

guides/v3.4.0/object-model/index.md

@@ -1,18 +0,21 @@
-You'll notice standard JavaScript class patterns and the new ES2015
-classes aren't widely used in Ember. Plain objects can still be found,
-and sometimes they're referred to as "hashes".
+One of the first things you'll notice when you generate JavaScript files in Ember is that most of the code you will write goes inside of an object. While an Ember Object might look a lot like an ES2015 JavaScript class, it has some special properties.
 
-JavaScript objects don't support the observation of property value changes.
-Consequently, if an object is going to participate in Ember's binding
-system you may see an `Ember.Object` instead of a plain object.
+### Introducing: Ember Objects
 
-[Ember.Object](https://www.emberjs.com/api/ember/release/modules/@ember%2Fobject) also provides a class system, supporting features like mixins
-and constructor methods. Some features in Ember's object model are not present in
-JavaScript classes or common patterns, but all are aligned as much as possible
-with the language and proposed additions.
+The [Ember Object](https://www.emberjs.com/api/ember/release/classes/EmberObject) class extends plain JavaScript objects to provide core framework functions such as participating in Ember's [binding system](../object-model/bindings/) or how changes to an object automatically trigger updates to the user interface.
 
-Ember also extends the JavaScript `Array` prototype with its
-[Ember.Enumerable](https://emberjs.com/api/ember/2.15/classes/Ember.Enumerable) interface to provide change observation for arrays.
+Most objects in Ember, including Routes, Models, Services, Mixins, Controllers, and Components extend the `EmberObject` class.
 
-Finally, Ember extends the `String` prototype with a few [formatting and
-localization methods](https://www.emberjs.com/api/ember/release/classes/String).
+### Why Ember Objects?
+
+The most important reason is that an Ember Object can be watched for changes – or _observed_. For example, being [observable](https://www.emberjs.com/api/ember/release/classes/Observable) is important for [computed properties](../object-model/computed-properties/). It is one of the fundamental ways that models, controllers and views communicate with each other in an Ember application.
+
+### More on Ember Objects
+
+The [@ember/object](https://www.emberjs.com/api/ember/release/modules/@ember%2Fobject) package also provides a class system, supporting features like mixins and constructor methods, and being observable.
+
+Some features in Ember's object model are not present in JavaScript classes or common patterns, but all are aligned as much as possible with the language and proposed additions.
+
+Ember also extends the JavaScript `Array` prototype with its [@ember/enumerable](https://emberjs.com/api/ember/release/classes/Enumerable) interface to provide change observation for arrays.
+
+Finally, Ember extends the `String` prototype with a few [formatting and localization methods](https://www.emberjs.com/api/ember/release/classes/String).

guides/v3.4.0/routing/defining-your-routes.md

@@ -281,1 +281,9 @@ When your application starts, the router matches the current URL to the _routes_
 handlers](https://www.emberjs.com/api/ember/release/classes/Route).
+
+## Transitioning Between Routes
+Once the routes are defined, how do we go about transitioning between them within our application? It depends on where the transition needs to take place:
+
+- From a template, use [`{{link-to}}`](https://emberjs.com/api/ember/release/classes/Ember.Templates.helpers/methods/link-to?anchor=link-to) as mentioned above
+- From a route, use the [`transitionTo()`](https://emberjs.com/api/ember/release/classes/Route/methods/transitionTo?anchor=transitionTo) method
+- From a controller, use the [`transitionToRoute()`](https://emberjs.com/api/ember/release/classes/Controller/methods/transitionToRoute?anchor=transitionToRoute) method
+- From anywhere else in your application, such as a component, inject the [Router Service](https://emberjs.com/api/ember/release/classes/RouterService) and use the [`transitionTo()`](https://emberjs.com/api/ember/release/classes/RouterService/methods/transitionTo?anchor=transitionTo) method

guides/v3.4.0/routing/query-params.md

@@ -14,2 +14,7 @@ Query parameters are optional key-value pairs that appear to the right of
 
+In web development, query parameters are used within a URL as described above but can also be used
+in API requests that retrieve data. Ember treats these as _two_ different concepts. This section
+describes how routing query parameters are used in Ember. See [finding records](../../models/finding-records/#toc_querying-for-multiple-records) to see how query parameters are
+applied to API requests in Ember Data.
+
 ### Specifying Query Parameters
@@ -16,0 +21,0 @@

guides/v3.4.0/tutorial/autocomplete-component.md

@@ -565,3 +565,3 @@ As they search for a rental, users might also want to narrow their search to a specific city.
 In the case of our code the key code sent can be anything, since we read the value of the input field, and not the key events coming in.
-We only use the key event to let our code know that its time to make a search.
+We only use the key event to let our code know that it's time to make a search.
 
@@ -568,0 +568,0 @@ The test locates the results of the search by finding elements with a class of `listing`,

package.json

 {
   "name": "@ember-learn/guides-source",
-  "version": "3.4.2",
+  "version": "3.5.0",
   "description": "Markdown files for Ember-Guides",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/ember-learn/guides-source#readme",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

41124665

increased by1.53%

Number of package files

3299

increased by3.22%

No dependency changes