website/integrations: Add documentation for Drupal #12925
Conversation
✅ Deploy Preview for authentik-storybook canceled.
|
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
BeryJu
changed the title
There was a problem hiding this comment.
Hi, thanks for your contribution. Before reviewing this PR, would it be possible to make sure your contribution follows the template outlined in the documentation? Thanks.
|
@dominic-r I've made this change (however the authentik configuration needs to happen before the Drupal configuration) |
There was a problem hiding this comment.
Hi @justafish . Thanks for your contribution. Here are a few comments. Please do let me know if you have any questions.
|
|
||
| ## What is Drupal | ||
|
|
||
| > [Drupal](https://new.drupal.org/home) is a free and open-source content |
There was a problem hiding this comment.
You shouldn't link Drupal's home page in markdown and link it's wikipedia page right below. Please only keep Line 15
| - Create an application e.g. "Drupal" and set the Provider field to the provider | ||
| created above | ||
|
|
||
| ### 2FA (optional) |
There was a problem hiding this comment.
This section is not needed
|
|
||
| The following placeholders are used in this guide: | ||
|
|
||
| - `drupal.ddev.site` is the FQDN of Drupal installation. |
There was a problem hiding this comment.
Drupal can be selfhosted. As a result, it is not fair to say that drupal.ddev.site is it's FQDN. You could instead say drupal.company and update all further references
| The following placeholders are used in this guide: | ||
|
|
||
| - `drupal.ddev.site` is the FQDN of Drupal installation. | ||
| - `authentik.company` is the FQDN of Authentik installation. |
There was a problem hiding this comment.
"authentik" should be in lowercase as per the style guide's "authentik names" section
| ::: | ||
|
|
||
|
|
||
| ## authentik configuration |
There was a problem hiding this comment.
Note to tana: reminder: will update format in a later PR
| "Configuration stages" | ||
|  | ||
|
|
||
| ## Service configuration |
There was a problem hiding this comment.
| ## Service configuration | |
| ## Drupal configuration |
| "Configuration stages" | ||
|  | ||
|
|
||
| ## Service configuration |
There was a problem hiding this comment.
Please see the style guide's "formatting" section for proper URL styling
| Once logged in for the first time, depending on your user registration settings | ||
| you may get a message saying you've successfully logged in but your account is | ||
| blocked and needs to be approved by an administrator, so unblock the user in the | ||
| usual way, and then you can log in successfully. |
There was a problem hiding this comment.
in the usual way
How? Could you link documentation which references this unblock method?
| - Select the "Override registration settings" checkbox | ||
| - Enable the OpenID button on user login form | ||
|
|
||
| ## Configuration verification |
There was a problem hiding this comment.
The configuration verification section is a step to confirm that authentik works with the service. You need to explicitly mention how to log in & if there are any particularities. I suggest looking at the Integration template's example for a good base
| "Configuration stages" | ||
|  | ||
|
|
||
| ## Service configuration |
There was a problem hiding this comment.
"x endpoint" & "if authentik is running locally [...]" lines could be consolidated into one, potentially with a message at the top of this configuration. I suggest looking at the style guide's admonitions syntax section for the correct markdown format.
Details
Adds documentation for authentication with Drupal
Checklist
ak test authentik/)make lint-fix)If an API change has been made
make gen-build)If changes to the frontend have been made
make web)If applicable
make website)