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.

Sign up for GitHub

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

Add warnings for top-down approach pages #626

Merged
merged 2 commits into from
Feb 20, 2018
Merged

Add warnings for top-down approach pages #626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c59c37f
add warnings for top-down approach pages
Feb 20, 2018
7bd3ae5
Update READMEs from other repos
slnode Feb 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions pages/en/lb3/readmes/loopback-component-push.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ providers such as APNS, GCM, and MPNS

### Node.js server

This module includes an [example LoopBack server application](https://github.com/strongloop/loopback-component-push/tree/master/example/server-2.0).
This module includes an [example LoopBack server application](https://github.com/strongloop/loopback-example-push).

To run it, use these commands:

Expand All @@ -53,12 +53,12 @@ MONGODB=mongodb://localhost/demo node app

### iOS client

The [iOS example app](https://github.com/strongloop/loopback-component-push/tree/master/example/ios)
The [iOS example app](https://github.com/strongloop/loopback-example-push/tree/master/ios)
uses the LoopBack iOS SDK to enable and handle push notifications.

### Android client

The [Android example app](https://github.com/strongloop/loopback-component-push/tree/master/example/android)
The [Android example app](https://github.com/strongloop/loopback-example-push/tree/master/android)
uses the LoopBack Android SDK to enable and handle push notifications.

## References
Expand Down
4 changes: 4 additions & 0 deletions pages/en/lb4/Defining-and-validating-the-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ sidebar: lb4_sidebar
permalink: /doc/en/lb4/Defining-and-validating-the-API.html
summary:
---
{% include important.html content="The top-down approach for building LoopBack
applications is not yet fully supported. Therefore, the steps outlined in this
page are outdated and may not work out of the box. They will be revisited after
our MVP release." %}

## Define the API

Expand Down
5 changes: 5 additions & 0 deletions pages/en/lb4/Testing-the-API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ summary:
This article continues off from [Defining and validating the API](./Defining-and-validating-the-API.html).
" %}

{% include important.html content="The top-down approach for building LoopBack
applications is not yet fully supported. Therefore, the steps outlined in this
page are outdated and may not work out of the box. They will be revisited after
our MVP release." %}

## Smoke test API input/output

Once you confirm that the API specification is valid, it's time to verify that the application implements the API as you have specified it. The input/output testing described below uses [Dredd](https://www.npmjs.com/package/dredd), specifically `hello-world` in this section. Concrete sample code of `hello-world` can be found in the [hello-world tutorial](https://github.com/strongloop/loopback-next-hello-world) repository. Although the sample code includes a validated API spec and fully functional `hello-world` controller, let's pretend the controller is completely empty. Try it yourself by cloning the repository from GitHub.
Expand Down