@loopback/docs 6.0.2 → 6.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (76) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/package.json +4 -4
  3. package/site/Application-generator.md +1 -1
  4. package/site/Getting-started.md +1 -1
  5. package/site/Where-filter.md +1 -1
  6. package/site/apidocs/openapi-v3.requestbody.array.md +1 -1
  7. package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +16 -0
  8. package/site/changelogs/examples/access-control-migration/CHANGELOG.md +16 -0
  9. package/site/changelogs/examples/binding-resolution/CHANGELOG.md +16 -0
  10. package/site/changelogs/examples/context/CHANGELOG.md +16 -0
  11. package/site/changelogs/examples/express-composition/CHANGELOG.md +16 -0
  12. package/site/changelogs/examples/file-transfer/CHANGELOG.md +16 -0
  13. package/site/changelogs/examples/graphql/CHANGELOG.md +16 -0
  14. package/site/changelogs/examples/greeter-extension/CHANGELOG.md +16 -0
  15. package/site/changelogs/examples/greeting-app/CHANGELOG.md +16 -0
  16. package/site/changelogs/examples/hello-world/CHANGELOG.md +16 -0
  17. package/site/changelogs/examples/lb3-application/CHANGELOG.md +16 -0
  18. package/site/changelogs/examples/log-extension/CHANGELOG.md +16 -0
  19. package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +16 -0
  20. package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +16 -0
  21. package/site/changelogs/examples/passport-login/CHANGELOG.md +16 -0
  22. package/site/changelogs/examples/references-many/CHANGELOG.md +16 -0
  23. package/site/changelogs/examples/rest-crud/CHANGELOG.md +16 -0
  24. package/site/changelogs/examples/rpc-server/CHANGELOG.md +16 -0
  25. package/site/changelogs/examples/soap-calculator/CHANGELOG.md +16 -0
  26. package/site/changelogs/examples/socketio/CHANGELOG.md +16 -0
  27. package/site/changelogs/examples/todo/CHANGELOG.md +16 -0
  28. package/site/changelogs/examples/todo-jwt/CHANGELOG.md +16 -0
  29. package/site/changelogs/examples/todo-list/CHANGELOG.md +16 -0
  30. package/site/changelogs/examples/validation-app/CHANGELOG.md +16 -0
  31. package/site/changelogs/examples/webpack/CHANGELOG.md +19 -0
  32. package/site/changelogs/extensions/apiconnect/CHANGELOG.md +16 -0
  33. package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +16 -0
  34. package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +16 -0
  35. package/site/changelogs/extensions/context-explorer/CHANGELOG.md +16 -0
  36. package/site/changelogs/extensions/cron/CHANGELOG.md +16 -0
  37. package/site/changelogs/extensions/graphql/CHANGELOG.md +16 -0
  38. package/site/changelogs/extensions/health/CHANGELOG.md +16 -0
  39. package/site/changelogs/extensions/logging/CHANGELOG.md +16 -0
  40. package/site/changelogs/extensions/metrics/CHANGELOG.md +16 -0
  41. package/site/changelogs/extensions/pooling/CHANGELOG.md +19 -0
  42. package/site/changelogs/extensions/sequelize/CHANGELOG.md +19 -0
  43. package/site/changelogs/extensions/socketio/CHANGELOG.md +16 -0
  44. package/site/changelogs/extensions/typeorm/CHANGELOG.md +16 -0
  45. package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +16 -0
  46. package/site/changelogs/packages/authentication/CHANGELOG.md +16 -0
  47. package/site/changelogs/packages/authorization/CHANGELOG.md +16 -0
  48. package/site/changelogs/packages/boot/CHANGELOG.md +16 -0
  49. package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +16 -0
  50. package/site/changelogs/packages/build/CHANGELOG.md +19 -0
  51. package/site/changelogs/packages/cli/CHANGELOG.md +12 -0
  52. package/site/changelogs/packages/context/CHANGELOG.md +20 -0
  53. package/site/changelogs/packages/core/CHANGELOG.md +19 -0
  54. package/site/changelogs/packages/eslint-config/CHANGELOG.md +16 -0
  55. package/site/changelogs/packages/express/CHANGELOG.md +16 -0
  56. package/site/changelogs/packages/filter/CHANGELOG.md +8 -0
  57. package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +16 -0
  58. package/site/changelogs/packages/http-server/CHANGELOG.md +16 -0
  59. package/site/changelogs/packages/metadata/CHANGELOG.md +16 -0
  60. package/site/changelogs/packages/model-api-builder/CHANGELOG.md +16 -0
  61. package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +16 -0
  62. package/site/changelogs/packages/openapi-v3/CHANGELOG.md +16 -0
  63. package/site/changelogs/packages/repository/CHANGELOG.md +19 -0
  64. package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +16 -0
  65. package/site/changelogs/packages/repository-tests/CHANGELOG.md +16 -0
  66. package/site/changelogs/packages/rest/CHANGELOG.md +16 -0
  67. package/site/changelogs/packages/rest-crud/CHANGELOG.md +16 -0
  68. package/site/changelogs/packages/rest-explorer/CHANGELOG.md +16 -0
  69. package/site/changelogs/packages/security/CHANGELOG.md +16 -0
  70. package/site/changelogs/packages/service-proxy/CHANGELOG.md +16 -0
  71. package/site/changelogs/packages/testlab/CHANGELOG.md +16 -0
  72. package/site/changelogs/packages/tsdocs/CHANGELOG.md +19 -0
  73. package/site/migration/auth/passport.md +2 -2
  74. package/site/migration/mounting-lb3app.md +1 -1
  75. package/site/readmes/loopback-next/examples/webpack/README.md +1 -1
  76. package/site/readmes/loopback-next/sandbox/loopback.io/README.md +147 -0
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.http-caching-proxy.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [5.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/http-caching-proxy@5.1.1...@loopback/http-caching-proxy@5.1.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/http-caching-proxy
19
+
20
+
21
+
22
+
23
+
24
+ ## [5.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/http-caching-proxy@5.1.0...@loopback/http-caching-proxy@5.1.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/http-caching-proxy
27
+
28
+
29
+
30
+
31
+
16
32
  # [5.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/http-caching-proxy@5.0.0...@loopback/http-caching-proxy@5.1.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.http-server.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [5.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/http-server@5.1.1...@loopback/http-server@5.1.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/http-server
19
+
20
+
21
+
22
+
23
+
24
+ ## [5.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/http-server@5.1.0...@loopback/http-server@5.1.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/http-server
27
+
28
+
29
+
30
+
31
+
16
32
  # [5.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/http-server@5.0.0...@loopback/http-server@5.1.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.metadata.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [6.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/metadata@6.1.1...@loopback/metadata@6.1.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/metadata
19
+
20
+
21
+
22
+
23
+
24
+ ## [6.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/metadata@6.1.0...@loopback/metadata@6.1.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/metadata
27
+
28
+
29
+
30
+
31
+
16
32
  # [6.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/metadata@6.0.0...@loopback/metadata@6.1.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.model-api-builder.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [5.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/model-api-builder@5.1.1...@loopback/model-api-builder@5.1.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/model-api-builder
19
+
20
+
21
+
22
+
23
+
24
+ ## [5.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/model-api-builder@5.1.0...@loopback/model-api-builder@5.1.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/model-api-builder
27
+
28
+
29
+
30
+
31
+
16
32
  # [5.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/model-api-builder@5.0.0...@loopback/model-api-builder@5.1.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.openapi-spec-builder.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [6.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/openapi-spec-builder@6.1.1...@loopback/openapi-spec-builder@6.1.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/openapi-spec-builder
19
+
20
+
21
+
22
+
23
+
24
+ ## [6.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/openapi-spec-builder@6.1.0...@loopback/openapi-spec-builder@6.1.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/openapi-spec-builder
27
+
28
+
29
+
30
+
31
+
16
32
  # [6.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/openapi-spec-builder@6.0.0...@loopback/openapi-spec-builder@6.1.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.openapi-v3.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [9.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/openapi-v3@9.1.1...@loopback/openapi-v3@9.1.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/openapi-v3
19
+
20
+
21
+
22
+
23
+
24
+ ## [9.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/openapi-v3@9.1.0...@loopback/openapi-v3@9.1.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/openapi-v3
27
+
28
+
29
+
30
+
31
+
16
32
  # [9.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/openapi-v3@9.0.0...@loopback/openapi-v3@9.1.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.repository.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [6.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/repository@6.1.1...@loopback/repository@6.1.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/repository
19
+
20
+
21
+
22
+
23
+
24
+ ## [6.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/repository@6.1.0...@loopback/repository@6.1.1) (2023-07-17)
25
+
26
+
27
+ ### Bug Fixes
28
+
29
+ * remove unnecessary types ([cb44c08](https://github.com/loopbackio/loopback-next/commit/cb44c081e34db3807414c14e3f4b6c6fa370f207))
30
+
31
+
32
+
33
+
34
+
16
35
  # [6.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/repository@6.0.0...@loopback/repository@6.1.0) (2023-06-28)
17
36
 
18
37
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.repository-json-schema.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [7.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/repository-json-schema@7.1.1...@loopback/repository-json-schema@7.1.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/repository-json-schema
19
+
20
+
21
+
22
+
23
+
24
+ ## [7.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/repository-json-schema@7.1.0...@loopback/repository-json-schema@7.1.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/repository-json-schema
27
+
28
+
29
+
30
+
31
+
16
32
  # [7.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/repository-json-schema@7.0.0...@loopback/repository-json-schema@7.1.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.repository-tests.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [0.23.2](https://github.com/loopbackio/loopback-next/compare/@loopback/repository-tests@0.23.1...@loopback/repository-tests@0.23.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/repository-tests
19
+
20
+
21
+
22
+
23
+
24
+ ## [0.23.1](https://github.com/loopbackio/loopback-next/compare/@loopback/repository-tests@0.23.0...@loopback/repository-tests@0.23.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/repository-tests
27
+
28
+
29
+
30
+
31
+
16
32
  # [0.23.0](https://github.com/loopbackio/loopback-next/compare/@loopback/repository-tests@0.22.0...@loopback/repository-tests@0.23.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.rest.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [13.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/rest@13.1.1...@loopback/rest@13.1.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/rest
19
+
20
+
21
+
22
+
23
+
24
+ ## [13.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/rest@13.1.0...@loopback/rest@13.1.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/rest
27
+
28
+
29
+
30
+
31
+
16
32
  # [13.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/rest@13.0.0...@loopback/rest@13.1.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.rest-crud.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [0.17.2](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-crud@0.17.1...@loopback/rest-crud@0.17.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/rest-crud
19
+
20
+
21
+
22
+
23
+
24
+ ## [0.17.1](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-crud@0.17.0...@loopback/rest-crud@0.17.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/rest-crud
27
+
28
+
29
+
30
+
31
+
16
32
  # [0.17.0](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-crud@0.16.0...@loopback/rest-crud@0.17.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.rest-explorer.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [6.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-explorer@6.1.1...@loopback/rest-explorer@6.1.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/rest-explorer
19
+
20
+
21
+
22
+
23
+
24
+ ## [6.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-explorer@6.1.0...@loopback/rest-explorer@6.1.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/rest-explorer
27
+
28
+
29
+
30
+
31
+
16
32
  # [6.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-explorer@6.0.0...@loopback/rest-explorer@6.1.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.security.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [0.10.2](https://github.com/loopbackio/loopback-next/compare/@loopback/security@0.10.1...@loopback/security@0.10.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/security
19
+
20
+
21
+
22
+
23
+
24
+ ## [0.10.1](https://github.com/loopbackio/loopback-next/compare/@loopback/security@0.10.0...@loopback/security@0.10.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/security
27
+
28
+
29
+
30
+
31
+
16
32
  # [0.10.0](https://github.com/loopbackio/loopback-next/compare/@loopback/security@0.9.0...@loopback/security@0.10.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.service-proxy.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [6.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/service-proxy@6.1.1...@loopback/service-proxy@6.1.2) (2023-08-15)
17
+
18
+ **Note:** Version bump only for package @loopback/service-proxy
19
+
20
+
21
+
22
+
23
+
24
+ ## [6.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/service-proxy@6.1.0...@loopback/service-proxy@6.1.1) (2023-07-17)
25
+
26
+ **Note:** Version bump only for package @loopback/service-proxy
27
+
28
+
29
+
30
+
31
+
16
32
  # [6.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/service-proxy@6.0.0...@loopback/service-proxy@6.1.0) (2023-06-28)
17
33
 
18
34
 
@@ -13,6 +13,22 @@ permalink: /doc/en/lb4/changelog.testlab.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [6.1.3](https://github.com/loopbackio/loopback-next/compare/@loopback/testlab@6.1.2...@loopback/testlab@6.1.3) (2023-09-12)
17
+
18
+ **Note:** Version bump only for package @loopback/testlab
19
+
20
+
21
+
22
+
23
+
24
+ ## [6.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/testlab@6.1.1...@loopback/testlab@6.1.2) (2023-08-15)
25
+
26
+ **Note:** Version bump only for package @loopback/testlab
27
+
28
+
29
+
30
+
31
+
16
32
  ## [6.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/testlab@6.1.0...@loopback/testlab@6.1.1) (2023-07-17)
17
33
 
18
34
  **Note:** Version bump only for package @loopback/testlab
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.tsdocs.html
13
13
  All notable changes to this project will be documented in this file.
14
14
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
15
15
 
16
+ ## [5.1.2](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@5.1.1...@loopback/tsdocs@5.1.2) (2023-08-15)
17
+
18
+
19
+ ### Bug Fixes
20
+
21
+ * apidocs generation ([1b6daa6](https://github.com/loopbackio/loopback-next/commit/1b6daa6848b8deb80f53fbac604fc8f94967b028))
22
+
23
+
24
+
25
+
26
+
27
+ ## [5.1.1](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@5.1.0...@loopback/tsdocs@5.1.1) (2023-07-17)
28
+
29
+ **Note:** Version bump only for package @loopback/tsdocs
30
+
31
+
32
+
33
+
34
+
16
35
  # [5.1.0](https://github.com/loopbackio/loopback-next/compare/@loopback/tsdocs@5.0.0...@loopback/tsdocs@5.1.0) (2023-06-28)
17
36
 
18
37
 
@@ -65,8 +65,8 @@ You can use this example to see how to:
65
65
 
66
66
  This guide is further divided into two sections:
67
67
 
68
- - [How to migrate Non-OAuth2 strategies like basic, local, etc.](#Non-OAuth2-Strategies)
69
- - [How to migrate OAuth2 strategies like Facebook, Google, etc.](#OAuth2-Strategies)
68
+ - [How to migrate Non-OAuth2 strategies like basic, local, etc.](#non-oauth2-strategies)
69
+ - [How to migrate OAuth2 strategies like Facebook, Google, etc.](#oauth2-strategies)
70
70
 
71
71
  In each of these sections the following are explained:
72
72
 
@@ -25,7 +25,7 @@ Explorer.
25
25
 
26
26
  {% include note.html content="
27
27
  If you are not familiar with LoopBack 4, visit
28
- [Getting started](Getting-started.md) for an introduction.
28
+ [Getting started](../Getting-started.md) for an introduction.
29
29
  " %}
30
30
 
31
31
  Follow
@@ -24,7 +24,7 @@ npx webpack --config-name web
24
24
  Now `dist/bundle-web.js` can be used for HTML pages, for example:
25
25
 
26
26
  ```html
27
- <!DOCTYPE html>
27
+ <!doctype html>
28
28
  <html>
29
29
  <head>
30
30
  <title>LoopBack 4 Core Modules WebPack Demo</title>
@@ -0,0 +1,147 @@
1
+ # loopback.io
2
+
3
+ LoopBack community site, http://loopback.io. This website now includes the LoopBack documentation.
4
+
5
+ NOTE: The website is served from the `gh-pages` branch.
6
+
7
+ This repository is provided under the [MIT License](LICENSE).
8
+
9
+
10
+ ## Setup
11
+
12
+ To preview the website locally:
13
+
14
+ 1. Install [Ruby and Bundler](https://help.github.com/articles/setting-up-your-pages-site-locally-with-jekyll/) if you don't have them already.
15
+
16
+ 2. Clone this repo (you might use the SSH URL instead of HTTPS).:
17
+
18
+ ```
19
+ git clone https://github.com/loopbackio/loopback.io.git
20
+ ```
21
+
22
+ 3. `cd` to the repository directory and run the following command:
23
+
24
+ ```
25
+ $ cd loopback.io
26
+ $ bundle install
27
+ ```
28
+
29
+ Bundler will look in the Gemfile for which gems to install. The `github-pages` gem includes the same version of Jekyll and other dependencies as used by GitHub Pages, so that your local setup mirrors GitHub Pages as closely as possible.
30
+
31
+ ## Run and view site locally
32
+
33
+ Run Jekyll using the following command:
34
+
35
+ ```
36
+ $ npm start
37
+ ```
38
+
39
+ Then, load [http://localhost:4001/](http://localhost:4001/) on your browser.
40
+
41
+ NOTE: The docs part will be at [http://localhost:4001/doc](http://localhost:4001/doc). It's not yet linked from the main "overview" part of the site, but will be once we launch (RSN).
42
+
43
+ ## Formatting
44
+
45
+ Jekyll uses a variant of Markdown known as [Kramdown](http://kramdown.gettalong.org/quickref.html).
46
+
47
+ Jekyll uses the [Liquid template engine](http://liquidmarkup.org/) for templating.
48
+
49
+ ## Incorporating external READMEs
50
+
51
+ The documentation incorporates README files from a number of LoopBack example repositories.
52
+ We use the [get-readmes](https://github.com/strongloop/get-readmes) utility to fetch
53
+ the README files directly from GitHub. Here is how to update the READMEs
54
+
55
+ 1. `npm install` (_first time/setup only_)
56
+ 2. `npm run fetch-readmes`
57
+
58
+ From there, the README markdown files are incorporated into documentation articles
59
+ using the standard Jekyll "include" syntax as follows (for example):
60
+
61
+ ```
62
+ ---
63
+ title: "Angular example app"
64
+ lang: en
65
+ layout: readme
66
+ source: loopback-example-angular
67
+ keywords: LoopBack
68
+ tags:
69
+ sidebar: lb2_sidebar
70
+ permalink: /doc/en/lb2/Angular-example-app.html
71
+ summary: A brief tutorial on creating an Angular client app using the Loopback AngularJS SDK.
72
+ ---
73
+
74
+ {% include readmes/loopback-example-angular.md %}
75
+ ```
76
+
77
+ ## Incorporating updates from loopback-next
78
+
79
+ We use a node script `update-lb4-docs` to copy over contents from loopback-next
80
+ repository using `@loopback/docs` package. The script is responsible for copying
81
+ over the markdown documentation and related tables, as well as the sidebar used
82
+ for LoopBack 4 content. The changes are then picked up as part of Travis CI's
83
+ builds along with README update scripts and deployed to GitHub Pages once
84
+ successful. The `upgrade-swagger-ui.js` script is also run as part of the
85
+ builds. If you'd like to make documentation changes for LoopBack 4, please do so
86
+ on its own [repository](https://github.com/loopbackio/loopback-next/).
87
+
88
+ ### Linting Readmes
89
+
90
+ There is an additional `npm script` that "lints" the readmes for markdown formatting problems. It is currently "experimental", see [this issue](https://github.com/loopbackio/loopback.io/issues/49#issuecomment-253672668) for more info.
91
+
92
+ You can run this script thus:
93
+
94
+ ```js
95
+ $ npm run lint-readmes
96
+ ```
97
+
98
+ ## LoopBack.io Docs Search
99
+
100
+ Docs Search is powered by [IBM Watson Discovery](https://www.ibm.com/watson/services/discovery/).
101
+
102
+ ### How it works
103
+
104
+ There are two parts of work to get this working:
105
+
106
+ 1. The [Discovery service](https://www.ibm.com/watson/services/discovery/) is one of the services provided by [IBM Cloud](https://cloud.ibm.com/). A collection is created with loopback.io as the URL we'd like to sync.
107
+
108
+ 2. The [IBM Cloud function](https://www.ibm.com/cloud/functions) is used for the search function calling the discovery service and parse the output in the form that the LoopBack web site understands.
109
+
110
+ ### Front End
111
+
112
+ Each documentation page has a search bar the top. The search will redirect the
113
+ user to a `/search` page to show the results. The results are retrieved from a
114
+ [IBM Cloud Function](https://www.ibm.com/cloud/functions) that acts as a proxy
115
+ to protect Watson Discovery credentials. The search bar also contains a hidden
116
+ form input that sets the `sidebar` value and Watson Discovery filters content
117
+ based on this value to return context aware results. Ex: Searching for the word
118
+ `controller` from a LoopBack 4 documentation page will return LoopBack 4 results.
119
+ To search all documents you can search from the `/search` page. Community Docs
120
+ and Contribution docs are included in all results.
121
+
122
+ ### Cloud Function
123
+
124
+ The code for the Cloud function can be found [here](https://github.com/strongloop/loopback.io-search).
125
+ It is deployed to the same account and must be edited directly in IBM Cloud
126
+ (formerly BlueMix). The repository exists to document code changes and have peer
127
+ reviews. Credentials for accessing the Cloud Function can be obtained from Diana Lau OR you can ask them to re-deploy changes.
128
+
129
+ #### Your own version
130
+
131
+ You can deploy the code on your own IBM Cloud account and upload the URL for
132
+ Discovery in [search.html](https://github.com/loopbackio/loopback.io/blob/gh-pages/_layouts/search.html).
133
+
134
+
135
+ ## Contributing
136
+
137
+ This project uses [DCO](https://developercertificate.org/). Be sure to sign off
138
+ your commits using the `-s` flag or adding `Signed-off-By: Name<Email>` in the
139
+ commit message.
140
+
141
+ **Example**
142
+
143
+ ```
144
+ git commit -s -m "feat: my commit message"
145
+ ```
146
+
147
+ Also see the [Contributing to LoopBack documentation](https://loopback.io/doc/en/contrib/doc-contrib.html) to get you started.