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

LB4 Documents need a cleanup pass #1908

mhdawson opened this Issue Oct 24, 2018 · 3 comments


None yet
4 participants

mhdawson commented Oct 24, 2018

Time boxed to 5 days

Description / Steps to reproduce / Feature proposal

Read through docs

Talked to maintainer and sounds like there is no active issue/planned work to complete docs.

Current Behavior

Some TBDs and "work in progress" markings

Expected Behavior

Complete doc

Specific sections include:

  • TBD [`Request`]( - (TBD) missing API [`Response`]( - (TBD) missing API
  • work in progress{% include content/tbd.html %}{% include content/tbd.html %}{% include content/tbd.html %}{% include content/tbd.html %}{% include content/tbd.html %}{% include content/tbd.html %}{% include content/tbd.html %}{% include content/tbd.html %}

feels a bit like a raw braindump.

Acceptance Criteria

Go through all the pages in the LoopBack 4 documentation, listed below, and verify content and code snippets work and are up to date.

  • Getting started
  • Examples and tutorials
    • Todo Tutorial
    • TodoList Tutorial
    • SOAP Web Service Tutorial
  • Key concepts
    • Application
    • Server
    • Context
    • Dependency injection
    • Controllers. opened #2099
    • DataSources
    • Routes
    • Sequence. opened #2100
    • Model
    • Repositories
    • Relations - opened #1910
    • Decorators
    • Error handling
  • How tos
    • Exposing GraphQL APIs
    • Deploying to IBM Cloud opened #2033
  • Booting an Application
  • Using Components
  • Calling other APIs. opened #2128
  • For current LoopBack users
  • Command-line interface
    • Application generator
    • Controller generator
    • DataSource generator
    • Model generator
    • Repository generator
    • Service generator
    • OpenAPI generator
    • Extension generator
    • Download example
  • Best practices
    • Defining the API using code-first approach
    • Defining your testing strategy
    • Testing your application. opened #2101
  • Extending LoopBack 4
    • Creating Components
    • Creating Decorators
    • Creating Servers
    • Testing your extension
  • Crafting LoopBack 4 - opened #2020
  • FAQ
  • Reference
    • Reserved binding keys
    • Glossary
    • Considerations for GDPR readiness

@dhmlau dhmlau added the Docs label Oct 25, 2018


This comment has been minimized.


dhmlau commented Oct 25, 2018

@mhdawson, thanks for catching this!
Have the following plans for the examples you've pointed out. Will update this task along the way.


This comment has been minimized.


bajtos commented Oct 30, 2018

@dhmlau I am proposing to treat this GH issue as a spike story to determine what work needs to be done and create follow-up issue to keep track of those changes needed. Can we include this story in our November milestone please?


This comment has been minimized.


dhmlau commented Dec 11, 2018

Spike is done. We had:

  • review each docs page
  • made minor fixes and enhancement
  • open github issues to track the work that involves more significant changes.

@dhmlau dhmlau closed this Dec 11, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment