Skip to content

website/docs: stages cleanup#21558

Merged
dominic-r merged 6 commits intomainfrom
sdko/stages-docs-cleanup
May 7, 2026
Merged

website/docs: stages cleanup#21558
dominic-r merged 6 commits intomainfrom
sdko/stages-docs-cleanup

Conversation

@dominic-r
Copy link
Copy Markdown
Member

@dominic-r dominic-r commented Apr 13, 2026

Clean up the flows and stages documentation to bring it closer to the docs style guide and current content structure.

  • rewrite and normalize multiple stage pages for consistency, tone, and structure
  • convert several stage docs from .mdx to .md where MDX features were not needed
  • move a few standalone stage pages into index.md files under their stage directories
  • remove duplicate or outdated stage doc variants that were replaced by the new structure
  • make smaller wording and formatting fixes in nearby docs that link into flows, stages, and providers

@dominic-r dominic-r self-assigned this Apr 13, 2026
@dominic-r dominic-r requested a review from a team as a code owner April 13, 2026 03:06
@dominic-r dominic-r added the area:docs Features or issues related to Docusaurus label Apr 13, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 13, 2026

Deploy Preview for authentik-integrations ready!

Name Link
🔨 Latest commit ec8778d
🔍 Latest deploy log https://app.netlify.com/projects/authentik-integrations/deploys/69fccb7a3446880008d287f3
😎 Deploy Preview https://deploy-preview-21558--authentik-integrations.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 project configuration.

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 13, 2026

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit ec8778d
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/69fccb7a4c8b9a0008d48754
😎 Deploy Preview https://deploy-preview-21558--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 project configuration.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.24%. Comparing base (5a8a7d2) to head (0519781).
⚠️ Report is 3 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #21558      +/-   ##
==========================================
+ Coverage   93.18%   93.24%   +0.06%     
==========================================
  Files        1027     1027              
  Lines       59598    59598              
  Branches      400      400              
==========================================
+ Hits        55534    55575      +41     
+ Misses       4064     4023      -41     
Flag Coverage Δ
conformance 36.75% <ø> (+<0.01%) ⬆️
e2e 41.94% <ø> (+0.21%) ⬆️
integration 33.16% <ø> (+<0.01%) ⬆️
rust 0.00% <ø> (ø)
unit 92.18% <ø> (+<0.01%) ⬆️
unit-migrate 92.20% <ø> (-0.02%) ⬇️

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
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 13, 2026

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-05197814ca59765439ff8b405cddc3e0c7300722
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-05197814ca59765439ff8b405cddc3e0c7300722

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

@tanberry
Copy link
Copy Markdown
Contributor

Thanks @dominic-r for agreeing to take on this big task. I'll start reviewing today. Please do add a Description...

@tanberry tanberry self-requested a review April 13, 2026 09:37
Copy link
Copy Markdown
Contributor

@dewi-tik dewi-tik left a comment

Choose a reason for hiding this comment

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

First pass

Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_email/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_email/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_email/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_email/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/source/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/source/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/source/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/user_login/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/user_logout/index.md Outdated
@dominic-r dominic-r requested a review from dewi-tik April 14, 2026 22:18
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 14, 2026

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit ec8778d
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/69fccb7aa3c47c000777931f
😎 Deploy Preview https://deploy-preview-21558--authentik-storybook.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 project configuration.

Copy link
Copy Markdown
Contributor

@dewi-tik dewi-tik left a comment

Choose a reason for hiding this comment

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

Second pass

Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_duo/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_duo/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_duo/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_duo/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_duo/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_webauthn/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/consent/index.md
Comment thread website/docs/add-secure-apps/flows-stages/stages/deny/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/source/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/user_delete/index.md Outdated
Copy link
Copy Markdown
Contributor

@dewi-tik dewi-tik left a comment

Choose a reason for hiding this comment

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

Third pass

Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_totp/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_totp/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_totp/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_validate/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/authenticator_validate/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/user_delete/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/prompt/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/password/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/password/index.md Outdated
Comment thread website/docs/add-secure-apps/flows-stages/stages/password/index.md Outdated
Copy link
Copy Markdown
Contributor

@dewi-tik dewi-tik left a comment

Choose a reason for hiding this comment

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

Ok from my POV. @tanberry do you have any other suggestions?

@github-project-automation github-project-automation Bot moved this from Todo to In Progress in authentik Core May 4, 2026
@dominic-r dominic-r force-pushed the sdko/stages-docs-cleanup branch from 4e57783 to ec8778d Compare May 7, 2026 17:27
@dominic-r dominic-r enabled auto-merge (squash) May 7, 2026 17:27
@dominic-r dominic-r force-pushed the sdko/stages-docs-cleanup branch from ec8778d to 0519781 Compare May 7, 2026 17:30
@dominic-r dominic-r disabled auto-merge May 7, 2026 17:31
@dominic-r dominic-r merged commit a3a29d0 into main May 7, 2026
115 of 116 checks passed
@dominic-r dominic-r deleted the sdko/stages-docs-cleanup branch May 7, 2026 18:36
@github-project-automation github-project-automation Bot moved this from In Progress to Done in authentik Core May 7, 2026
kensternberg-authentik added a commit that referenced this pull request May 7, 2026
* main:
  locale: fix de_DE locale placeholder (#22130)
  website/docs: stages cleanup (#21558)
  website: bump the build group in /website with 3 updates (#22104)
  web: bump basic-ftp from 5.3.0 to 5.3.1 in /web (#22131)
  web: bump knip from 6.7.0 to 6.9.0 in /web (#22107)
kensternberg-authentik added a commit that referenced this pull request May 7, 2026
* main: (30 commits)
  locale: fix de_DE locale placeholder (#22130)
  website/docs: stages cleanup (#21558)
  website: bump the build group in /website with 3 updates (#22104)
  web: bump basic-ftp from 5.3.0 to 5.3.1 in /web (#22131)
  web: bump knip from 6.7.0 to 6.9.0 in /web (#22107)
  lifecycle/aws: bump aws-cdk from 2.1119.0 to 2.1120.0 in /lifecycle/aws (#22105)
  web: bump @sentry/browser from 10.50.0 to 10.51.0 in /web in the sentry group across 1 directory (#22106)
  ci: bump taiki-e/install-action from 2.75.30 to 2.76.0 in /.github/actions/setup (#22108)
  core, web: update translations (#22129)
  stage/authenticator*: expand attempt throttling to email- and sms-based 2FA (#21751)
  translate: Updates for project authentik and language pt_PT (#22122)
  translate: Updates for project authentik and language no_NO (#22120)
  stages/authenticator_webauthn: Update FIDO MDS3 & Passkey aaguid blobs (#22128)
  translate: Updates for project authentik and language ja_JP (#22118)
  translate: Updates for project authentik and language ru_RU (#22119)
  translate: Updates for project authentik and language tr_TR (#22125)
  translate: Updates for project authentik and language pl_PL (#22124)
  translate: Updates for project authentik and language pt_BR (#22111)
  translate: Updates for project authentik and language it_IT (#22123)
  translate: Updates for project authentik and language zh-Hans (#22121)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:docs Features or issues related to Docusaurus

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants