Skip to content

Commit b90ca0b

Browse files
committed
chore: remove references to strong-docs and api-docs
1 parent 55b3b25 commit b90ca0b

File tree

44 files changed

+42
-128
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+42
-128
lines changed

.eslintignore

-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
node_modules/
22
dist/
33
coverage/
4-
api-docs/
54
/sandbox
65
**/*.d.ts

.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ npm-debug.log
44
.DS_Store
55
coverage
66
.nyc_output
7-
api-docs
87
**/*.tgz
98
packages/*/dist
109
examples/*/dist

.prettierignore

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
/coverage
2-
**/*/api-docs
32
/docs/apidocs
43
/docs/site/apidocs
54
packages/cli/generators/*/templates

.vscode/settings.json

-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
"coverage": true,
2121
"benchmark/dist": true,
2222
"packages/*/dist": true,
23-
"packages/*/api-docs": true,
2423
"examples/*/dist": true,
2524
"**/.sandbox": true
2625
},

docs/README.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ https://loopback.io/doc/en/contrib/doc-contrib.html.
1313

1414
## API references
1515

16-
The API references are generated by running `npm run apidocs` at the root
17-
directory of [loopback-next](https://github.com/strongloop/loopback-next).
18-
19-
[API references](./apidocs.html)
16+
The API docs are generated by running `npm run tsdocs` at the root directory of
17+
[loopback-next](https://github.com/strongloop/loopback-next). The task is run as
18+
part of the release process. Official
19+
[API references](https://loopback.io/doc/en/lb4/apidocs.index.html) is served
20+
from [loopback.io](https://www.loopback.io) web site.

docs/apidocs.html

-40
This file was deleted.

docs/docs.json

+1-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
11
{
2-
"content": ["README.md"],
3-
"assets": {
4-
"/apidocs.html": "apidocs.html"
5-
}
2+
"content": ["README.md"]
63
}

docs/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@
1515
"docs"
1616
],
1717
"scripts": {
18-
"build:apidocs": "lb-apidocs --html-file=index.html",
1918
"prepack": "node ./bin/copy-readmes && cd .. && npm run tsdocs",
20-
"clean": "lb-clean loopback-docs*.tgz package api-docs apidocs site/readmes site/apidocs"
19+
"clean": "lb-clean loopback-docs*.tgz package apidocs site/readmes site/apidocs"
2120
},
2221
"devDependencies": {
2322
"@loopback/build": "^1.7.1"

docs/site/DEVELOPING.md

+7-11
Original file line numberDiff line numberDiff line change
@@ -214,13 +214,14 @@ src/__tests__/unit/application.unit.ts
214214

215215
## API Documentation
216216

217-
We use [strong-docs](https://github.com/strongloop/strong-docs) to generate API
218-
documentation for all our packages. This documentation is generated when
219-
publishing new releases to npmjs.org and it's picked up by
220-
<http://apidocs.loopback.io/>.
217+
We use
218+
[@loopback/tsdocs](https://github.com/strongloop/loopback-next/tree/master/packages/tsdocs)
219+
to generate API documentation for all our packages. This documentation is
220+
generated when publishing new releases to npmjs.org and it's picked up by
221+
https://loopback.io/doc/en/lb4/apidocs.index.html.
221222

222-
You can preview API docs locally by opening the file `docs/apidocs.html` in your
223-
browser.
223+
You can preview API docs locally by running `npm run tsdocs` and open
224+
[apidocs/index.md](apidocs/index.md).
224225

225226
## Commit message guidelines
226227

@@ -490,16 +491,11 @@ Please register the new package in the following files:
490491
- Update [MONOREPO.md](./MONOREPO.md) - insert a new table row to describe the
491492
new package, please keep the rows sorted by package name.
492493
- Update
493-
[docs/apidocs.html](https://github.com/strongloop/loopback-next/blob/master/docs/apidocs.html) -
494-
add a link to API docs for this new package.
495494
- Update [Reserved-binding-keys.md](./Reserved-binding-keys.md) - add a link to
496495
the apidocs on Binding Keys if the new package has any.
497496
- Update
498497
[CODEOWNERS](https://github.com/strongloop/loopback-next/blob/master/CODEOWNERS) -
499498
add a new entry listing the primary maintainers (owners) of the new package.
500-
- Ask somebody from the IBM team (e.g. [@bajtos](https://github.com/bajtos) or
501-
[@raymondfeng](https://github.com/raymondfeng) to enlist the new package on
502-
<http://apidocs.loopback.io/>.
503499

504500
## Upgrading TypeScript/eslint
505501

examples/context/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,9 @@
99
"author": "IBM Corp.",
1010
"scripts": {
1111
"acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
12-
"build:apidocs": "lb-apidocs",
1312
"build": "lb-tsc es2017 --outDir dist",
1413
"build:watch": "lb-tsc es2017 --outDir dist --watch",
15-
"clean": "lb-clean *example-context*.tgz dist package api-docs",
14+
"clean": "lb-clean *example-context*.tgz dist package",
1615
"verify": "npm pack && tar xf *example-context*.tgz && tree package && npm run clean",
1716
"lint": "npm run prettier:check && npm run eslint",
1817
"lint:fix": "npm run eslint:fix && npm run prettier:fix",

examples/express-composition/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
"node": ">=8.9"
1515
},
1616
"scripts": {
17-
"build:apidocs": "lb-apidocs",
1817
"build": "lb-tsc es2017 --outDir dist",
1918
"build:watch": "lb-tsc --watch",
2019
"clean": "lb-clean dist",

examples/greeter-extension/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@
77
"node": ">=8.9"
88
},
99
"scripts": {
10-
"build:apidocs": "lb-apidocs",
1110
"build": "lb-tsc es2017 --outDir dist",
1211
"build:watch": "lb-tsc es2017 --outDir dist --watch",
13-
"clean": "lb-clean *example-greeter-extension-*.tgz dist package api-docs",
12+
"clean": "lb-clean *example-greeter-extension-*.tgz dist package",
1413
"lint": "npm run prettier:check && npm run eslint",
1514
"lint:fix": "npm run eslint:fix && npm run prettier:fix",
1615
"prettier:cli": "lb-prettier \"**/*.ts\" \"**/*.js\"",

examples/greeting-app/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@
77
"node": ">=8.9"
88
},
99
"scripts": {
10-
"build:apidocs": "lb-apidocs",
1110
"build": "lb-tsc es2017 --outDir dist",
1211
"build:watch": "lb-tsc es2017 --outDir dist --watch",
13-
"clean": "lb-clean *example-greeting-app-*.tgz dist package api-docs",
12+
"clean": "lb-clean *example-greeting-app-*.tgz dist package",
1413
"lint": "npm run prettier:check && npm run eslint",
1514
"lint:fix": "npm run eslint:fix && npm run prettier:fix",
1615
"prettier:cli": "lb-prettier \"**/*.ts\" \"**/*.js\"",

examples/hello-world/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,9 @@
99
"author": "IBM Corp.",
1010
"scripts": {
1111
"acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
12-
"build:apidocs": "lb-apidocs",
1312
"build": "lb-tsc es2017 --outDir dist",
1413
"build:watch": "lb-tsc es2017 --outDir dist --watch",
15-
"clean": "lb-clean *example-hello-world*.tgz dist package api-docs",
14+
"clean": "lb-clean *example-hello-world*.tgz dist package",
1615
"verify": "npm pack && tar xf *example-hello-world*.tgz && tree package && npm run clean",
1716
"lint": "npm run prettier:check && npm run eslint",
1817
"lint:fix": "npm run eslint:fix && npm run prettier:fix",

examples/lb3-application/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@
88
},
99
"author": "IBM Corp.",
1010
"scripts": {
11-
"build:apidocs": "lb-apidocs",
1211
"build": "lb-tsc es2017 --outDir dist",
1312
"build:watch": "lb-tsc es2017 --outDir dist --watch",
14-
"clean": "lb-clean *example-lb3-application*.tgz dist package api-docs",
13+
"clean": "lb-clean *example-lb3-application*.tgz dist package",
1514
"lint": "npm run prettier:check && npm run eslint",
1615
"lint:fix": "npm run eslint:fix && npm run prettier:fix",
1716
"prettier:cli": "lb-prettier \"**/*.ts\"",

examples/log-extension/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@
88
},
99
"author": "IBM Corp.",
1010
"scripts": {
11-
"build:apidocs": "lb-apidocs",
1211
"build": "lb-tsc es2017 --outDir dist",
1312
"build:watch": "lb-tsc es2017 --outDir dist --watch",
14-
"clean": "lb-clean *example-log-extension-*.tgz dist package api-docs",
13+
"clean": "lb-clean *example-log-extension-*.tgz dist package",
1514
"lint": "npm run prettier:check && npm run eslint",
1615
"lint:fix": "npm run eslint:fix && npm run prettier:fix",
1716
"prettier:cli": "lb-prettier \"**/*.ts\" \"**/*.js\"",

examples/rpc-server/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
"node": ">=8.9"
1111
},
1212
"scripts": {
13-
"build:apidocs": "lb-apidocs",
1413
"build": "lb-tsc es2017 --outDir dist",
1514
"build:watch": "lb-tsc es2017 --outDir dist --watch",
1615
"clean": "lb-clean dist",

examples/soap-calculator/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,9 @@
1515
},
1616
"author": "IBM Corp.",
1717
"scripts": {
18-
"build:apidocs": "lb-apidocs",
1918
"build": "lb-tsc es2017 --outDir dist",
2019
"build:watch": "lb-tsc es2017 --outDir dist --watch",
21-
"clean": "lb-clean *example-soap*.tgz dist package api-docs dist",
20+
"clean": "lb-clean *example-soap*.tgz dist package dist",
2221
"lint": "npm run prettier:check && npm run eslint",
2322
"lint:fix": "npm run eslint:fix && npm run prettier:fix",
2423
"prettier:cli": "lb-prettier \"**/*.ts\" \"**/*.js\"",

examples/todo-list/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@
88
},
99
"author": "IBM Corp.",
1010
"scripts": {
11-
"build:apidocs": "lb-apidocs",
1211
"build": "lb-tsc es2017 --outDir dist",
1312
"build:watch": "lb-tsc es2017 --outDir dist --watch",
14-
"clean": "lb-clean *example-todo-list*.tgz dist package api-docs",
13+
"clean": "lb-clean *example-todo-list*.tgz dist package",
1514
"lint": "npm run prettier:check && npm run eslint",
1615
"lint:fix": "npm run eslint:fix && npm run prettier:fix",
1716
"prettier:cli": "lb-prettier \"**/*.ts\"",

examples/todo/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,9 @@
88
},
99
"author": "IBM Corp.",
1010
"scripts": {
11-
"build:apidocs": "lb-apidocs",
1211
"build": "lb-tsc es2017 --outDir dist",
1312
"build:watch": "lb-tsc es2017 --outDir dist --watch",
14-
"clean": "lb-clean *example-todo*.tgz dist package api-docs",
13+
"clean": "lb-clean *example-todo*.tgz dist package",
1514
"lint": "npm run prettier:check && npm run eslint",
1615
"lint:fix": "npm run eslint:fix && npm run prettier:fix",
1716
"prettier:cli": "lb-prettier \"**/*.ts\"",

package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,8 @@
3636
"update-template-deps": "node bin/update-template-deps -f",
3737
"update-all-deps": "npm update && lerna exec -- npm update && npm run update-package-locks",
3838
"sync-dev-deps": "node bin/sync-dev-deps",
39-
"version": "npm run update-packages && git add \"**/package-lock.json\" && npm run update-template-deps && npm run apidocs",
39+
"version": "npm run update-packages && git add \"**/package-lock.json\" && npm run update-template-deps",
4040
"outdated": "npm outdated --depth 0 && lerna exec --no-bail \"npm outdated --depth 0\"",
41-
"apidocs": "node bin/run-lerna run build:apidocs",
4241
"tsdocs": "lerna run --scope @loopback/tsdocs build:tsdocs",
4342
"coverage:ci": "node packages/build/bin/run-nyc report --reporter=text-lcov | coveralls",
4443
"precoverage": "npm test",

packages/authentication/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@
77
},
88
"scripts": {
99
"acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
10-
"build:apidocs": "lb-apidocs",
1110
"build": "lb-tsc es2017 --outDir dist",
12-
"clean": "lb-clean loopback-authentication*.tgz dist package api-docs",
11+
"clean": "lb-clean loopback-authentication*.tgz dist package",
1312
"integration": "lb-mocha \"dist/__tests__/integration/**/*.js\"",
1413
"pretest": "npm run build",
1514
"test": "lb-mocha \"dist/__tests__/**/*.js\"",

packages/boot/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@
1010
},
1111
"scripts": {
1212
"acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
13-
"build:apidocs": "lb-apidocs",
1413
"build": "lb-tsc es2017 --outDir dist",
15-
"clean": "lb-clean loopback-boot*.tgz dist package api-docs",
14+
"clean": "lb-clean loopback-boot*.tgz dist package",
1615
"pretest": "npm run build",
1716
"integration": "lb-mocha \"dist/__tests__/integration/**/*.js\"",
1817
"test": "lb-mocha \"dist/__tests__/**/*.js\"",

packages/booter-lb3app/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@
66
"node": ">=8.9"
77
},
88
"scripts": {
9-
"build:apidocs": "lb-apidocs",
109
"build": "lb-tsc es2017 --outDir dist",
11-
"clean": "lb-clean loopback-booter-lb3app*.tgz dist package api-docs",
10+
"clean": "lb-clean loopback-booter-lb3app*.tgz dist package",
1211
"pretest": "npm run build",
1312
"test": "lb-mocha \"dist/__tests__/**/*.js\"",
1413
"verify": "npm pack && tar xf loopback-booter-lb3app*.tgz && tree package && npm run clean"
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
node_modules/
22
dist/
33
coverage/
4-
api-docs/

packages/cli/generators/project/templates/_.gitignore

-3
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,6 @@ typings/
5757
# dotenv environment variables file
5858
.env
5959

60-
# Generated apidocs
61-
api-docs/
62-
6360
# Transpiled JavaScript files from Typescript
6461
/dist
6562

packages/cli/generators/project/templates/package.json.ejs

-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
"node": ">=8.9"
1212
},
1313
"scripts": {
14-
"build:apidocs": "lb-apidocs",
1514
"build": "lb-tsc es2017 --outDir dist",
1615
"build:watch": "lb-tsc --watch",
1716
"clean": "lb-clean dist",

packages/cli/package.json

-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,6 @@
8686
"prettier": "^1.17.1",
8787
"rimraf": "^2.6.2",
8888
"source-map-support": "^0.5.12",
89-
"strong-docs": "^4.2.0",
9089
"typescript": "~3.5.1",
9190
"@loopback/authentication": "^2.1.1",
9291
"@loopback/boot": "^1.4.0",

packages/context/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@
77
},
88
"scripts": {
99
"acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
10-
"build:apidocs": "lb-apidocs",
1110
"build": "lb-tsc es2017 --outDir dist",
12-
"clean": "lb-clean loopback-context*.tgz dist package api-docs",
11+
"clean": "lb-clean loopback-context*.tgz dist package",
1312
"pretest": "npm run build",
1413
"test": "lb-mocha \"dist/__tests__/**/*.js\"",
1514
"unit": "lb-mocha \"dist/__tests__/unit/**/*.js\"",

packages/core/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,8 @@
77
},
88
"scripts": {
99
"acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
10-
"build:apidocs": "lb-apidocs",
1110
"build": "lb-tsc es2017 --outDir dist",
12-
"clean": "lb-clean loopback-core*.tgz dist package api-docs",
11+
"clean": "lb-clean loopback-core*.tgz dist package",
1312
"pretest": "npm run build",
1413
"integration": "lb-mocha \"dist/__tests__/integration/**/*.js\"",
1514
"test": "lb-mocha \"dist/__tests__/**/*.js\"",

packages/http-caching-proxy/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ await proxy.stop();
7878
## API Documentation
7979

8080
See the auto-generated documentation at
81-
[loopback.io](http://apidocs.loopback.io/@loopback%2fdocs/http-caching-proxy.html)
81+
[loopback.io](https://loopback.io/doc/en/lb4/apidocs.http-caching-proxy.html)
8282

8383
## Contributions
8484

packages/http-caching-proxy/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@
66
"node": ">=8.9"
77
},
88
"scripts": {
9-
"build:apidocs": "lb-apidocs",
109
"build": "lb-tsc es2017 --outDir dist",
11-
"clean": "lb-clean loopback-caching-proxy*.tgz dist package api-docs",
10+
"clean": "lb-clean loopback-caching-proxy*.tgz dist package",
1211
"pretest": "npm run build",
1312
"test": "lb-mocha \"dist/__tests__/**/*.js\"",
1413
"verify": "npm pack && tar xf loopback-caching-proxy*.tgz && tree package && npm run clean"

packages/http-server/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@
66
"node": ">=8.9"
77
},
88
"scripts": {
9-
"build:apidocs": "lb-apidocs",
109
"build": "lb-tsc es2017 --outDir dist",
11-
"clean": "lb-clean loopback-http-server*.tgz dist package api-docs",
10+
"clean": "lb-clean loopback-http-server*.tgz dist package",
1211
"pretest": "npm run build",
1312
"test": "lb-mocha \"dist/__tests__/**/*.js\"",
1413
"verify": "npm pack && tar xf loopback-http-server*.tgz && tree package && npm run clean"

0 commit comments

Comments
 (0)