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 lb3 parity warnings #4466

Merged

Conversation

achrinza
Copy link
Member

@achrinza achrinza commented Jan 20, 2020

Signed-off-by: Rifa Achrinza [email protected]

Currently, LoopBack 4 does not provide full parity of the features from LoopBack 3. This PR is intended to add a warning for existing users of LoopBack 3 on the docs page (see: #1920 (comment)).

While there is a pinned issue to keep track of this, it may be hidden to the average user. Hence, this PR intends to put forward the pinned issue in more clearly.

This is to prevent users from taking extra time to work around the lack of feature parity that may not have been known to them due to lack of warning in the docs.

Checklist

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

  • npm test passes on your machine
  • Documentation in /docs/site was updated

👉 Check out how to submit a PR 👈

@achrinza achrinza added developer-experience Issues affecting ease of use and overall experience of LB users Docs labels Jan 20, 2020
@achrinza achrinza self-assigned this Jan 20, 2020
@achrinza achrinza changed the title docs: added lb3 parity warnings docs: add lb3 parity warnings Jan 20, 2020
Signed-off-by: Rifa Achrinza <[email protected]>
@achrinza achrinza force-pushed the docs/add-lb3-parity-warnings branch from 7c4b39c to 0d89263 Compare January 20, 2020 06:04
@raymondfeng raymondfeng merged commit ca9d8b8 into loopbackio:master Jan 20, 2020
@achrinza achrinza deleted the docs/add-lb3-parity-warnings branch January 20, 2020 21:17
@NorthDecoder
Copy link
Contributor

NorthDecoder commented Feb 12, 2020

@achrinza On the page doc/en/lb4/index.html I tested the link doc/en/lb4/understanding-the-differences and the link is dead. I was able to find the file at /docs/site/Understanding-the-differences however, I cannot suggest a fix.

achrinza added a commit to achrinzafork/loopback-next that referenced this pull request Feb 14, 2020
See loopbackio#4466

Fix a minor typo that prevents Jekyll from parsing and converting the
link into a navigatable URL.

Signed-off-by: Rifa Achrinza <[email protected]>
bajtos pushed a commit that referenced this pull request Feb 14, 2020
See #4466

Fix a minor typo that prevents Jekyll from parsing and converting the
link into a navigatable URL.

Signed-off-by: Rifa Achrinza <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer-experience Issues affecting ease of use and overall experience of LB users Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants