Skip to content

website: Use Docusaurus Frontmatter for badges#12893

Merged
GirlBossRush merged 1 commit intogoauthentik:mainfrom
GirlBossRush:badge-frontmatter-tidy-v2
Feb 19, 2025
Merged

website: Use Docusaurus Frontmatter for badges#12893
GirlBossRush merged 1 commit intogoauthentik:mainfrom
GirlBossRush:badge-frontmatter-tidy-v2

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
@netlify
Copy link

netlify bot commented Jan 30, 2025

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit 824fcc1
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67b6162e10b23200088d2a93
😎 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.

@netlify
Copy link

netlify bot commented Jan 30, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 824fcc1
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67b6162e3525530008df3fb2
😎 Deploy Preview https://deploy-preview-12893--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 Jan 30, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.66%. Comparing base (c67de17) to head (824fcc1).
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12893      +/-   ##
==========================================
- Coverage   92.75%   92.66%   -0.09%     
==========================================
  Files         792      792              
  Lines       40197    40222      +25     
==========================================
- Hits        37286    37273      -13     
- Misses       2911     2949      +38     
Flag Coverage Δ
e2e 48.02% <ø> (-0.11%) ⬇️
integration 24.12% <ø> (-0.01%) ⬇️
unit 90.44% <ø> (-0.04%) ⬇️

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
@BeryJu BeryJu changed the title Use Docusaurus Frontmatter. Tidy badges website: Use Docusaurus Frontmatter for badges Jan 30, 2025
@GirlBossRush GirlBossRush force-pushed the badge-frontmatter-tidy-v2 branch 6 times, most recently from d10f560 to d5d400d Compare February 14, 2025 02:20
@tanberry tanberry self-requested a review February 17, 2025 19:43
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.

In general I am not a fan of changing extensions to/from .md/.mdx because I worry about broken external links, redirects, etc. and to me it is not worth the risk. But other than that I like the use of the Docusaurus labels so let's get this merged hehehe!

@fheisler
Copy link
Member

I don't think anyone should/could be externally linking to .md(x) 'paths' directly anyway!

@BeryJu
Copy link
Member

BeryJu commented Feb 17, 2025

Website links aren't changed by switching from md to mdx or vice versa

@tanberry
Copy link
Contributor

Website links aren't changed by switching from md to mdx or vice versa

Sure, couldn't that happen if an external person bookmarks a link to one of our docs that happens to be an .mdx file? Or would the extension get sorted out?

@tanberry
Copy link
Contributor

I don't think anyone should/could be externally linking to .md(x) 'paths' directly anyway!

I mean if someone external links to one of our docs pages that happens to be an .mdx instead of an .md file. But maybe Jens is saying the extension won't matter.

…omponents.

- Fix JSX class name warning.
- Remove duplicate titles.
- Flesh out `support_level` frontmatter.
@GirlBossRush GirlBossRush force-pushed the badge-frontmatter-tidy-v2 branch from d5d400d to 824fcc1 Compare February 19, 2025 17:34
@GirlBossRush GirlBossRush enabled auto-merge (squash) February 19, 2025 17:46
@GirlBossRush GirlBossRush merged commit a714c78 into goauthentik:main Feb 19, 2025
85 checks passed
@GirlBossRush GirlBossRush deleted the badge-frontmatter-tidy-v2 branch February 19, 2025 18:03
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