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

[Lab feature] Figure out how to publish apidocs for lab features #3039

Closed
3 tasks
jannyHou opened this issue Jun 4, 2019 · 4 comments
Closed
3 tasks

[Lab feature] Figure out how to publish apidocs for lab features #3039

jannyHou opened this issue Jun 4, 2019 · 4 comments
Labels

Comments

@jannyHou
Copy link
Contributor

jannyHou commented Jun 4, 2019

Description / Steps to reproduce / Feature proposal

A follow up story for the spike #2676
The workflow of how to add an experimental feature is documented in https://github.com/strongloop/loopback-next/blob/labs/base/LABS.md , next let's figure out how to generate the apidocs for packages in folder /labs and publish them on https://loopback.io/doc/en/lb4/apidocs.index.html/.

Acceptance criteria

  • Take a released experimental feature as an example(like Creating adapter for the plugged in passport strategies #2311, or any other packages in labs folder), generate the apidocs for it.
  • Improve tsdocs module to run against individual packages and generate markdown files of the apidocs.
  • Section on documentation website ("Experimental features") that links to the GitHub branch's README that has info about the particular feature.
@nabdelgadir
Copy link
Contributor

Deferring this until #3055 is landed.

@dhmlau dhmlau added the blocked label Jun 7, 2019
@dhmlau
Copy link
Member

dhmlau commented Jun 10, 2019

#3055 has landed. We can estimate it in the coming estimation meeting.

@stale
Copy link

stale bot commented Aug 16, 2020

This issue has been marked stale because it has not seen activity within six months. If you believe this to be in error, please contact one of the code owners, listed in the CODEOWNERS file at the top-level of this repository. This issue will be closed within 30 days of being stale.

@stale stale bot added the stale label Aug 16, 2020
@stale
Copy link

stale bot commented Sep 20, 2020

This issue has been closed due to continued inactivity. Thank you for your understanding. If you believe this to be in error, please contact one of the code owners, listed in the CODEOWNERS file at the top-level of this repository.

@stale stale bot closed this as completed Sep 20, 2020
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

3 participants