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(users): using Google for SAML auth #8296

Merged
merged 4 commits into from
Feb 7, 2025
Merged

Conversation

cloudrootab
Copy link
Contributor

I noticed that the SAML-docs I wrote, could use some tweaking. To make it more helpfull. So I added a few points to better point to where to find this inside Googles admin dashboard.

Also. Added a small note about a potential certificate error, if there isn't a newline at the bottom of the certificate field.

Description

Short explanation of this PR (feel free to re-use commit message)

Checklist

  • Commit
    • Title follows commit conventions
    • Reference the relevant issue (Fixes #007, See xoa-support#42, See https://...)
    • If bug fix, add Introduced by
  • Changelog
    • If visible by XOA users, add changelog entry
    • Update "Packages to release" in CHANGELOG.unreleased.md
  • PR
    • If UI changes, add screenshots
    • If not finished or not tested, open as Draft

Review process

This 2-passes review process aims to:

  • develop skills of junior reviewers
  • limit the workload for senior reviewers
  • limit the number of unnecessary changes by the author
  1. The author creates a PR.
  2. Review process:
    1. The author assigns the junior reviewer.
    2. The junior reviewer conducts their review:
      • Resolves their comments if they are addressed.
      • Adds comments if necessary or approves the PR.
    3. The junior reviewer assigns the senior reviewer.
    4. The senior reviewer conducts their review:
      • If there are no unresolved comments on the PR → merge.
      • Otherwise, we continue with 3.
  3. The author responds to comments and/or makes corrections, and we go back to 2.

Notes:

  1. The author can request a review at any time, even if the PR is still a Draft.
  2. In theory, there should not be more than one reviewer at a time.
  3. The author should not make any changes:
    • When a reviewer is assigned.
    • Between the junior and senior reviews.

I noticed that the SAML-docs I wrote, could use some tweaking. To make it more helpfull. So I added a few points to better point to where to find this inside Googles admin dashboard.

Also. Added a small note about a potential certificate error, if there isn't a newline at the bottom of the certificate field.
@julien-f julien-f requested a review from thomas-dkmt February 2, 2025 12:18
@thomas-dkmt thomas-dkmt changed the title Update users.md with more usefull text for Google SAML Update users.md with more useful text for Google SAML Feb 3, 2025
Copy link
Contributor

@thomas-dkmt thomas-dkmt left a comment

Choose a reason for hiding this comment

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

1. Sign in to your [Google Workspace Admin Dashboard](https://admin.google.com).
2. Go to **Apps/Web and mobile apps**
3. Click **Add app** and select **Add custom SAML app**.
4. Give your app a name and optionally a description.
5. To see how the fields should be filled out, refer to the screenshots below.

Changes to the 1-5 bullet points in vendor (google) specific SAML as requested
@cloudrootab
Copy link
Contributor Author

cloudrootab commented Feb 5, 2025

1. Sign in to your [Google Workspace Admin Dashboard](https://admin.google.com).
2. Go to **Apps/Web and mobile apps**
3. Click **Add app** and select **Add custom SAML app**.
4. Give your app a name and optionally a description.
5. To see how the fields should be filled out, refer to the screenshots below.

The requested changes have been made.

@julien-f julien-f requested a review from thomas-dkmt February 5, 2025 18:37
@julien-f julien-f self-requested a review February 6, 2025 08:00
docs/docs/users.md Outdated Show resolved Hide resolved
@julien-f julien-f changed the title Update users.md with more useful text for Google SAML docs(users): using Google for SAML auth Feb 7, 2025
@julien-f julien-f merged commit d907129 into vatesfr:master Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants