website/docs: 2024.10.1 Release Notes

[gergosimonyi]

Using details may be a bit weird. An alternative is a h3.

[netlify]

✅ Deploy Preview for authentik-storybook canceled.

Name	Link
🔨 Latest commit	287ee61
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-storybook/deploys/672a490869033d0008981ad4

[netlify]

✅ Deploy Preview for authentik-docs ready!

Name	Link
🔨 Latest commit	287ee61
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-docs/deploys/672a4907f2f9ab0008669b5e
😎 Deploy Preview	https://deploy-preview-11926--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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.57%. Comparing base (b44b5c1) to head (287ee61).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #11926      +/-   ##
==========================================
- Coverage   92.64%   92.57%   -0.07%     
==========================================
  Files         761      761              
  Lines       37813    37813              
==========================================
- Hits        35030    35005      -25     
- Misses       2783     2808      +25     

Flag	Coverage Δ
e2e	49.11% <ø> (-0.11%)	⬇️
integration	24.91% <ø> (ø)
unit	90.15% <ø> (ø)

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.

[github-actions]

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-287ee61f80099e7133c8b4d4965c758aeb0bc691
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

For arm64, use these values:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-287ee61f80099e7133c8b4d4965c758aeb0bc691-arm64
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-287ee61f80099e7133c8b4d4965c758aeb0bc691

For arm64, use these values:

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-287ee61f80099e7133c8b4d4965c758aeb0bc691-arm64

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

[tanberry]

Here are my thoughts about the "construction" of the API section.

Even though I think that collapsible sections are fantastic for giving pages a clean look, and improving visual scanabilty, there are two reasons I am not keen to use the <details open> element:

1. when collapsed, the content is not searchable on Firefox and Safari (though we could have it open by default, then allow the reader to collapse the section if they want)
2. the background colour of the section, when opened, is kinda jarring with the rest of the page (minor CSS fix probably).

So I prefer Grego's approach of using H3's. (And making those H3s much more specific, for both scanability and for SEO.)

My biggest takeaway from this is that I don't think we should be cramming patch release info into the major version's Release Notes. The 3 or 4 changes in the .1 patch release are hard to find amongst all of the .0 release info, and in general it doesn't seem right to edit/modify existing release notes. Let's just make a new short RN doc for each patch release. That would help our readers quickly determined what is actually in the patch release. ;-)

[gergosimonyi]

/cherry-pick version-2024.10