LB4 Documents need a cleanup pass

[mhdawson]

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

Roadmap.md:TBD.
Sequence.md:- [`Request`](http://apidocs.strongloop.com/loopback-next/) - (TBD) missing API
Sequence.md:- [`Response`](http://apidocs.strongloop.com/loopback-next/) - (TBD) missing API

• work in progress

Controllers.md:{% include content/tbd.html %}
Model.md:{% include content/tbd.html %}
Sequence.md:{% include content/tbd.html %}
Sequence.md:{% include content/tbd.html %}
Sequence.md:{% include content/tbd.html %}
Sequence.md:{% include content/tbd.html %}
Testing-your-application.md:{% include content/tbd.html %}
Using-decorators.md:{% include content/tbd.html %}

• https://loopback.io/doc/en/lb4/Booting-an-Application.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 [Docs] Review and modify content in Controllers page  #2099
  • DataSources
  • Routes
  • Sequence. opened [Docs] Update WIP section in Sequence page #2100
  • Model
  • Repositories
  • Relations - opened [Docs] Relation decorators page should be updated #1910
  • Decorators
  • Error handling
• How tos
  • Exposing GraphQL APIs
  • Deploying to IBM Cloud opened Unable to deploy successfully to Cloud Foundry #2033
• Booting an Application
• Using Components
• Calling other APIs. opened Update "Calling other APIs and web services" doc #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 [Docs] "Testing your application" page contains beta release information #2101
• Extending LoopBack 4
  • Creating Components
  • Creating Decorators
  • Creating Servers
  • Testing your extension
• Crafting LoopBack 4 - opened Add Component page under Key Concepts #2020
• FAQ
• Reference
  • Reserved binding keys
  • Glossary
  • Considerations for GDPR readiness

[dhmlau]

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

• Pages that contains TBD:

  • Roadmap.md:TBD.
    • suggest to either remove this page or link to the github issue [Roadmap] 🚀1Q2019 🚀 #1839
  • Sequence.md:- Request - (TBD) missing API
    • navigating through the apidocs of the rest package, the Request brings to this link http://apidocs.loopback.io/@loopback%2fdocs/rest.html#Request but there is no content. Need to investigate
  • Sequence.md:- Response - (TBD) missing API
    • navigating through the apidocs of the rest package, the Response brings to this link http://apidocs.loopback.io/@loopback%2fdocs/rest.html#Response but there is no content. Need to investigate

• Pages / sections that marks as work in progress:

  • Controllers.md:{% include content/tbd.html %}
    • need to look into the "review questions" the WIP pop up refers to.
  • Model.md:{% include content/tbd.html %}
    • This page looks complete. Should remove the first WIP note. Will review the 2nd WIP note in https://loopback.io/doc/en/lb4/Model.html#supported-json-keywords
  • Sequence.md:{% include content/tbd.html %}
    • will create a separate task for the Sequence.md
  • Testing-your-application.md:{% include content/tbd.html %}
    • WIP pop up for https://loopback.io/doc/en/lb4/Testing-your-application.html#create-a-stub-service
  • Using-decorators.md:{% include content/tbd.html %}
    • need to look into the "review questions". also, it's not on the sidebar.

• Review https://loopback.io/doc/en/lb4/Booting-an-Application.html

[bajtos]

@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?

[dhmlau]

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.