website/docs: 2024.10.1 Release Notes#11926
Conversation
✅ Deploy Preview for authentik-storybook canceled.
|
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
✅ 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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
authentik PR Installation instructions Instructions for docker-composeAdd the following block to your 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)sFor 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)sAfterwards, run the upgrade commands from the latest release notes. Instructions for KubernetesAdd the following block to your 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-287ee61f80099e7133c8b4d4965c758aeb0bc691For 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-arm64Afterwards, run the upgrade commands from the latest release notes. |
There was a problem hiding this comment.
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:
- 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)
- 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. ;-)
|
/cherry-pick version-2024.10 |
* fix API Changes in `2024.10` changelog * add `2024.10.1` API Changes to changelog * add changes in `2024.10.1` to changelog * change `details` to `h3` in changelog
website/docs: `2024.10.1` Release Notes (#11926) * fix API Changes in `2024.10` changelog * add `2024.10.1` API Changes to changelog * add changes in `2024.10.1` to changelog * change `details` to `h3` in changelog Co-authored-by: Simonyi Gergő <28359278+gergosimonyi@users.noreply.github.com>
* main: website/docs: fix slug matching redirect URI causing broken refresh (#11950) website/integrations: jellyfin: update plugin catalog location (#11948) translate: Updates for file locale/en/LC_MESSAGES/django.po in de (#11942) translate: Updates for file locale/en/LC_MESSAGES/django.po in zh_CN (#11946) translate: Updates for file locale/en/LC_MESSAGES/django.po in zh-Hans (#11947) website/docs: clarify traefik ingress setup (#11938) core: bump importlib-metadata from 8.4.0 to 8.5.0 (#11934) web: bump API Client version (#11930) root: backport version bump `2024.10.1` (#11929) website/docs: `2024.10.1` Release Notes (#11926) website: bump path-to-regexp from 1.8.0 to 1.9.0 in /website (#11924) core: bump sentry-sdk from 2.17.0 to 2.18.0 (#11918) website: bump the docusaurus group in /website with 9 updates (#11917) core: bump goauthentik.io/api/v3 from 3.2024100.1 to 3.2024100.2 (#11915) core, web: update translations (#11914)
Using
detailsmay be a bit weird. An alternative is ah3.