website/integrations: add The Lounge by OddMagnet · Pull Request #11971 · goauthentik/authentik

OddMagnet · 2024-11-08T18:34:40Z

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.

netlify · 2024-11-08T18:34:56Z

✅ Deploy Preview for authentik-docs ready!

Name	Link
🔨 Latest commit	`2739e73`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-docs/deploys/674ea60ea5b8510008f41eff
😎 Deploy Preview	https://deploy-preview-11971--authentik-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

netlify · 2024-11-08T18:35:23Z

✅ Deploy Preview for authentik-storybook canceled.

Name	Link
🔨 Latest commit	`2739e73`
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-storybook/deploys/674ea60ed667a90008d00961

OddMagnet · 2024-11-08T18:46:22Z

❌ 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 · 2024-11-19T23:17:36Z

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.

codecov · 2024-11-19T23:21:36Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.61%. Comparing base (4aeb7c8) to head (2739e73).
Report is 6 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main   #11971   +/-   ##
=======================================
  Coverage   92.60%   92.61%           
=======================================
  Files         761      761           
  Lines       38050    38050           
=======================================
+ Hits        35237    35239    +2     
+ Misses       2813     2811    -2

Flag	Coverage Δ
e2e	`49.12% <ø> (+<0.01%)`	⬆️
integration	`24.83% <ø> (ø)`
unit	`90.20% <ø> (+<0.01%)`	⬆️

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.

OddMagnet · 2024-11-20T13:29:29Z

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 · 2024-11-20T16:11:32Z

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 · 2024-11-20T16:19:03Z

Done

OddMagnet · 2024-11-20T16:33:02Z

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

website/integrations/services/thelounge/index.md

tanberry

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

OddMagnet · 2024-12-02T08:15:44Z

@tanberry anything else missing?

tanberry · 2024-12-03T03:43:59Z

@tanberry anything else missing?

Hi there @OddMagnet, the changes look good, thanks! However, the build is still failing on the " lint (prettier-check)" check.

We recently bumped our version on one of the build tools; can you please try running make website-install to update the local build tools, and then run make website again to run all of the linters and checks?

Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>

Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>

OddMagnet · 2024-12-03T06:33:20Z

Sure thing @tanberry, I've just pushed the linter fixes.

tanberry · 2024-12-04T19:21:53Z

Whoot! Thanks again for this contribution @OddMagnet and also for your patience. ;-)

* main: web: simplify `?inline` handler for Storybook (#12246) website/docs: Update Traefik middleware example to reflect latest version of Traefik (#12267) website/docs: add . in https://netbird.company* (#12166) core: bump goauthentik.io/api/v3 from 3.2024104.1 to 3.2024104.2 (#12263) core: bump pydantic from 2.10.2 to 2.10.3 (#12262) core: bump github.com/getsentry/sentry-go from 0.29.1 to 0.30.0 (#12264) core, web: update translations (#12268) website: bump @types/react from 18.3.12 to 18.3.13 in /website (#12269) website: bump prettier from 3.4.1 to 3.4.2 in /website (#12270) ci: bump actions/attest-build-provenance from 1 to 2 (#12271) core: bump golang.org/x/sync from 0.9.0 to 0.10.0 (#12272) core: bump django from 5.0.9 to 5.0.10 (#12273) core: bump webauthn from 2.3.0 to 2.4.0 (#12274) website/integrations: add The Lounge (#11971) core: bump python-kadmin-rs from 0.3.0 to 0.4.0 (#12257) root: fix health status code (#12255) ci: fix should_push always being false (#12252) web: bump API Client version (#12251) providers/oauth2: Add provider federation between OAuth2 Providers (#12083) website/integrations: mastodon: set correct uid field (#11945)

OddMagnet requested a review from a team as a code owner November 8, 2024 18:34

rissson changed the title ~~Integrations: Add The Lounge integration guide~~ website/integrations: add The Lounge Nov 20, 2024

tanberry reviewed Nov 20, 2024

View reviewed changes

website/integrations/services/thelounge/index.md Outdated Show resolved Hide resolved

tanberry reviewed Nov 20, 2024

View reviewed changes

website/integrations/services/thelounge/index.md Outdated Show resolved Hide resolved

tanberry reviewed Nov 20, 2024

View reviewed changes

website/integrations/services/thelounge/index.md Outdated Show resolved Hide resolved

tanberry requested changes Nov 20, 2024

View reviewed changes

OddMagnet requested a review from tanberry November 27, 2024 13:45

tanberry approved these changes Dec 3, 2024

View reviewed changes

OddMagnet and others added 8 commits December 3, 2024 07:21

Add The Lounge Integration guide

9609952

Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>

Add The Lounge to sidebar, fix Note section formatting

89a5b4d

Fix folder name (1/2)

b379c35

Fix folder name (2/2)

b6d8195

Update website/integrations/services/thelounge/index.md

3b8efb7

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>

Update website/integrations/services/thelounge/index.md

4d001ad

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com> Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>

Fix cutoff sentence

774b1a7

Signed-off-by: Michael Brünen <34708235+OddMagnet@users.noreply.github.com>

Linter fixes

2739e73

OddMagnet force-pushed the patch-1 branch from 5ea7e23 to 2739e73 Compare December 3, 2024 06:32

tanberry merged commit 695de45 into goauthentik:main Dec 4, 2024

Uh oh!

Conversation

OddMagnet commented Nov 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

Checklist

Problems:

Uh oh!

netlify bot commented Nov 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-docs ready!

Uh oh!

netlify bot commented Nov 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-storybook canceled.

Uh oh!

OddMagnet commented Nov 8, 2024

❌ Deploy Preview for authentik-docs failed.

Uh oh!

tanberry commented Nov 19, 2024

Uh oh!

codecov bot commented Nov 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

OddMagnet commented Nov 20, 2024

Uh oh!

tanberry commented Nov 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OddMagnet commented Nov 20, 2024

Uh oh!

OddMagnet commented Nov 20, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tanberry left a comment

Choose a reason for hiding this comment

Uh oh!

OddMagnet commented Dec 2, 2024

Uh oh!

tanberry commented Dec 3, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OddMagnet commented Dec 3, 2024

Uh oh!

tanberry commented Dec 4, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

OddMagnet commented Nov 8, 2024 •

edited

Loading

netlify bot commented Nov 8, 2024 •

edited

Loading

netlify bot commented Nov 8, 2024 •

edited

Loading

codecov bot commented Nov 19, 2024 •

edited

Loading

tanberry commented Nov 20, 2024 •

edited

Loading

tanberry commented Dec 3, 2024 •

edited

Loading