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/docs: Flesh out integrations copy changes. #13619

Merged
merged 8 commits into from
Mar 25, 2025
Merged

Conversation

GirlBossRush
Copy link
Contributor

@GirlBossRush GirlBossRush commented Mar 21, 2025

Details

Team collaboration on integrations copy.

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)

@GirlBossRush GirlBossRush requested a review from a team as a code owner March 21, 2025 18:35
@GirlBossRush GirlBossRush added the documentation Improvements or additions to documentation label Mar 21, 2025
Copy link

netlify bot commented Mar 21, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 629d5e9
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67e2e4d6ec86720008cfca5b

Copy link

netlify bot commented Mar 21, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 629d5e9
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67e2e4d6181f6c00088f2271
😎 Deploy Preview https://deploy-preview-13619--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

codecov bot commented Mar 21, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.75%. Comparing base (6383550) to head (629d5e9).
Report is 9 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #13619   +/-   ##
=======================================
  Coverage   92.75%   92.75%           
=======================================
  Files         794      794           
  Lines       40524    40545   +21     
=======================================
+ Hits        37589    37609   +20     
- Misses       2935     2936    +1     
Flag Coverage Δ
e2e 47.93% <ø> (-0.03%) ⬇️
integration 24.28% <ø> (-0.02%) ⬇️
unit 90.54% <ø> (+<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.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@GirlBossRush GirlBossRush force-pushed the workshop-integration branch from 9f716d8 to e01dad9 Compare March 21, 2025 19:54
@GirlBossRush GirlBossRush force-pushed the workshop-integration branch from e01dad9 to 7acab2e Compare March 24, 2025 14:44
@GirlBossRush GirlBossRush requested a review from tanberry March 24, 2025 15:06
@GirlBossRush GirlBossRush force-pushed the workshop-integration branch from 1ce9f70 to 23ac129 Compare March 24, 2025 15:07
@@ -32,6 +25,8 @@ wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/integr

Don't forget to edit the `sidebarsIntegrations.js` file to add your new integration to the lefthand navigation bar.

## Integration categories
Most third-party services that support authentication protocols such as SAML, OAuth, and OpenID Connect can be integrated with authentik, allowing users to log in to these services using their authentik credentials.
Copy link
Contributor

@tanberry tanberry Mar 24, 2025

Choose a reason for hiding this comment

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

@GirlBossRush in the Friday co-writing session, this is the new section that we want to add up top, before the info about how to add a new one, and before the cards. So the two paragraphs in this screenshot should be up top. I thought it was like that at end of meeting on Friday; sorry if I missed it then or in the review I did Friday.

Apps-page

Copy link
Contributor

Choose a reason for hiding this comment

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

Also let's add back in the H2 "Integration categories", please, right above the cards.

Copy link
Member

Choose a reason for hiding this comment

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

Agreed, we ended up with the ~opposite order from this screenshot: 1) We probably already work with your application, 2) you can submit docs for new ones, 3) here are the categories for all the following apps

@@ -3,24 +3,17 @@ title: Integrate with Applications
sidebar_label: Applications
---

# Applications

import DocCardList from "@theme/DocCardList";
import SupportBadge from "@site/src/components/SupportBadge";

Below is a list of all applications that are known to work with authentik.
Copy link
Member

Choose a reason for hiding this comment

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

Specifically, I think we reworked that order most importantly to get rid of this sentence!

@tanberry tanberry merged commit a9b6488 into main Mar 25, 2025
89 checks passed
@tanberry tanberry deleted the workshop-integration branch March 25, 2025 17:40
Copy link
Contributor

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-629d5e94922a355e81a7e8377bd5f27e1482259a
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-629d5e94922a355e81a7e8377bd5f27e1482259a

Afterwards, run the upgrade commands from the latest release notes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants