Skip to content

website/docs: updates style guide code block section#14088

Merged
tanberry merged 4 commits intomainfrom
website/docs/update-style-guide
Apr 22, 2025
Merged

website/docs: updates style guide code block section#14088
tanberry merged 4 commits intomainfrom
website/docs/update-style-guide

Conversation

@dewi-tik
Copy link
Contributor

Details

Updates the style guide:

  • removes multiline code blocks
  • explains docusaurus style code blocks

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

@netlify
Copy link

netlify bot commented Apr 15, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit 4ebcea7
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67feb1c9efa40c00081996bd

@netlify
Copy link

netlify bot commented Apr 15, 2025

Deploy Preview for authentik-docs ready!

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

@codecov
Copy link

codecov bot commented Apr 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.79%. Comparing base (81855cf) to head (4ebcea7).
Report is 52 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14088      +/-   ##
==========================================
+ Coverage   92.77%   92.79%   +0.01%     
==========================================
  Files         798      798              
  Lines       41138    41138              
==========================================
+ Hits        38167    38172       +5     
+ Misses       2971     2966       -5     
Flag Coverage Δ
e2e 47.84% <ø> (+<0.01%) ⬆️
integration 24.13% <ø> (ø)
unit 90.57% <ø> (ø)

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.

dewi-tik and others added 3 commits April 15, 2025 18:00
Co-authored-by: Dominic R <dominic@sdko.org>
Signed-off-by: Dewi Roberts <dewi@goauthentik.io>
@github-actions
Copy link
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-4ebcea7494a38f11e9e7a48e38925e011ff34fe4
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-4ebcea7494a38f11e9e7a48e38925e011ff34fe4

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

@dewi-tik dewi-tik marked this pull request as ready for review April 17, 2025 08:56
@dewi-tik dewi-tik requested a review from a team as a code owner April 17, 2025 08:56
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.

Thank you @dewi-tik ! I think it is safe to go ahead and merge this, right?

@tanberry tanberry merged commit fffcb00 into main Apr 22, 2025
91 checks passed
@tanberry tanberry deleted the website/docs/update-style-guide branch April 22, 2025 17:10
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.

3 participants