Skip to content

website/docs: capitalized proper name of stages, removed old version references. - #16414

Merged
tanberry merged 2 commits into
mainfrom
docs-stage-names
Aug 28, 2025
Merged

website/docs: capitalized proper name of stages, removed old version references.#16414
tanberry merged 2 commits into
mainfrom
docs-stage-names

Conversation

@tanberry

@tanberry tanberry commented Aug 27, 2025

Copy link
Copy Markdown
Contributor

Tiny PR to capitalize the few stage names that were not, also a few tweaks to one file to remove old version references.

  • The documentation has been updated
  • The documentation has been formatted (make docs)

@tanberry
tanberry requested a review from a team as a code owner August 27, 2025 15:15
@netlify

netlify Bot commented Aug 27, 2025

Copy link
Copy Markdown

Deploy Preview for authentik-integrations ready!

Name Link
🔨 Latest commit 00f3131
🔍 Latest deploy log https://app.netlify.com/projects/authentik-integrations/deploys/68b04d7ec36c190008ebaf06
😎 Deploy Preview https://deploy-preview-16414--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

netlify Bot commented Aug 27, 2025

Copy link
Copy Markdown

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 00f3131
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/68b04d7e2b98de0008e2253a
😎 Deploy Preview https://deploy-preview-16414--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.

@netlify

netlify Bot commented Aug 27, 2025

Copy link
Copy Markdown

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 00f3131
🔍 Latest deploy log https://app.netlify.com/projects/authentik-storybook/deploys/68b04d7ee366fb00087e7856

@codecov

codecov Bot commented Aug 27, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.78%. Comparing base (5a26382) to head (00f3131).
⚠️ Report is 27 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #16414      +/-   ##
==========================================
- Coverage   92.79%   92.78%   -0.01%     
==========================================
  Files         838      838              
  Lines       45290    45290              
==========================================
- Hits        42026    42024       -2     
- Misses       3264     3266       +2     
Flag Coverage Δ
e2e 46.57% <ø> (+<0.01%) ⬆️
integration 23.53% <ø> (+<0.01%) ⬆️
unit 90.93% <ø> (-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.

@kensternberg-authentik kensternberg-authentik left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Capitalization looks good, but I have some grammar quibbles.

### Dynamic groups

Starting with authentik 2022.5, users can be added to dynamic groups. To do so, simply set `groups` in the flow plan context before this stage is run, for example
To add users to dynamic groups set `groups` in the flow plan context before this stage is run, for example:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Generally, I find fewer commas helps, but in this case, this is a run-on sentence in two different ways.

"To add users to dynamic groups, set groups in the flow plan context before this stage is run. For example:"

@dominic-r dominic-r Aug 27, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

For Ken's sake, and many others, try to not use too many commas (avoid commaitis).

https://docs.goauthentik.io/developer-docs/docs/style-guide/#punctuation

;)

I disagree with this edit too. I find that adding a comma after groups adds the little touch to make it more readable and for example should be its own sentence group too

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

agree, I was moving too fast and that period is needed... I will put it in.

Comment thread website/docs/add-secure-apps/flows-stages/stages/user_write.md Outdated
@github-actions

github-actions Bot commented Aug 27, 2025

Copy link
Copy Markdown
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-00f3131147c7a75f2b73a67de58789bb7c602465
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-00f3131147c7a75f2b73a67de58789bb7c602465

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

@tanberry
tanberry merged commit 738b603 into main Aug 28, 2025
108 checks passed
@tanberry
tanberry deleted the docs-stage-names branch August 28, 2025 14:27
authentik-automation Bot pushed a commit that referenced this pull request Aug 28, 2025
…references. (#16414)

* capitalized proper name of stages, removed old version references.

* ken and dominics edits

---------

Co-authored-by: Tana M Berry <tana@goauthentik.io>
@authentik-automation

Copy link
Copy Markdown
Contributor

🍒 Cherry-pick to version-2025.8 created: #16450

tanberry added a commit that referenced this pull request Aug 28, 2025
…references. (cherry-pick #16414) (#16450)

website/docs: capitalized proper name of stages, removed old version references. (#16414)

* capitalized proper name of stages, removed old version references.

* ken and dominics edits

---------

Co-authored-by: Tana M Berry <tanamarieberry@yahoo.com>
Co-authored-by: Tana M Berry <tana@goauthentik.io>
kensternberg-authentik added a commit that referenced this pull request Sep 19, 2025
* main: (71 commits)
  website: Redirect Azure to Entra. Add tags for search indexing. (#16474)
  website: Page redirect guide, documentation (#16466)
  root: bump openapi-generator-cli to v7.15.0 (#16440)
  ci: bump actions/attest-build-provenance from 2 to 3 (#16462)
  core: bump astral-sh/uv from 0.8.13 to 0.8.14 (#16461)
  ci: remove Python client API publication (#16468)
  website: Unify Netlify redirects with Docusaurus's client-side router. (#16430)
  core: fix client-side only validation allowing admin to set blank user password (#16467)
  website/integrations: Update Issuer URL for Immich (#16460)
  providers/oauth2: include scope in JWT (#16454)
  lib/sync/outgoing: fix single object sync timeout (#16447)
  website/docs: capitalized proper name of stages, removed old version references. (#16414)
  web: bump pino-pretty from 13.0.0 to 13.1.1 in /web (#16411)
  core: bump h2 from 4.2.0 to 4.3.0 (#16446)
  web: bump @playwright/test from 1.54.1 to 1.55.0 in /web (#16413)
  web: bump the react group across 2 directories with 1 update (#16448)
  web: bump bootstrap from 5.3.7 to 5.3.8 in /web (#16416)
  web: bump @sentry/browser from 10.6.0 to 10.7.0 in /web in the sentry group across 1 directory (#16433)
  root: check for brew install of libxml2 before updating path (#16422)
  core: bump github.com/stretchr/testify from 1.11.0 to 1.11.1 (#16434)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants