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: add mounting lb3 app on lb4 migration guide #3052

Merged
merged 1 commit into from
Jun 6, 2019

Conversation

nabdelgadir
Copy link
Contributor

Connect to #2393.

Docs describing using Lb3AppBooterComponent to mount a LoopBack 3 application on a LoopBack 4 project.

Checklist

👉 Read and sign the CLA (Contributor License Agreement) 👈

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

👉 Check out how to submit a PR 👈

@nabdelgadir nabdelgadir self-assigned this Jun 5, 2019
[Getting started](Getting-started.md) for an introduction.
" %}

1. To mount your LoopBack 3 application, you will need to first create a new
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The following part is the same as https://github.com/strongloop/loopback-next/blob/master/examples/lb3-application/README.md#tutorial, so I'm wondering if I should just link to there instead or keep it here?

Copy link
Contributor

Choose a reason for hiding this comment

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

I would suggest avoid copy paste duplicate content so that everytime we only update one place, and other places link to the source page.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's a good point! I'll link then, thank you 👍

Copy link
Member

@dhmlau dhmlau left a comment

Choose a reason for hiding this comment

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

@nabdelgadir, I have 2 questions (in the review comments), not entirely about the changes you added, because I believe you've just moving the contents around, so I'm happy to open a new issue to discuss that if it's blocking the landing of your PR. Thanks.


- How to connect LoopBack 3.x concepts to LoopBack 4 terms
- What's new and exciting in LoopBack 4
- What's on the roadmap to achieve functional parity
Copy link
Member

Choose a reason for hiding this comment

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

i think roadmap is no longer part of this page?

This article will help existing users understand LoopBack 4:

- How to connect LoopBack 3.x concepts to LoopBack 4 terms
- What's new and exciting in LoopBack 4
Copy link
Member

Choose a reason for hiding this comment

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

While we're in this page.. I'm thinking whether we should have "what's new and exciting in LB4" (this bullet and the section at the bottom), because the list keeps changing.
I'm happy to open another issue to discuss this, and not blocking the landing of this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added this but let me know if I should just remove the whole section instead.

Copy link
Member

Choose a reason for hiding this comment

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

TBH, I personally prefer to have it completely. Let's keep it this way for now and we can improve the docs later. Thanks.

Copy link
Contributor

@jannyHou jannyHou left a comment

Choose a reason for hiding this comment

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

👍 The refactor LGTM, I left a comment regarding the same content from the example tutorial

LoopBack 4 application.

```sh
$ lb4 app
Copy link
Contributor

Choose a reason for hiding this comment

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

There are a lot of questions posed by this command, what do you suggest they specify?

Copy link
Contributor

@jannyHou jannyHou left a comment

Choose a reason for hiding this comment

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

LGTM :shipit:

@dhmlau
Copy link
Member

dhmlau commented Jun 6, 2019

TBH, I personally prefer to have the section "What's new and exciting in LoopBack 4" completely, but others might have other opinions. Let's keep it this way for now and we can improve the docs if needed. Thanks.

@nabdelgadir nabdelgadir force-pushed the migration-docs branch 3 times, most recently from 8418c96 to 81b2de7 Compare June 6, 2019 15:36
@nabdelgadir nabdelgadir merged commit b291416 into master Jun 6, 2019
@delete-merged-branch delete-merged-branch bot deleted the migration-docs branch June 6, 2019 17:44
@bajtos bajtos mentioned this pull request Jun 6, 2019
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants