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

Add developer guide for oidc #2907

Merged
merged 4 commits into from
Aug 21, 2024
Merged

Add developer guide for oidc #2907

merged 4 commits into from
Aug 21, 2024

Conversation

EMaksy
Copy link
Member

@EMaksy EMaksy commented Aug 19, 2024

Description

This pr includes a little guide how to enable oidc.
Additionally, this documentation should help developers quickly run Trento web with keycloak to test and develop oidc tasks.

Did you update the documentation?

This pr is in addition for developers to the manual installation trento-project/docs#53

  • DONE

@EMaksy EMaksy added the documentation Improvements or additions to documentation label Aug 19, 2024
@EMaksy EMaksy requested review from CDimonaco and arbulu89 August 19, 2024 09:22
@EMaksy EMaksy self-assigned this Aug 19, 2024
@EMaksy EMaksy force-pushed the oidc_developer_guide branch 2 times, most recently from 2ef246b to 50664a2 Compare August 19, 2024 09:25
@EMaksy
Copy link
Member Author

EMaksy commented Aug 19, 2024

This guide should help the rest of the team to quickly start a dev env locally, anything else we should include?

@EMaksy EMaksy force-pushed the oidc_developer_guide branch from 50664a2 to 82c24cd Compare August 19, 2024 09:40
Copy link
Contributor

@arbulu89 arbulu89 left a comment

Choose a reason for hiding this comment

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

Some comments:

  • I would rename the oidc folder to integration
  • Don't write Identity Provider (IDP) more than once. Once it is referenced, use the short version. The same for OIDC

guides/oidc/oidc.md Outdated Show resolved Hide resolved
guides/oidc/oidc.md Outdated Show resolved Hide resolved
guides/oidc/oidc.md Outdated Show resolved Hide resolved
guides/oidc/oidc.md Outdated Show resolved Hide resolved
guides/oidc/oidc.md Outdated Show resolved Hide resolved
guides/oidc/oidc.md Outdated Show resolved Hide resolved
guides/oidc/oidc.md Outdated Show resolved Hide resolved
guides/oidc/oidc.md Outdated Show resolved Hide resolved
@EMaksy EMaksy force-pushed the oidc_developer_guide branch from 710b591 to 46b9d3f Compare August 20, 2024 12:46
@EMaksy
Copy link
Member Author

EMaksy commented Aug 20, 2024

Thanks @arbulu89 i updated the docs and also added additional information from your pr about e2e

@EMaksy EMaksy force-pushed the oidc_developer_guide branch from 46b9d3f to b558b42 Compare August 20, 2024 12:52
@EMaksy EMaksy marked this pull request as ready for review August 20, 2024 12:58
@EMaksy EMaksy requested a review from arbulu89 August 20, 2024 12:58
Copy link
Contributor

@arbulu89 arbulu89 left a comment

Choose a reason for hiding this comment

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

Some more comments 🙈
Typo in the folder intergration -> integration

guides/intergration/oidc.md Outdated Show resolved Hide resolved
guides/intergration/oidc.md Outdated Show resolved Hide resolved
guides/intergration/oidc.md Outdated Show resolved Hide resolved
guides/intergration/oidc.md Outdated Show resolved Hide resolved
guides/intergration/oidc.md Outdated Show resolved Hide resolved
guides/intergration/oidc.md Outdated Show resolved Hide resolved
guides/intergration/oidc.md Outdated Show resolved Hide resolved
guides/intergration/oidc.md Outdated Show resolved Hide resolved
guides/intergration/oidc.md Outdated Show resolved Hide resolved
@EMaksy EMaksy force-pushed the oidc_developer_guide branch from f68fcc5 to 3efb6c5 Compare August 21, 2024 08:03
@EMaksy EMaksy requested a review from arbulu89 August 21, 2024 09:31
@EMaksy EMaksy force-pushed the oidc_developer_guide branch from 3efb6c5 to 11454fd Compare August 21, 2024 12:42
Copy link
Contributor

@arbulu89 arbulu89 left a comment

Choose a reason for hiding this comment

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

Thank you @EMaksy
Green light

@EMaksy EMaksy merged commit 0e6a816 into main Aug 21, 2024
30 checks passed
@EMaksy EMaksy deleted the oidc_developer_guide branch August 21, 2024 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

2 participants