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

[Docs] Polish docs for bottom-up approach #735

Closed
4 tasks done
b-admike opened this issue Nov 15, 2017 · 2 comments
Closed
4 tasks done

[Docs] Polish docs for bottom-up approach #735

b-admike opened this issue Nov 15, 2017 · 2 comments
Assignees
Labels
Milestone

Comments

@b-admike
Copy link
Contributor

b-admike commented Nov 15, 2017

Story

As a LoopBack4 user, I would like an easy to follow and intuitive tutorial which shows me how to make a LB4 app using TypeScript model definitions, decorators, and API spec fragments.

We already have a tutorial repository in https://github.com/strongloop/loopback4-example-getting-started, now we need to expose it in our docs on loopback.io.

See also #729

Acceptance Criteria

  • Rename http://loopback.io/doc/en/lb4/Defining-and-validating-the-API.html to something like "Define your API top-down way"
  • Add a new page at the same level, something like "Define your API bottom-up way". Explain basic concepts (controller decorators like @post, @param etc.) and point people to example-getting-started as the tutorial.
  • Add a note to both top-down and bottom-up pages pointing readers to each other, mentioning that both approaches are valid and fully supported by LoopBack.
  • In http://loopback.io/doc/en/lb4/Examples-and-tutorials.html, update the description for example-getting-started to make it clear the example is showing bottom-up approach.
@bajtos bajtos added non-MVP and removed MVP labels Dec 15, 2017
@bajtos bajtos changed the title [Docs] Bottom-up app tutorial [Docs] Improve docs for bottom-up approach Jan 11, 2018
@bajtos bajtos changed the title [Docs] Improve docs for bottom-up approach [Docs] Polish docs for bottom-up approach Jan 11, 2018
@bajtos bajtos added the Core-GA label Jan 11, 2018
@dhmlau
Copy link
Member

dhmlau commented Feb 13, 2018

related to: #988

@dhmlau
Copy link
Member

dhmlau commented Feb 23, 2018

@shimks @virkt25 , seems like all the checkboxes are checked. Is this task done? If so, could you please close it and update the March milestone as well? #937 Thanks!

UPDATED: just realized there's still an outstanding PR (i think) loopbackio/loopback.io#624

@dhmlau dhmlau added this to the March 2018 milestone Feb 26, 2018
@shimks shimks closed this as completed Mar 9, 2018
@shimks shimks removed the in-progress label Mar 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants