Skip to content

Commit

Permalink
Documentation fixes (#364)
Browse files Browse the repository at this point in the history
* Fix typo

* Fix a 404

* Point [hooks] to operation-hooks

* Link to issue #49

* Remove the video on user management

Its bad audio quality casts a negative
light on LoopBack

* Delist POST as a method for an Update
  • Loading branch information
b1az authored and crandmck committed Apr 25, 2017
1 parent 462b853 commit ef0e8ec
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ summary: A brief tutorial on creating an Angular client app using the Loopback A

### Linting Readmes

There is an additional `npm script` that "lints" the readmes for markdown formatting problems. It is currently "experimental", see #49 for more info.
There is an additional `npm script` that "lints" the readmes for markdown formatting problems. It is currently "experimental", see [this issue](https://github.com/strongloop/loopback.io/issues/49#issuecomment-253672668) for more info.

You can run this script thus:

Expand Down
2 changes: 1 addition & 1 deletion pages/en/contrib/LTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In general, LoopBack version numbers adhere to [semantic versioning](http://semv
The LoopBack project maintains:

- A _Current_ version where most of the development occurs.
- A _Long-term suppoort (LTS)_ version that does not add new features but gets bug fixes.
- A _Long-term support (LTS)_ version that does not add new features but gets bug fixes.
- One (or more) _maintenance_ versions that receive only critical bug fixes.

## LTS versions
Expand Down
4 changes: 2 additions & 2 deletions pages/en/lb3/Basic-model-object.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ lang: en
layout: page
keywords: LoopBack
tags:
sidebar: lb2_sidebar
permalink: /doc/en/lb2/Basic-model-object.html
sidebar: lb3_sidebar
permalink: /doc/en/lb3/Basic-model-object.html
summary:
---

Expand Down
3 changes: 1 addition & 2 deletions pages/en/lb3/LoopBack-core-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ LoopBack models are JavaScript objects with both Node and REST APIs.
**A key powerful feature of LoopBack is that when you define a model it automatically comes with a predefined REST API
with a full set of create, read, update, and delete operations.**  

The [Basic model object](Basic-model-object.html) has methods for adding [hooks](Model-hooks.html) and for [validating data](Validating-model-data.html).
The [Basic model object](Basic-model-object.html) has methods for adding [hooks](Operation-hooks.html) and for [validating data](Validating-model-data.html).
Other model objects all "inherit from" it. Models have an inheritance hierarchy, as shown at right:
When you attach a model to a persistent data source it becomes a [connected model](Connected-model-object.html) with create, retrieve, update, and delete operations.
LoopBack's built-in models inherit from it.
Expand Down Expand Up @@ -101,7 +101,6 @@ with a full set of create, read, update, and delete operations from the [Persi
<tr>
<td>Update (Modify)</td>
<td>
<a href="PersistedModel-REST-API.html#update--insert-instance">POST /<em>modelName</em></a> <br/>
<a href="PersistedModel-REST-API.html#update-model-instance-attributes">PUT /modelName</a>
</td>
<td><code><a href="http://apidocs.strongloop.com/loopback/#persistedmodel-updateall" class="external-link" rel="nofollow">updateAll()</a><sup>*</sup></code></td>
Expand Down
6 changes: 1 addition & 5 deletions pages/en/lb3/Managing-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ functionality that you can use via your custom model.
In addition, LoopBack does not support multiple models based on the User model in a single application. That is, you cannot have more than one model derived from the built-in User model in a single app.
" %}

Watch this video for an introduction to user management in LoopBack:

<iframe class="youtube-player" type="text/html" style="width: 400px; height: 300px" src="//www.youtube.com/embed/UdsOcOVg_0M?wmode=opaque" frameborder="0"></iframe>

## Creating and authenticating users

The basic process to create and authenticate users is:
Expand Down Expand Up @@ -150,7 +146,7 @@ See [Partitioning users with realms](Partitioning-users-with-realms.html).

## Security considerations

When a user's account is compromised (for example their password is leaked or the attacker gains
When a user's account is compromised (for example their password is leaked or the attacker gains
access to their email account), the app needs to be able to prevent continued use of the hijacked account.

To address this case, LoopBack invalidates access tokens (logs out sessions)
Expand Down

0 comments on commit ef0e8ec

Please sign in to comment.