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

Auth doc refactor #5598

Merged
merged 6 commits into from
Jun 11, 2020
Merged

Auth doc refactor #5598

merged 6 commits into from
Jun 11, 2020

Conversation

jannyHou
Copy link
Contributor

@jannyHou jannyHou commented May 28, 2020

Links to #5294

The first auth doc refactor PR: overview page

Please review file docs/site/Authentication-overview.md ONLY, the others files are merged from other PRs.

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 👈

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.

@jannyHou, thanks for the refactoring. There are some broken links in the sidebar file, I assume you'll add it later?

strategy, the diagram below shows how such authentication process works with
LoopBack's authentication mechanism.

![authentication_overview_request_handle_flow](./imgs/authentication/authentication-overview.png)
Copy link
Member

Choose a reason for hiding this comment

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

there're extra icons at the bottom right. Could you please remove that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The diagram is created kinda in a rush, I will draw it again.

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 I updated the diagram.

docs/site/sidebars/lb4_sidebar.yml Outdated Show resolved Hide resolved
authentication.
- [How to create your own authentication strategy](missing_link): Particularly
for extension developers.
- [Use [Passport](https://www.npmjs.com/package/passport) strategies](missing
Copy link
Member

Choose a reason for hiding this comment

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

fix missing link

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 sure, I am creating sub-PRs to update each page, and eventually the links will all be updated.

docs/site/Authentication-overview.md Outdated Show resolved Hide resolved
docs/site/Authentication-overview.md Outdated Show resolved Hide resolved
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.

👏 Glad to see that we started working on it! The PR LGTM once the typos are fixed. Just have a suggestion.

docs/site/Authentication-overview.md Outdated Show resolved Hide resolved
docs/site/Authentication-overview.md Outdated Show resolved Hide resolved
docs/site/Authentication-overview.md Outdated Show resolved Hide resolved
docs/site/Authentication-overview.md Outdated Show resolved Hide resolved
@jannyHou jannyHou mentioned this pull request Jun 2, 2020
1 task
@jannyHou jannyHou changed the title Auth doc refactor [WIP, waiting for each page's PR]Auth doc refactor Jun 2, 2020
@jannyHou jannyHou changed the title [WIP, waiting for each page's PR]Auth doc refactor Auth doc refactor Jun 10, 2020
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.

I've reviewed Authentication-overview.md.

docs/site/Authentication-overview.md Outdated Show resolved Hide resolved
docs/site/Authentication-overview.md Outdated Show resolved Hide resolved
docs/site/Authentication-overview.md Outdated Show resolved Hide resolved
docs/site/Authentication-overview.md Outdated Show resolved Hide resolved
@jannyHou jannyHou merged commit 3bcab0e into master Jun 11, 2020
@jannyHou jannyHou deleted the auth-doc-refactor branch June 11, 2020 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants