website/integrations: komga: document #12476
Conversation
Adds the Komga integration to the sidebar Signed-off-by: 4d62 <github-user@sdko.org>
Rewrite previous documentation. Update YML to new format as per the example in the [advanced configuration documentation](https://komga.org/docs/installation/oauth2/#advanced-configuration). Just a few changes Signed-off-by: 4d62 <github-user@sdko.org>
… default Updates the default `user-name-attribute` from `sub` to `preferred_username` (I would assume that's what users prefer if there's collaboration, idk) & adds a warning similar to what I did in that latest Mastodon MR. Signed-off-by: 4d62 <github-user@sdko.org>
Fixes markdown for service link and updates `authentik.company` placeholder. Signed-off-by: 4d62 <github-user@sdko.org>
Restructures the "authentik configuration" section and updates the first sentence of the "Komga configuration" section Signed-off-by: 4d62 <github-user@sdko.org>
Lints modified file with Prettier. Signed-off-by: 4d62 <github-user@sdko.org>
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
✅ Deploy Preview for authentik-storybook ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Accidentally removed bold from step 1 of "authentik configuration". This fixes the issue. Signed-off-by: 4d62 <github-user@sdko.org>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #12476 +/- ##
==========================================
+ Coverage 92.68% 92.75% +0.06%
==========================================
Files 770 770
Lines 38873 38873
==========================================
+ Hits 36031 36058 +27
+ Misses 2842 2815 -27
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Others don't have it so this one should not Signed-off-by: 4d62 <github-user@sdko.org>
There was a problem hiding this comment.
Thanks so much @4d62 for this PR, especially as it helps us clean out older/abandoned PRs.
It would be great to have a final verification step at the end of the integration guide. Een a single sentence saying how to launch, etc.
Updates the preparation placeholder everywherefollowing the review comment at goauthentik#12476 (comment)
Addresses comments & applies suggestions from the first review round.
|
Please do let me know if there's anything else. |
Hi hi, what are your thoughts about adding a last step for verification that the integration worked, @4d62 ? |
|
Sorry forgot to click "Send" @tanberry IMO, For most integrations, the process involves logging out and back in with authentik, so it might not be worth explicitly stating. |
|
A note could be added for special cases, but there would be one or two exceptions max |
Ah, could to know that in most cases it is a simple process of logging out and then back in. We can add that simple sentence to the template, then, and it will just be there. I do think it is important to have it in the integration guide... and in the scenarios where it is more complex, having that line in the template will help people remember to explain the verification process if complicated. |
Updates the preparation placeholder everywherefollowing the review comment at #12476 (comment)
|
Seems like a good idea. Unless there's anything else this seems ready to merge and I'll open a PR to add that line. |
|
Yes, I will |
* main: core: bump github.com/getsentry/sentry-go from 0.30.0 to 0.31.1 (#12543) core: bump google-api-python-client from 2.156.0 to 2.157.0 (#12544) core: bump ruff from 0.8.4 to 0.8.5 (#12545) core: bump msgraph-sdk from 1.15.0 to 1.16.0 (#12546) Update index.mdx (#12542) web: fix source selection and outpost integration health (#12530) Ading a step to paperless guide (#12539) website/integrations: Semaphore (#12515) website/integrations: komga: document (#12476) website/integrations: fix missing quote in paperless-ngx (#12537) website/integrations: cloudflare access: upd placeholder for saas (#12536) website/integrations: veeam-enterprise-manager: don't hardcode helpcenter doc version (#12538)
sdko/feat/integration/pickup-4139-komga
Details
Documents the https://komga.org integration by updating the abandoned PR.
This is PR 1 of 2 as I divided 4139 in 2
Closes #4139
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)