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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BREAKING] Replace strong-docs with tsdocs #3055

Merged
merged 3 commits into from Jun 7, 2019

Conversation

@raymondfeng
Copy link
Member

commented Jun 6, 2019

The PR contains 3 commits:

  1. Remove strong-docs and its related artifacts from loopback-next
  2. Remove lb-apidocs script from @loopback/build (BREAKING CHANGE)
  3. Fix documentation site to use new urls

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 馃憟

@dhmlau

dhmlau approved these changes Jun 6, 2019

@dhmlau

This comment has been minimized.

Copy link
Contributor

commented Jun 6, 2019

@raymondfeng, I have a question not related to the changes in this PR. Does it mean the LB4 portion of http://apidocs.loopback.io/ is out-dated? If so, would we redirect the apidocs.loopback.io links to the /doc/en/lb4/* ?

@raymondfeng

This comment has been minimized.

Copy link
Member Author

commented Jun 6, 2019

I have a question not related to the changes in this PR. Does it mean the LB4 portion of http://apidocs.loopback.io/ is out-dated? If so, would we redirect the apidocs.loopback.io links to the /doc/en/lb4/* ?

Yes. It should be redirected to https://loopback.io/doc/en/lb4/apidocs.index.html.

@raymondfeng raymondfeng force-pushed the remove-strong-docs branch from 84a0928 to 88ac678 Jun 6, 2019

@bajtos
Copy link
Member

left a comment

It's great to see strong-docs removed from our dependencies 馃憦

It's a breaking change, we should follow the process as described in https://github.com/strongloop/loopback-next/blob/0d9698ab3bbad2754736b15b8e8880187c167c32/docs/site/DEVELOPING.md#making-breaking-changes

Personally, I'd prefer to split this pull request into two:

  • In this pull request, keep the changes related to how we are building api docs. This is backwards compatible.
  • Open a new pull request dedicated to removal of strong-docs & lb-apidocs from @loopback/build.
Show resolved Hide resolved packages/build/package.json

@bajtos bajtos referenced this pull request Jun 7, 2019

Closed

Build 2.0 #3061

3 of 3 tasks complete
@bajtos

This comment has been minimized.

Copy link
Member

commented Jun 7, 2019

I created a new GH issue to keep track of breaking changes to include in the next release: #3061

@raymondfeng raymondfeng force-pushed the remove-strong-docs branch from 88ac678 to deca478 Jun 7, 2019

@raymondfeng raymondfeng changed the title Replace strong-docs with tsdocs [BREAKING] Replace strong-docs with tsdocs Jun 7, 2019

@raymondfeng raymondfeng force-pushed the remove-strong-docs branch from deca478 to 12f7b18 Jun 7, 2019

@raymondfeng raymondfeng requested a review from bajtos Jun 7, 2019

@bajtos

bajtos approved these changes Jun 7, 2019

Copy link
Member

left a comment

馃憦

raymondfeng added some commits Jun 6, 2019

feat(build): remove strong-docs based `lb-apidocs` helper
Remove lb-apidocs script since we now use @loopback/tsdocs to generate
API docs as markdown files in docs/site/apidocs.

BREAKING CHANGE: `lb-apidocs` helper is no longer available. Please switch
to Microsoft api-extractor and api-documenter.

@raymondfeng raymondfeng force-pushed the remove-strong-docs branch from 12f7b18 to 3a07f63 Jun 7, 2019

@jannyHou
Copy link
Contributor

left a comment

Verified by running npm run tsdocs and npm run build:site on local 馃憤

A question about the preview: is there a command to setup a server that runs the generated docs(including apidocs) so that people can open the html page? Or the only way to preview a file is open the .md file in vscode then view it by shift+cmd+v?

@raymondfeng raymondfeng merged commit 1c4bfee into master Jun 7, 2019

4 checks passed

clahub All contributors have signed the Contributor License Agreement.
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 91.896%
Details

@delete-merged-branch delete-merged-branch bot deleted the remove-strong-docs branch Jun 7, 2019

@bajtos bajtos referenced this pull request Jun 10, 2019

Closed

Spike: replace strong-docs with api-extractor #2507

3 of 4 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can鈥檛 perform that action at this time.