Skip to content

website/docs: minor fixes#13095

Merged
BeryJu merged 1 commit intogoauthentik:mainfrom
S33G:main
Feb 18, 2025
Merged

website/docs: minor fixes#13095
BeryJu merged 1 commit intogoauthentik:mainfrom
S33G:main

Conversation

@S33G
Copy link
Contributor

@S33G S33G commented Feb 17, 2025

Spotted a minor thing while setting up Discord with authentik

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

Signed-off-by: seeg <dev@charlie.fyi>
@S33G S33G requested a review from a team as a code owner February 17, 2025 20:02
@netlify
Copy link

netlify bot commented Feb 17, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 8f1a5df
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67b395f2ef1a650008dc19c1

@netlify
Copy link

netlify bot commented Feb 17, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 8f1a5df
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67b395f2ed672e0008070b6d
😎 Deploy Preview https://deploy-preview-13095--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.

@S33G S33G changed the title docs(discord): minor fixes website/docs: minor fixes Feb 17, 2025

9. **Name:** Choose a name (For the example I used Discord)
10. **Slug:** discord (You can choose a different slug, if you do you will need to update the Discord redirect URLand point it to the correct slug.)
9. **Name:** Choose a name (For the example I used `Discord`)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
9. **Name:** Choose a name (For the example I used `Discord`)
9. **Name:** Choose a name (For the example I used Discord)

Copy link
Contributor

Choose a reason for hiding this comment

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

Whew this is an interesting one... per our Style Guide, yes, we use code font for values (values that you enter into a field, like say a URL). But for a name... even though it is a vlaue per se, we wouldn't use code font. Though now you have me thinking on this... ;-)

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 so much for these fixes, @S33G, much appreciated! I am not sure I agree about one of your edits (the Name), but let's merge and I'll work on that question later. ;-)

@codecov
Copy link

codecov bot commented Feb 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.80%. Comparing base (e7538b8) to head (8f1a5df).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #13095      +/-   ##
==========================================
- Coverage   92.82%   92.80%   -0.02%     
==========================================
  Files         792      792              
  Lines       40218    40218              
==========================================
- Hits        37333    37325       -8     
- Misses       2885     2893       +8     
Flag Coverage Δ
e2e 48.24% <ø> (-0.02%) ⬇️
integration 24.48% <ø> (ø)
unit 90.51% <ø> (-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.

Copy link
Member

@dominic-r dominic-r left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for your contribution! I'm surprised we never spotted this before today. ( Oh and I don't agree with what Tana said, but let's keep it for a later date as she suggested 😉)

@BeryJu BeryJu merged commit e86b451 into goauthentik:main Feb 18, 2025
82 of 84 checks passed
kensternberg-authentik added a commit that referenced this pull request Feb 20, 2025
* main:
  web/user: fix opening application with Enter not respecting new tab setting (#13115)
  web: bump API Client version (#13113)
  providers/rac: move to open source (#13015)
  website/docs: add 2025.2 release notes (#13002)
  core: clear expired database sessions (#13105)
  core: bump sentry-sdk from 2.21.0 to 2.22.0 (#13098)
  core: bump bandit from 1.8.2 to 1.8.3 (#13097)
  core: bump aws-cdk-lib from 2.178.2 to 2.179.0 (#13099)
  core: bump goauthentik.io/api/v3 from 3.2024123.4 to 3.2024123.6 (#13100)
  lifecycle/aws: bump aws-cdk from 2.178.2 to 2.179.0 in /lifecycle/aws (#13101)
  website/docs: Add AdventureLog Community Integration Documentation (#12928)
  website/docs: minor fixes (#13095)
  website/integrations: Update to Wizard and Styling Guide (#12919)
  web: bump API Client version (#13093)
  policies/geoip: distance + impossible travel (#12541)
  root: fix generated API docs not being excluded from codespell (#13091)
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.

4 participants