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 The Lounge #11971

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

OddMagnet
Copy link

@OddMagnet OddMagnet commented Nov 8, 2024

Details

I just finished setting up LDAP for The Lounge and since there was no Integration Guide yet I figured I'd create one.
I'm very new to Authentik and LDAP, so this guide might need some help/refinement.


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)

Problems:

I tried running make website-watch, but I get this error:

[ERROR] [Error: ENOENT: no such file or directory, lstat '/Users/michael/Downloads/authentik/website/static/schema.yaml'] {
  errno: -2,
  code: 'ENOENT',
  syscall: 'lstat',
  path: '/Users/michael/Downloads/authentik/website/static/schema.yaml'
}

make website also gives me an error

codespell -w -D - -D .github/codespell-dictionary.txt -I .github/codespell-words.txt -S 'web/src/locales/**' -S 'website/docs/developer-docs/api/reference/**' authentik internal cmd web/src website/src website/blog website/docs website/integrations website/src
make: codespell: No such file or directory
make: *** [lint-codespell] Error 1

Since this is just a markdown file I suppose these commands might not be necessary to complete on my system.
The make web mentioned in the checklist worked.

Signed-off-by: Michael Brünen <[email protected]>
@OddMagnet OddMagnet requested a review from a team as a code owner November 8, 2024 18:34
Copy link

netlify bot commented Nov 8, 2024

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 5ea7e23
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/673ed60c3fd4df00084c719a
😎 Deploy Preview https://deploy-preview-11971--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.

Copy link

netlify bot commented Nov 8, 2024

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 5ea7e23
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/673ed60c9f654200080eeaa0

@OddMagnet
Copy link
Author

❌ Deploy Preview for authentik-docs failed.

Name Link
🔨 Latest commit 796ab58
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/672e59c3547ad20008c5fc87

I believe this is not caused by my PR, since the broken links appear to be from somewhere else.

@tanberry
Copy link
Contributor

Hi @OddMagnet thanks for this contribution, and apologies for my slow reply! For the formatting and linting, have you tried running npm run prettier? I'll start editing the guide, but please let me now about running the linters before pushing.

Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.61%. Comparing base (9036724) to head (2cc7d50).
Report is 69 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11971      +/-   ##
==========================================
- Coverage   92.64%   92.61%   -0.03%     
==========================================
  Files         761      761              
  Lines       37816    37929     +113     
==========================================
+ Hits        35033    35127      +94     
- Misses       2783     2802      +19     
Flag Coverage Δ
e2e 49.10% <ø> (-0.11%) ⬇️
integration 24.85% <ø> (-0.06%) ⬇️
unit 90.19% <ø> (+0.03%) ⬆️

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.


🚨 Try these New Features:

@rissson rissson changed the title Integrations: Add The Lounge integration guide website/integrations: add The Lounge Nov 20, 2024
@OddMagnet
Copy link
Author

Hey @tanberry I tried running npm run prettier, but that fails due to missing the prettier script

results ❯ npm run prettier npm error Missing script: "prettier" npm error npm error To see a list of scripts, run: npm error npm run npm error A complete log of this run can be found in: /Users/michael/.npm/_logs/2024-11-20T13_08_18_604Z-debug-0.log

I went back to look at the problems and looked up codespell, after installing it via pip install I was able to use make website-install, make website-watch and make website

I also noticed that the formatting for the "Note" section was off by a bit and I forgot to add the integration to sidebarintegrations.js, oops 😅

Let me know when I can push the changed

@tanberry
Copy link
Contributor

tanberry commented Nov 20, 2024

Hey @tanberry I tried running npm run prettier, but that fails due to missing the prettier script

results
I went back to look at the problems and looked up codespell, after installing it via pip install I was able to use make website-install, make website-watch and make website

I also noticed that the formatting for the "Note" section was off by a bit and I forgot to add the integration to sidebarintegrations.js, oops 😅

Let me know when I can push the changed

Great news, thanks for doing that @OddMagnet! Sure, after you have run make website and you get no (or minimal) errors, and you run make website-watch to deploy and checkout your work locally, please do push again to the PR.

@OddMagnet
Copy link
Author

Done

@OddMagnet
Copy link
Author

Had the capitalisation of the folder name wrong initially, seems that change didn't make it into my commits, even though everything ran fine locally.

Should be fixed now

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.

A few edits, and the last sentence needs completing, then let's get it merged!

OddMagnet and others added 3 commits November 21, 2024 07:39
Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Michael Brünen <[email protected]>
Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Michael Brünen <[email protected]>
Signed-off-by: Michael Brünen <[email protected]>
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.

2 participants