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

docs: restructure the concepts page #6085

merged 1 commit into from
Aug 14, 2020

Conversation

jannyHou
Copy link
Contributor

connect to #5776

I renamed the concept items to use the singular terms.

fold subsections:
Screen Shot 2020-08-10 at 3 31 45 PM

unfold subsections, part 1:
Screen Shot 2020-08-10 at 3 32 10 PM

unfold subsections, part 2:
Screen Shot 2020-08-10 at 3 32 19 PM

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 👈

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.

Copy link
Member

@dhmlau dhmlau left a comment

Choose a reason for hiding this comment

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

Thanks @jannyHou. Your PR LGTM in general. I have one concern about renaming the html path, please see https://github.com/strongloop/loopback-next/pull/6085/files#r468144288. Thanks.

@raymondfeng
Copy link
Contributor

I start to lean toward getting rid of TypeScript and move Decorators and Mixins to other sections.

  • Decorators are used to supply metadata (it seems weird to list specific decorators under TypeScript)
  • Mixins are a way to compose LoopBack 4 classes

@jannyHou
Copy link
Contributor Author

Thanks @raymondfeng fair enough, I moved them into "Core", see the updated doc:
Screen Shot 2020-08-11 at 6 37 09 PM

@agnes512
Copy link
Contributor

Let's update https://loopback.io/doc/en/lb4/index.html#how-is-our-documentation-organized

@agnes512
Copy link
Contributor

Are we changing the order in this PR?

@jannyHou
Copy link
Contributor Author

@agnes512 Thanks for the suggestion in #6085 (comment) good catch, and yes the order is changed as well.

Copy link
Contributor

@agnes512 agnes512 left a comment

Choose a reason for hiding this comment

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

:shipit:

@jannyHou jannyHou merged commit fe98121 into master Aug 14, 2020
@jannyHou jannyHou deleted the concept-reorg branch August 14, 2020 04:51
Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

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

Nice improvement! ❤️

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 👍🏻

@dhmlau dhmlau mentioned this pull request Aug 26, 2020
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants