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

website/integrations: Add documentation for Drupal #12925

Merged
merged 14 commits into from
Feb 28, 2025

Conversation

justafish
Copy link
Contributor

Details

Adds documentation for authentication with Drupal


Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)

If applicable

  • The documentation has been updated
  • The documentation has been formatted (make website)

@justafish justafish requested a review from a team as a code owner February 3, 2025 14:02
Copy link

netlify bot commented Feb 3, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 348a797
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67c08b6b113173000847dd7f

Copy link

netlify bot commented Feb 3, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 348a797
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67c08b6b54e7fb0008ff1d93
😎 Deploy Preview https://deploy-preview-12925--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@BeryJu BeryJu changed the title Add documentation for Drupal website/integrations: Add documentation for Drupal Feb 3, 2025
Copy link
Contributor

@dominic-r dominic-r left a comment

Choose a reason for hiding this comment

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

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.

@justafish
Copy link
Contributor Author

@dominic-r I've made this change (however the authentik configuration needs to happen before the Drupal configuration)

Copy link
Contributor

@dominic-r dominic-r left a comment

Choose a reason for hiding this comment

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

Hi @justafish . Thanks for your contribution. Here are a few comments. Please do let me know if you have any questions.

:::


## authentik configuration
Copy link
Contributor

Choose a reason for hiding this comment

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

Note to tana: reminder: will update format in a later PR

@dominic-r
Copy link
Contributor

Hi @justafish. Just checking in to see if there are any developments related to this PR. thanks

@justafish
Copy link
Contributor Author

@dominic-r I've addressed your feedback 👍

@justafish justafish requested a review from dominic-r February 25, 2025 14:14
@justafish justafish requested a review from dominic-r February 25, 2025 14:42
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

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

Thanks so much @justafish for this contribution. I was shocked that we didn't already have an integration guide for Drupal; now we do, thanks to you!

I made a few more minor edits, once those are in let's get this merged!

Copy link

codecov bot commented Feb 25, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.66%. Comparing base (7c944b9) to head (348a797).
Report is 229 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12925      +/-   ##
==========================================
- Coverage   92.75%   92.66%   -0.10%     
==========================================
  Files         769      793      +24     
  Lines       38929    40268    +1339     
==========================================
+ Hits        36109    37314    +1205     
- Misses       2820     2954     +134     
Flag Coverage Δ
e2e 47.99% <ø> (-0.59%) ⬇️
integration 24.11% <ø> (-0.50%) ⬇️
unit 90.44% <ø> (+0.04%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Sally Young <[email protected]>
justafish and others added 7 commits February 26, 2025 12:42
Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Sally Young <[email protected]>
Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Sally Young <[email protected]>
Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Sally Young <[email protected]>
Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Sally Young <[email protected]>
Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Sally Young <[email protected]>
Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Sally Young <[email protected]>
@justafish justafish requested a review from tanberry February 26, 2025 12:56
@tanberry
Copy link
Contributor

tanberry commented Feb 26, 2025

Hi @justafish thanks for the updates! Looks like the lint (prettier-check build check is failing... can you run make website on your local repo/branch, and then push agin to this PR? Hopefully that will fix it.

Copy link
Contributor

@dominic-r dominic-r left a comment

Choose a reason for hiding this comment

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

Once the above ^^ is addressed, LGTM.

There is one thing, but it is more of a preference/opinion: If the indications on how to reach a specific page are clear enough, you don't need to include the link, especially since it uses a placeholder which will need to get replaced and updating the url will take more time than actually following the instructions.

@@ -0,0 +1,82 @@
---
Copy link
Contributor

@dominic-r dominic-r Feb 26, 2025

Choose a reason for hiding this comment

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

Can you remove the image since it's no longer used? (drupal_2fa.png)

@justafish
Copy link
Contributor Author

@tanberry I've run make website, hopefully that's fixed it 🤞

Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

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

Thanks again @justafish for adding Drupal docs!! Very nice to have.

@tanberry tanberry merged commit afb3623 into goauthentik:main Feb 28, 2025
88 checks passed
@justafish justafish deleted the justafish/drupal-sso-docs branch February 28, 2025 09:25
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