Skip to content

Commit

Permalink
docs: register http-server in docs
Browse files Browse the repository at this point in the history
- Add CODEOWNERS entry
- Add apidocs entry
- Add MONOREPO entry
- Add missing description to package.json
  • Loading branch information
bajtos committed Jun 12, 2018
1 parent 6911e34 commit 140ca5f
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 3 deletions.
1 change: 1 addition & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ packages/authentication/* @bajtos @raymondfeng
packages/boot/* @raymondfeng @virkt25
packages/build/* @bajtos @raymondfeng
packages/http-caching-proxy/* @bajtos
packages/http-server/* @hacksparrow @bajtos
packages/cli/* @raymondfeng @shimks
packages/context/* @bajtos @raymondfeng
packages/core/* @bajtos @raymondfeng
Expand Down
3 changes: 2 additions & 1 deletion docs/apidocs.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,10 @@ <h3>List of packages</h3>
<ul>
<li><a href="./authentication.html">@loopback/authentication</a></li>
<li><a href="./boot.html">@loopback/boot</a></li>
<li><a href="./caching-proxy.html">@loopback/caching-proxy</a></li>
<li><a href="./context.html">@loopback/context</a></li>
<li><a href="./core.html">@loopback/core</a></li>
<li><a href="./http-caching-proxy.html">@loopback/http-caching-proxy</a></li>
<li><a href="./http-server.html">@loopback/http-server</a></li>
<li><a href="./metadata.html">@loopback/metadata</a></li>
<li><a href="./openapi-spec-builder.html">@loopback/openapi-spec-builder</a></li>
<li><a href="./openapi-v3-types.html">@loopback/openapi-v3-types</a></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/site/MONOREPO.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,15 @@ The [loopback-next](https://github.com/strongloop/loopback-next) repository uses
| [authentication](packages/authentication) | @loopback/authentication | A component for authentication support |
| [boot](packages/boot) | @loopback/boot | Convention based Bootstrapper and Booters |
| [build](packages/build) | @loopback/build | A set of common scripts and default configurations to build LoopBack 4 or other TypeScript modules |
| [http-caching-proxy](packages/http-caching-proxy) | @loopback/http-caching-proxy | A caching HTTP proxy for integration tests. NOT SUITABLE FOR PRODUCTION USE! |
| [cli](packages/cli) | @loopback/cli | CLI for LoopBack 4 |
| [context](packages/context) | @loopback/context | Facilities to manage artifacts and their dependencies in your Node.js applications. The module exposes TypeScript/JavaScript APIs and decorators to register artifacts, declare dependencies, and resolve artifacts by keys. It also serves as an IoC container to support dependency injection. |
| [core](packages/core) | @loopback/core | Define and implement core constructs such as Application and Component |
| [example-todo](examples/todo) | _(private)_ | A basic tutorial for getting started with Loopback 4 |
| [example-hello-world](examples/hello-world) | _(private)_ | A simple hello-world application using LoopBack 4 |
| [example-log-extension](examples/log-extension) | _(private)_ | An example showing how to write a complex log extension for LoopBack 4 |
| [example-rpc-server](examples/rpc-server) | _(private)_ | An example RPC server and application to demonstrate the creation of your own custom server |
| [http-caching-proxy](packages/http-caching-proxy) | @loopback/http-caching-proxy | A caching HTTP proxy for integration tests. NOT SUITABLE FOR PRODUCTION USE! |
| [http-server](packages/http-server) | @loopback/http-server | A wrapper for creating HTTP/HTTPS servers |
| [metadata](packages/metadata) | @loopback/metadata | Utilities to help developers implement TypeScript decorators, define/merge metadata, and inspect metadata |
| [openapi-spec-builder](packages/openapi-spec-builder) | @loopback/openapi-spec-builder | Builders to create OpenAPI (Swagger) specification documents in tests |
| [openapi-v3](packages/openapi-v3) | @loopback/openapi-v3 | Decorators that annotate LoopBack artifacts with OpenAPI v3 metadata and utilities that transform LoopBack metadata to OpenAPI v3 specifications |
Expand Down
2 changes: 1 addition & 1 deletion packages/http-server/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@loopback/http-server",
"version": "0.1.3",
"description": "",
"description": "A wrapper for creating HTTP/HTTPS servers",
"engines": {
"node": ">=8"
},
Expand Down

0 comments on commit 140ca5f

Please sign in to comment.