web: Fix docs links, a11y input descriptors #16671

GirlBossRush · 2025-09-08T17:31:44Z

Details

This PR fixes a collection of issues that prevent doc links from using the correct domain while developing authentik. Following up on #15774, this PR also unifies a several related behaviors surrounding URL constants.

1. Version Constants

We've gradually moved runtime constants into the build step. The fixes in this PR are focused on web/packages/core/version/node.js, moving much of error-prone version string splitting into a parsed object.

2. Documentation links

Links to the docs are now injected during build time, fixing a few sources of URL mismatches such as when...

Running the backend via Docker
The pre-release docs for a version is not ready for publishing

Additionally, some doc links have depended on redirects -- They've since been updated to match their current canonical URLs.

3. Miscellaneous

♿️ Fix for screen reader while reading input helper text, such as when describing information about a field and linking to related docs.
♿️ Fix labels containing * being read as asterisk instead of required

netlify · 2025-09-08T17:31:51Z

✅ Deploy Preview for authentik-docs ready!

Name	Link
🔨 Latest commit	`f060627`
🔍 Latest deploy log	https://app.netlify.com/projects/authentik-docs/deploys/68c82eebcde3bb00098f2f40
😎 Deploy Preview	https://deploy-preview-16671--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 project configuration.

netlify · 2025-09-08T17:31:51Z

✅ Deploy Preview for authentik-storybook ready!

Name	Link
🔨 Latest commit	`f060627`
🔍 Latest deploy log	https://app.netlify.com/projects/authentik-storybook/deploys/68c82eebcd483b0008f4c943
😎 Deploy Preview	https://deploy-preview-16671--authentik-storybook.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 project configuration.

netlify · 2025-09-08T17:31:52Z

✅ Deploy Preview for authentik-integrations ready!

Name	Link
🔨 Latest commit	`f060627`
🔍 Latest deploy log	https://app.netlify.com/projects/authentik-integrations/deploys/68c82eeb733eab00084f09fd
😎 Deploy Preview	https://deploy-preview-16671--authentik-integrations.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 project configuration.

GirlBossRush · 2025-09-08T17:33:24Z

web/src/common/styles/authentik.css

@@ -52,7 +52,7 @@
 }

 .pf-c-form__label[aria-required] .pf-c-form__label-text::after {
-    content: "*";
+    content: "*" / "Required";


TIL

https://a11ysupport.io/tests/tech__css__css_generated_content_alt

Found this while debugging links using macOS's VoiceOver

codecov · 2025-09-08T17:39:09Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.77%. Comparing base (1752b0f) to head (f060627).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #16671      +/-   ##
==========================================
- Coverage   92.77%   92.77%   -0.01%     
==========================================
  Files         838      838              
  Lines       45374    45374              
==========================================
- Hits        42096    42095       -1     
- Misses       3278     3279       +1

Flag	Coverage Δ
e2e	`46.50% <ø> (-0.01%)`	⬇️
integration	`23.51% <ø> (+<0.01%)`	⬆️
unit	`90.91% <ø> (+<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.

GirlBossRush · 2025-09-09T12:54:05Z

web/src/elements/cards/QuickActionsCard.ts

-                <a class="pf-u-mb-xl" href=${url} ${external ? 'target="_blank"' : ""}>
-                    ${external


Fixed issue where Lit escapes the attribute + moving out of render function to avoid redeclaring each time

github-actions · 2025-09-09T13:15:39Z

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-f060627b5e72e5d9b292dd120a45db0cf868d0b8
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-f060627b5e72e5d9b292dd120a45db0cf868d0b8

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

GirlBossRush · 2025-09-09T13:18:31Z

web/packages/core/version/node.js

-export function readGitBuildHash() {
-    try {
-        const commit = execSync("git rev-parse HEAD", {
-            encoding: "utf8",
-            cwd: MonoRepoRoot,
-        })
-            .toString()
-            .trim();
-
-        return commit;
-    } catch (_error) {
-        console.debug("Git commit could not be read.");
-    }
-
-    return process.env.GIT_BUILD_HASH || "";
-}


Vestigial function, removed

GirlBossRush · 2025-09-09T13:42:40Z

web/src/admin/blueprints/BlueprintForm.ts

+                              .bighelp=${html`<p class="pf-c-form__helper-text">
+                                      ${msg(
+                                          html` A valid OCI manifest URL, prefixed with the protocol
+                                              e.g.&nbsp;<code


Some words such as e.g. seem to have a special effect on VoiceOver and are automatically substituted for a phrase:

"e.g. foo, bar, baz." -> "Such as, foo, bar, baz."

Maybe we can put together a list as they're discovered?

GirlBossRush · 2025-09-10T21:30:23Z

web/src/elements/tests/ak-array-input.test.ts

@@ -11,7 +11,7 @@ import { html } from "lit";

 const sampleItems: FooterLink[] = [
    { name: "authentik", href: "https://goauthentik.io" },
-    { name: "authentik docs", href: "https://docs.goauthentik.io/docs/" },
+    { name: "authentik docs", href: "https://docs.goauthentik.io" },


Avoiding usage of import.meta.env here since the element test doesn't use the same bundle config.

GirlBossRush · 2025-09-10T21:42:22Z

web/packages/core/version/node.js

+if (prerelease) {
+    ReleaseNotesURL = new URL("/releases", PreReleaseDocsURL);
+} else {
+    ReleaseNotesURL = new URL(`releases/${VersionPath}`, CurrentReleaseDocsURL);

-    return [AuthentikVersion, GIT_BUILD_HASH].join("+");
+    ReleaseNotesURL.hash = `fixed-in-${[major, minor, patch].join("")}`;


We might be able to make this anchor less fragile with a generic #latest-release-notes link in the docs.

GirlBossRush requested a review from a team as a code owner September 8, 2025 17:31

GirlBossRush commented Sep 8, 2025

View reviewed changes

GirlBossRush force-pushed the fix-web-docs-links branch 3 times, most recently from 4d18682 to 2bfc025 Compare September 9, 2025 12:51

GirlBossRush commented Sep 9, 2025

View reviewed changes

GirlBossRush self-assigned this Sep 9, 2025

GirlBossRush requested review from BeryJu and kensternberg-authentik September 9, 2025 13:08

GirlBossRush added bug Something isn't working documentation Improvements or additions to documentation a11y Features or bugs related to accessibility labels Sep 9, 2025

GirlBossRush commented Sep 9, 2025

View reviewed changes

GirlBossRush force-pushed the fix-web-docs-links branch from b915c38 to bc91ff0 Compare September 10, 2025 21:19

GirlBossRush commented Sep 10, 2025

View reviewed changes

GirlBossRush force-pushed the fix-web-docs-links branch from cea1b24 to 15d903b Compare September 15, 2025 13:01

GirlBossRush added 7 commits September 15, 2025 17:19

web: Clarify required marker when using screen reader.

06ca938

web: Mark helper text as input descriptor.

69912b4

web: Use next domain when in development.

531b9bf

web: Clean up constants. Fix attribute mapping.

72ea7ad

web: use previous function name.

8ecf916

web: Fix sort.

4573db9

web: Use constant.

72ecb5f

GirlBossRush added 2 commits September 15, 2025 17:21

web: Use prefix.

be653a7

web: keep using current release for notes.

f060627

GirlBossRush force-pushed the fix-web-docs-links branch from 15d903b to f060627 Compare September 15, 2025 15:21

BeryJu approved these changes Sep 16, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

web: Fix docs links, a11y input descriptors #16671

web: Fix docs links, a11y input descriptors #16671

Uh oh!

GirlBossRush commented Sep 8, 2025 •

edited

Loading

Uh oh!

netlify bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

netlify bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

netlify bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

GirlBossRush Sep 8, 2025 •

edited

Loading

Uh oh!

codecov bot commented Sep 8, 2025 •

edited

Loading

Uh oh!

GirlBossRush Sep 9, 2025

Uh oh!

github-actions bot commented Sep 9, 2025 •

edited

Loading

Uh oh!

GirlBossRush Sep 9, 2025

Uh oh!

GirlBossRush Sep 9, 2025 •

edited

Loading

Uh oh!

GirlBossRush Sep 10, 2025

Uh oh!

GirlBossRush Sep 10, 2025

Uh oh!

Uh oh!

		<a class="pf-u-mb-xl" href=${url} ${external ? 'target="_blank"' : ""}>
		${external

Uh oh!

web: Fix docs links, a11y input descriptors #16671

Are you sure you want to change the base?

web: Fix docs links, a11y input descriptors #16671

Uh oh!

Conversation

GirlBossRush commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Details

1. Version Constants

2. Documentation links

3. Miscellaneous

Uh oh!

netlify bot commented Sep 8, 2025 • 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 Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for authentik-storybook ready!

Uh oh!

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

Uh oh!

✅ Deploy Preview for authentik-integrations ready!

Uh oh!

GirlBossRush Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Sep 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

GirlBossRush Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GirlBossRush Sep 9, 2025

Choose a reason for hiding this comment

Uh oh!

GirlBossRush Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

GirlBossRush Sep 10, 2025

Choose a reason for hiding this comment

Uh oh!

GirlBossRush Sep 10, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

GirlBossRush commented Sep 8, 2025 •

edited

Loading

netlify bot commented Sep 8, 2025 •

edited

Loading

netlify bot commented Sep 8, 2025 •

edited

Loading

netlify bot commented Sep 8, 2025 •

edited

Loading

GirlBossRush Sep 8, 2025 •

edited

Loading

codecov bot commented Sep 8, 2025 •

edited

Loading

github-actions bot commented Sep 9, 2025 •

edited

Loading

GirlBossRush Sep 9, 2025 •

edited

Loading