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

SSO service documentation #3523

Merged
merged 1 commit into from
Apr 22, 2022
Merged

SSO service documentation #3523

merged 1 commit into from
Apr 22, 2022

Conversation

sirinoks
Copy link
Contributor

Issue This PR Addresses

#3291 Only the sso part

Possibly,
Fixes #2955

However, for that specific issue I would want to describe SAML-2 part in a separate document, or add SAML-2 information to this doc later.

Type of Change

  • Documentation Update: Change which improves documentation

Description

Describes the step by step process of auth. It is the first draft and is open to edits.

Steps to test the PR

  • cd src/web/docusaurus
  • pnpm start
  • localhost:4631
  • Click on Docs tab
  • Click on API services, then Authentication and Authorization
  • Read the content. Does it make sense? Can it be better?

Checklist

  • Quality: This PR builds and passes our npm test and works locally
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not (if applicable)
  • Documentation: This PR includes updated/added documentation to user exposed functionality or configuration variables are added/changed or an explanation of why it does not(if applicable)

No tests for just docs. Prettier was okay with this.
No need for screenshots for just text.


Might need to be updated with Supabase information and whatever is in #3030 . If this gets merged, please make sure to add an issue to describe #3030 in documentation somewhere.

@gitpod-io
Copy link

gitpod-io bot commented Apr 19, 2022

@sirinoks sirinoks added type: documentation (docs) Improvements or additions to documentation area: sso Authentication review: normal labels Apr 19, 2022
@sirinoks sirinoks requested a review from tcvan0707 April 19, 2022 20:23
@sirinoks sirinoks mentioned this pull request Apr 19, 2022
8 tasks
@sirinoks
Copy link
Contributor Author

src/web/docusaurus/docs/api-services/auth.md Outdated Show resolved Hide resolved
src/web/docusaurus/docs/api-services/auth.md Outdated Show resolved Hide resolved
src/web/docusaurus/docs/api-services/auth.md Outdated Show resolved Hide resolved
src/web/docusaurus/docs/api-services/auth.md Outdated Show resolved Hide resolved
src/web/docusaurus/docs/api-services/auth.md Outdated Show resolved Hide resolved
src/web/docusaurus/docs/api-services/auth.md Outdated Show resolved Hide resolved
src/web/docusaurus/docs/api-services/auth.md Outdated Show resolved Hide resolved
src/web/docusaurus/docs/api-services/auth.md Outdated Show resolved Hide resolved
tcvan0707
tcvan0707 previously approved these changes Apr 21, 2022
Copy link
Contributor

@tcvan0707 tcvan0707 left a comment

Choose a reason for hiding this comment

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

Looks good to me!

src/web/docusaurus/docs/api-services/auth.md Outdated Show resolved Hide resolved
src/web/docusaurus/docs/api-services/auth.md Outdated Show resolved Hide resolved
src/web/docusaurus/docs/api-services/auth.md Outdated Show resolved Hide resolved
JiaHua-Zou
JiaHua-Zou previously approved these changes Apr 22, 2022
@JerryHue JerryHue added this to the 3.0 Release milestone Apr 22, 2022
JiaHua-Zou
JiaHua-Zou previously approved these changes Apr 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: sso Authentication type: documentation (docs) Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

How Auth works doc
8 participants