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

docs: restructure the concepts page #6085

Merged
merged 1 commit into from
Aug 14, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/site/Components.md → docs/site/Component.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
lang: en
title: 'Components'
title: 'Component'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI, Concepts
sidebar: lb4_sidebar
permalink: /doc/en/lb4/Components.html
permalink: /doc/en/lb4/Component.html
redirect_from: /doc/en/lb4/Components.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 to use singular form in permalink and add redirect_from to preserve existing links 👍🏻

---

## Overview
Expand Down
5 changes: 3 additions & 2 deletions docs/site/Controllers.md → docs/site/Controller.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
lang: en
title: 'Controllers'
title: 'Controller'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI, Concepts
sidebar: lb4_sidebar
permalink: /doc/en/lb4/Controllers.html
permalink: /doc/en/lb4/Controller.html
redirect_from: /doc/en/lb4/Controllers.html
---

## Overview
Expand Down
5 changes: 3 additions & 2 deletions docs/site/DataSources.md → docs/site/DataSource.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
lang: en
title: 'DataSources'
title: 'DataSource'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
permalink: /doc/en/lb4/DataSources.html
permalink: /doc/en/lb4/DataSource.html
redirect_from: /doc/en/lb4/DataSources.html
---

## Overview
Expand Down
5 changes: 3 additions & 2 deletions docs/site/Interceptors.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
lang: en
title: 'Interceptors'
title: 'Interceptor'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI, Interceptor
sidebar: lb4_sidebar
permalink: /doc/en/lb4/Interceptors.html
permalink: /doc/en/lb4/Interceptor.html
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I understand the rationale behind changing the html path name is to make it consistent with the title. If that's the case, can we keep the same html and add the redirect_to? Renaming the html path will cause broken links in other docs or articles (mostly external ones, not part of LB docs). WDYT?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dhmlau 👍 Fair enough, adding.

redirect_from: /doc/en/lb4/Interceptors.html
---

## Overview
Expand Down
5 changes: 3 additions & 2 deletions docs/site/Repositories.md → docs/site/Repository.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
lang: en
title: 'Repositories'
title: 'Repository'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI, Repository
sidebar: lb4_sidebar
permalink: /doc/en/lb4/Repositories.html
permalink: /doc/en/lb4/Repository.html
redirect_from: /doc/en/lb4/Repositories.html
---

A `Repository` represents a specialized `Service` interface that provides
Expand Down
5 changes: 3 additions & 2 deletions docs/site/Routes.md → docs/site/Route.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
lang: en
title: 'Routes'
title: 'Route'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
permalink: /doc/en/lb4/Routes.html
permalink: /doc/en/lb4/Route.html
redirect_from: /doc/en/lb4/Routes.html
---

## Overview
Expand Down
5 changes: 3 additions & 2 deletions docs/site/Services.md → docs/site/Service.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
lang: en
title: 'Services'
title: 'Service'
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
sidebar: lb4_sidebar
permalink: /doc/en/lb4/Services.html
permalink: /doc/en/lb4/Service.html
redirect_from: /doc/en/lb4/Services.html
---

## Overview
Expand Down
4 changes: 2 additions & 2 deletions docs/site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ We are using the documentation system based on four quadrants, as described at
- Problem-oriented `How-to Guides` provide recipes to solve specific goals you
may encounter while building a LoopBack project.

- Understanding-oriented `Behind the scenes` pages provide background and
context, wider view and deeper knowledge about the framework.
- Understanding-oriented `Concepts` pages provide the explanation of
architecture concepts, wider view and deeper knowledge about the framework.

- Information-oriented `Reference guides` provide technical description of the
machinery and how to use it.
198 changes: 104 additions & 94 deletions docs/site/sidebars/lb4_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ children:
url: Metrics.html
output: 'web, pdf'

- title: 'Behind the Scenes'
- title: 'Concepts'
url: Behind-the-scene.html
output: 'web, pdf'
children:
Expand All @@ -403,146 +403,156 @@ children:
url: Crafting-LoopBack-4.html
output: 'web, pdf'

- title: 'Application'
url: Application.html
- title: 'Core'
output: 'web, pdf'
children:

- title: 'Server'
url: Server.html
output: 'web, pdf'
- title: 'Application'
url: Application.html
output: 'web, pdf'

- title: 'Controllers'
url: Controllers.html
output: 'web, pdf'
- title: 'Component'
url: Component.html
output: 'web, pdf'

- title: 'Models'
url: Model.html
output: 'web, pdf'
- title: 'Context'
url: Context.html
output: 'web, pdf'

- title: 'Relations'
url: Relations.html
output: 'web, pdf'
children:
- title: 'Binding'
url: Binding.html
output: 'web, pdf'

- title: 'HasMany Relation'
url: HasMany-relation.html
- title: 'Dependency Injection'
url: Dependency-injection.html
output: 'web, pdf'

- title: 'BelongsTo Relation'
url: BelongsTo-relation.html
- title: 'Interceptor'
url: Interceptor.html
output: 'web, pdf'

- title: 'HasOne Relation'
url: HasOne-relation.html
- title: 'Life Cycle Event and Observer'
url: Life-cycle.html
output: 'web, pdf'

- title: 'HasManyThrough Relation'
url: HasManyThrough-relation.html
- title: 'Service'
url: Service.html
output: 'web, pdf'

- title: 'DataSources'
url: DataSources.html
output: 'web, pdf'
- title: 'Booter'
url: Booting-an-Application.html
output: 'web, pdf'

- title: 'Repositories'
url: Repositories.html
output: 'web, pdf'
children:
- title: 'Decorators'
url: Decorators.html
output: 'web, pdf'
children:

- title: 'Services'
url: Services.html
output: 'web, pdf'
- title: 'OpenAPI Decorators'
url: Decorators_openapi.html
output: 'web, pdf'

- title: 'Interceptors'
url: Interceptors.html
output: 'web, pdf'
- title: 'Dependency Injection Decorator'
url: Decorators_inject.html
output: 'web, pdf'

- title: 'Life cycle events and observers'
url: Life-cycle.html
output: 'web, pdf'
- title: 'Authentication Decorator'
url: Decorators_authenticate.html
output: 'web, pdf'

- title: 'Routes'
url: Routes.html
output: 'web, pdf'
- title: 'Service Decorators'
url: Decorators_service.html
output: 'web, pdf'

- title: 'Repository Decorators'
url: Decorators_repository.html
output: 'web, pdf'

- title: 'Sequence'
url: Sequence.html
- title: 'Mixin'
url: Mixin.html
output: 'web, pdf'

- title: 'REST APIs'
output: 'web, pdf'
children:

- title: 'Middleware based sequence'
url: REST-middleware-sequence.html
- title: 'Server'
url: Server.html
output: 'web, pdf'

- title: 'Action based sequence'
url: REST-action-sequence.html
- title: 'Sequence'
url: Sequence.html
output: 'web, pdf'
children:

- title: 'Routing requests'
url: Routing-requests.html
output: 'web, pdf'
- title: 'Middleware based sequence'
url: REST-middleware-sequence.html
output: 'web, pdf'

- title: 'Parsing requests'
url: Parsing-requests.html
output: 'web, pdf'
- title: 'Action based sequence'
url: REST-action-sequence.html
output: 'web, pdf'

- title: 'Middleware'
url: Middleware.html
output: 'web, pdf'
- title: 'Routing requests'
url: Routing-requests.html
output: 'web, pdf'

- title: 'Decorators'
url: Decorators.html
output: 'web, pdf'
children:
- title: 'Parsing requests'
url: Parsing-requests.html
output: 'web, pdf'

- title: 'OpenAPI Decorators'
url: Decorators_openapi.html
- title: 'Middleware'
url: Middleware.html
output: 'web, pdf'

- title: 'Dependency Injection Decorator'
url: Decorators_inject.html
- title: 'Route'
url: Route.html
output: 'web, pdf'

- title: 'Authentication Decorator'
url: Decorators_authenticate.html
- title: 'Controller'
url: Controller.html
output: 'web, pdf'

- title: 'Service Decorators'
url: Decorators_service.html
- title: 'Request/response cycle'
url: Request-response-cycle.html
output: 'web, pdf'

- title: 'Repository Decorators'
url: Decorators_repository.html
- title: 'Data Access'
output: 'web, pdf'
children:

- title: 'Model'
url: Model.html
output: 'web, pdf'

- title: 'Mixins'
url: Mixin.html
output: 'web, pdf'
- title: 'Relations'
url: Relations.html
output: 'web, pdf'
children:

- title: 'Context'
url: Context.html
output: 'web, pdf'
- title: 'HasMany Relation'
url: HasMany-relation.html
output: 'web, pdf'

- title: 'Binding'
url: Binding.html
output: 'web, pdf'
- title: 'BelongsTo Relation'
url: BelongsTo-relation.html
output: 'web, pdf'

- title: 'Dependency Injection'
url: Dependency-injection.html
output: 'web, pdf'
children:
- title: 'HasOne Relation'
url: HasOne-relation.html
output: 'web, pdf'

- title: 'Components'
url: Components.html
output: 'web, pdf'
- title: 'HasManyThrough Relation'
url: HasManyThrough-relation.html
output: 'web, pdf'

- title: 'Request/response cycle'
url: Request-response-cycle.html
output: 'web, pdf'
- title: 'Repository'
url: Repository.html
output: 'web, pdf'

- title: 'Booting an Application'
url: Booting-an-Application.html
output: 'web, pdf'
- title: 'DataSource'
url: DataSource.html
output: 'web, pdf'

- title: 'Best practices'
url: Best-practices.html
Expand Down