Skip to content

website/docs: fix typos and style issues#22141

Merged
dominic-r merged 25 commits intomainfrom
sdko/docs-typo-cleanup-20260507-205130
May 9, 2026
Merged

website/docs: fix typos and style issues#22141
dominic-r merged 25 commits intomainfrom
sdko/docs-typo-cleanup-20260507-205130

Conversation

@dominic-r
Copy link
Copy Markdown
Member

Summary

  • Fix typos, product-name casing, and terminology issues across docs and integration guides
  • Align headings and UI wording with the documentation style guide
  • Clean up grammar and punctuation in affected Markdown/MDX pages

Validation

  • npx cspell $(cat /tmp/typo_changed_files_final.txt) --config cspell.config.jsonc --no-progress --show-suggestions
  • npx prettier --check $(cat /tmp/typo_changed_files_final.txt)
  • git diff --check origin/main...HEAD

@dominic-r dominic-r requested a review from a team as a code owner May 8, 2026 01:08
@dominic-r dominic-r self-assigned this May 8, 2026
@dominic-r dominic-r added the area:docs Features or issues related to Docusaurus label May 8, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented May 8, 2026

Deploy Preview for authentik-integrations ready!

Name Link
🔨 Latest commit d815a8a
🔍 Latest deploy log https://app.netlify.com/projects/authentik-integrations/deploys/69ff5461914d8700086c155d
😎 Deploy Preview https://deploy-preview-22141--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 May 8, 2026

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit d815a8a
🔍 Latest deploy log https://app.netlify.com/projects/authentik-docs/deploys/69ff5461e46ad900089a35c1
😎 Deploy Preview https://deploy-preview-22141--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 May 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.24%. Comparing base (c810bec) to head (d815a8a).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #22141      +/-   ##
==========================================
- Coverage   93.26%   93.24%   -0.03%     
==========================================
  Files        1028     1028              
  Lines       59692    59692              
  Branches      400      400              
==========================================
- Hits        55672    55658      -14     
- Misses       4020     4034      +14     
Flag Coverage Δ
conformance 36.74% <ø> (ø)
e2e 41.98% <ø> (-0.05%) ⬇️
integration 33.16% <ø> (+<0.01%) ⬆️
rust 0.00% <ø> (ø)
unit 92.13% <ø> (+<0.01%) ⬆️
unit-migrate 92.15% <ø> (-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 May 8, 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-d815a8ad38ee2b9baef37375b97048187a04c078
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-d815a8ad38ee2b9baef37375b97048187a04c078

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

Signed-off-by: Dominic R <dominic@goauthentik.io>
Comment thread website/docs/add-secure-apps/flows-stages/flow/examples/flows.md Outdated
Signed-off-by: Dominic R <dominic@goauthentik.io>
Comment thread website/docs/add-secure-apps/flows-stages/flow/inspector.md Outdated
Comment thread website/docs/add-secure-apps/providers/gws/configure-gws.md Outdated
Comment thread website/docs/customize/interfaces/_generalattributes.mdx
Comment thread website/docs/developer-docs/docs/style-guide.mdx Outdated
Comment thread website/docs/developer-docs/docs/style-guide.mdx
Comment thread website/docs/developer-docs/contributing.md Outdated
Comment thread website/integrations/chat-communication-collaboration/rocketchat/index.md Outdated
Comment thread website/integrations/cloud-providers/hashicorp-cloud/index.md Outdated
Comment thread website/integrations/cloud-providers/hashicorp-cloud/index.md
Comment thread website/integrations/dashboards/organizr/index.md Outdated
Comment thread website/integrations/infrastructure/argocd/index.md
Comment thread website/integrations/infrastructure/phpipam/index.md Outdated
Comment thread website/integrations/platforms/salesforce/index.md Outdated
Comment thread website/integrations/platforms/salesforce/index.md Outdated
Comment thread website/integrations/security/bitwarden/index.mdx Outdated
Copy link
Copy Markdown
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

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

Good stuff, excellent editing. A few nits (capitalization of industry terms, etc) but approving now so you can merge it as soon as yo make the edits... some of these files will cause merge conflict with incoming docs for 2026.5, so please merge as soon as possible.

@github-project-automation github-project-automation Bot moved this from Todo to In Progress in authentik Core May 8, 2026
@BeryJu BeryJu added backport/version-2026.5 Add this label to PRs to backport changes to version-2026.5 and removed backport/version-2026.5 labels May 8, 2026
@dominic-r dominic-r enabled auto-merge (squash) May 9, 2026 15:39
@dominic-r dominic-r merged commit 2c45230 into main May 9, 2026
115 checks passed
@dominic-r dominic-r deleted the sdko/docs-typo-cleanup-20260507-205130 branch May 9, 2026 15:58
@github-project-automation github-project-automation Bot moved this from In Progress to Done in authentik Core May 9, 2026
@authentik-automation
Copy link
Copy Markdown
Contributor

⚠️ Cherry-pick to version-2026.5 has conflicts: #22189

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 backport/version-2026.5 Add this label to PRs to backport changes to version-2026.5

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants