Rhidp 9758: Enable GitLab authentication#1839
Rhidp 9758: Enable GitLab authentication#1839pabel-rh wants to merge 24 commits intoredhat-developer:mainfrom
Conversation
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1839/ @ 03/04/26 06:27:06 |
pabel-rh
added
Peer review needed 📖
do-no-merge/review-in-progress 👀
Technical review needed 🔩
JessicaJHee
left a comment
JessicaJHee
left a comment
There was a problem hiding this comment.
Thanks for this contribution! A few changes are needed, and @albarbaro will be reviewing the GitLab auth app set up
modules/authentication/snip-enable-user-authentication-with-gitlab-common-first-steps.adoc
Outdated
Show resolved
Hide resolved
modules/authentication/snip-enable-user-authentication-with-gitlab-common-first-steps.adoc
Outdated
Show resolved
Hide resolved
albarbaro
left a comment
albarbaro
left a comment
There was a problem hiding this comment.
I don't see the integrations configuration part mentioned anywhere: as stated in the upstream docs (and it should be also in the notes docs I have provided with the Jira Feature) the integration set up is required to provide authenticated requests to Gitlab and avoid anonymous one. To set the integration for authenticated requests , creating a token is a prerequisite (upstream docs). The rest look good to me.
modules/authentication/snip-enable-user-authentication-with-gitlab-common-first-steps.adoc
Show resolved
Hide resolved
albarbaro
left a comment
albarbaro
left a comment
There was a problem hiding this comment.
Looks good to me now. Thanks!
pabel-rh
added
Technical review done ⛅
pabel-rh
added
Peer review needed 📖
and removed
Technical review done ⛅
JessicaJHee
left a comment
JessicaJHee
left a comment
There was a problem hiding this comment.
Looking good! Just a few more things here :) I'm having trouble seeing the changes in the preview, but mainly want to make sure that we're following the same structure as the other providers.
| `GITLAB_PARENT_ORG`:: | ||
| Enter your GitLab organization name, such as `__<your_gitlab_organization_name>__`. | ||
|
|
||
| . Configure the GitLab integration by adding the following section to your {product-very-short} `{my-app-config-file}` file: |
There was a problem hiding this comment.
The information is correct here, but it would be best to check here that documenting the integration setup aligns with how we do it for GitHub. Maybe check with @themr0c ?
modules/authentication/snip-enable-user-authentication-with-gitlab-common-first-steps.adoc
Outdated
Show resolved
Hide resolved
…ub (redhat-developer#1810) Signed-off-by: Fabrice Flore-Thébault <ffloreth@redhat.com>
…(RHDHBUGS-2614); also add a reminder note about this needing to be regenerated in future as more plugins move to OCI (redhat-developer#1782) * chore: add migration tables to the install guide for dynamic plugins (RHDHBUGS-2614); also add a reminder note about this needing to be regenerated in future as more plugins move to OCI Signed-off-by: Nick Boldt <nboldt@redhat.com> * fix compilation errors Signed-off-by: Nick Boldt <nboldt@redhat.com> * regen from latest Signed-off-by: Nick Boldt <nboldt@redhat.com> * provide error/warning when path is empty (no wrapper found, so no OCI ref provided) Signed-off-by: Nick Boldt <nboldt@redhat.com> * reordered content per Gerry's suggestion Signed-off-by: Nick Boldt <nboldt@redhat.com> * fix logic for determining if plugins are enabled by default (including orchestrator, which are NOT) Signed-off-by: Nick Boldt <nboldt@redhat.com> * fix the missing oci refs Signed-off-by: Nick Boldt <nboldt@redhat.com> * generate adoc and csv Signed-off-by: Nick Boldt <nboldt@redhat.com> * regen header in ref-community-plugins-migration.adoc based on changes made to the template Signed-off-by: Nick Boldt <nboldt@redhat.com> --------- Signed-off-by: Nick Boldt <nboldt@redhat.com>
|
|
|
||
| [id="enable-authentication-with-gitlab-basic"] | ||
| = Enable authentication with GitLab | ||
|
|
There was a problem hiding this comment.
Add a mandatory introduction. See https://redhat-documentation.github.io/modular-docs/#assembly-guidelines and CQA (https://docs.google.com/spreadsheets/d/1wF_NUWXBJaYsaXp8Dn6TQOx9gD45NCqNxaPkXhYN-zI/edit?gid=503904153#gid=503904153)
"Assemblies should contain only an introductory section, which can be one or more paragraphs, and include statements."
| :_mod-docs-content-type: ASSEMBLY | ||
| :optional-steps: enable | ||
|
|
||
| [id='enabling-authentication'] | ||
| = Enabling authentication in {product} | ||
|
|
||
| include::modules/authentication/con-understanding-authentication-and-user-provisioning.adoc[leveloffset=+1] | ||
|
|
||
|
|
||
| include::assembly-authenticating-with-the-guest-user.adoc[leveloffset=+1] | ||
|
|
||
|
|
||
| include::assembly-authenticating-with-rhbk.adoc[leveloffset=+1] | ||
|
|
||
|
|
||
| include::assembly-enabling-authentication-with-github.adoc[leveloffset=+1] | ||
|
|
||
|
|
||
| include::assembly-enable-authentication-with-gitlab-basic.adoc[leveloffset=+1] | ||
|
|
||
|
|
||
| include::modules/authentication/proc-enabling-user-authentication-with-microsoft-azure-with-optional-steps.adoc[leveloffset=+1] | ||
|
|
||
|
|
||
| include::assembly-enabling-service-to-service-authentication.adoc[leveloffset=+1] | ||
|
|
||
|
|
||
| include::modules/authentication/proc-enabling-auto-logout-for-inactive-users.adoc[leveloffset=+1] | ||
|
|
||
|
|
||
| include::assembly-authentication-troubleshooting.adoc[leveloffset=+1] | ||
|
|
There was a problem hiding this comment.
There is already such an assembly file. Add the new include statement to the existing assembly. Do not create a new assembly.
(The assembly was renamed and the rebase didn't handle the situation. Manual change is necessary).
8 participants
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s):
main, 1.9
Issue:
https://issues.redhat.com/browse/RHIDP-9758
Preview:
Created a similar PR from #1798 to make updates in Jana's absence