Skip to content

website/docs: dev docs: style guide: update style conventions for urls#14184

Merged
tanberry merged 2 commits intogoauthentik:mainfrom
dominic-r:sdko/style-guide/upd-url-req
Apr 22, 2025
Merged

website/docs: dev docs: style guide: update style conventions for urls#14184
tanberry merged 2 commits intogoauthentik:mainfrom
dominic-r:sdko/style-guide/upd-url-req

Conversation

@dominic-r
Copy link
Member

@dominic-r dominic-r commented Apr 22, 2025

Updates URL styling conventions to use angle bracket surrounded values instead of <em>s and <kbd>s

Part of https://www.notion.so/authentiksecurity/Check-ins-17caee05b24e80a0aec6c7d508406435?pvs=4#1ddaee05b24e80138155e120174c3502

Details

REPLACE ME


Checklist

  • Local tests pass (ak test authentik/)
  • The code has been formatted (make lint-fix)

If an API change has been made

  • The API schema has been updated (make gen-build)

If changes to the frontend have been made

  • The code has been formatted (make web)

If applicable

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

Updates URL styling conventions to use angle bracket surrounded values instead of <em>s and <kbd>s

Part of https://www.notion.so/authentiksecurity/Check-ins-17caee05b24e80a0aec6c7d508406435?pvs=4#1ddaee05b24e80138155e120174c3502

Signed-off-by: Dominic R <dominic@sdko.org>
@dominic-r dominic-r requested a review from a team as a code owner April 22, 2025 21:40
@netlify
Copy link

netlify bot commented Apr 22, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit fdd6cd0
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/6808102d44116d0008ccf58d
😎 Deploy Preview https://deploy-preview-14184--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 site configuration.

@netlify
Copy link

netlify bot commented Apr 22, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit fdd6cd0
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/6808102d03a51a0008f5b589

@dominic-r
Copy link
Member Author

Oh... That's why
image

@codecov
Copy link

codecov bot commented Apr 22, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.75%. Comparing base (fffcb00) to head (fdd6cd0).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #14184   +/-   ##
=======================================
  Coverage   92.75%   92.75%           
=======================================
  Files         808      808           
  Lines       41419    41419           
=======================================
+ Hits        38418    38419    +1     
+ Misses       3001     3000    -1     
Flag Coverage Δ
e2e 47.73% <ø> (ø)
integration 24.25% <ø> (ø)
unit 90.64% <ø> (ø)

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.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Signed-off-by: Dominic R <dominic@sdko.org>
Copy link
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.

thanks @dominic-r !

@tanberry tanberry merged commit 7f861cc into goauthentik:main Apr 22, 2025
87 of 88 checks passed
@dominic-r dominic-r deleted the sdko/style-guide/upd-url-req branch April 22, 2025 22:30
kensternberg-authentik added a commit that referenced this pull request Apr 25, 2025
* main:
  packages/docusaurus-theme: Fix header alignment, overscroll, vertical padding. (#14120)
  outposts: add support for gateway API (#13272)
  translate: Updates for file web/xliff/en.xlf in fr (#14200)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in fr (#14199)
  website/docs: adds code examples for getting user objects from a group object (#14101)
  translate: Updates for file web/xliff/en.xlf in zh-Hans (#14198)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in zh_CN (#14195)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in zh-Hans (#14197)
  translate: Updates for file web/xliff/en.xlf in zh_CN (#14196)
  website/integrations: mealie add integration (#14188)
  core, web: update translations (#14187)
  core: bump goauthentik.io/api/v3 from 3.2025024.8 to 3.2025024.9 (#14189)
  website/docs: update user object doc (#14132)
  website/docs: dev-docs: style guide: no longer using italic for vars (#14185)
  website/docs: dev docs: style guide: update style conventions for urls (#14184)
  website/integrations: paperless: use <slug>. instead of hardcoded slug value (#14183)
  website/docs: updates style guide code block section (#14088)
  website: components: delete multilinecodeblock src (#14094)
  Revert "policies: buffered policy access view for concurrent authorization attempts when unauthenticated (#13629)" (#14180)
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.

2 participants