Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website: Use Docusaurus Frontmatter for badges #12893

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

GirlBossRush
Copy link
Contributor

Details

This PR is composed of several small fixes that focus on long-term goal to reduce boilerplate that appears in doc pages, such as...

  • Version badges indicating the minimum release needed to use certain features
  • Enterprise badges indicating a feature is limited to a specific plan
  • Preview badges indicating that a feature is still in development

Also included are a few fragile anchor links, missing syntax highlights on code blocks, and typo fixes.


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)

@GirlBossRush GirlBossRush requested review from a team as code owners January 30, 2025 12:20
Copy link

netlify bot commented Jan 30, 2025

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit a44def2
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/679b709aa0ebcf00088ea6f5
😎 Deploy Preview https://deploy-preview-12893--authentik-storybook.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.

Copy link

netlify bot commented Jan 30, 2025

Deploy Preview for authentik-docs canceled.

Name Link
🔨 Latest commit a44def2
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/679b709a8e2fb600087b849f

Copy link

codecov bot commented Jan 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.76%. Comparing base (773c57b) to head (a44def2).
Report is 12 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12893      +/-   ##
==========================================
+ Coverage   92.75%   92.76%   +0.01%     
==========================================
  Files         769      769              
  Lines       38929    38929              
==========================================
+ Hits        36108    36113       +5     
+ Misses       2821     2816       -5     
Flag Coverage Δ
e2e 48.62% <ø> (+0.05%) ⬆️
integration 24.60% <ø> (ø)
unit 90.40% <ø> (ø)

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.

@GirlBossRush GirlBossRush force-pushed the badge-frontmatter-tidy-v2 branch from d28da25 to a44def2 Compare January 30, 2025 12:29
@GirlBossRush GirlBossRush requested a review from a team as a code owner January 30, 2025 12:29
<span class="badge badge--version">authentik 2024.12+</span>
<p className="badge-group">

<VersionBadge semver="2024.12" />
Copy link
Member

Choose a reason for hiding this comment

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

I'm assuming we can't easily do multiple badges without a wrapper?

@@ -62,7 +64,7 @@ When an unauthenticated user attempts to access a secured resource, they are red

When a user authenticates/enrolls via an external source, this will be set to the source they are using.

#### `outpost` (dictionary) <span class="badge badge--version">authentik 2024.10+</span>
#### `outpost` (dictionary)&nbsp;<VersionBadge semver="2024.10" />
Copy link
Member

Choose a reason for hiding this comment

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

Same with this, I'm assuming there's no simple way of doing this in a cleaner way without using  

@BeryJu BeryJu changed the title Use Docusaurus Frontmatter. Tidy badges website: Use Docusaurus Frontmatter for badges Jan 30, 2025
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