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 2 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 canceled.

Name Link
🔨 Latest commit 64ed946
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67accd294a412800084acb92

Copy link

netlify bot commented Jan 30, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 64ed946
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67accd2925957e0008cfeb3e
😎 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.

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 (cdc0d0a) to head (64ed946).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #12893   +/-   ##
=======================================
  Coverage   92.75%   92.76%           
=======================================
  Files         785      785           
  Lines       39584    39592    +8     
=======================================
+ Hits        36717    36727   +10     
+ Misses       2867     2865    -2     
Flag Coverage Δ
e2e 48.56% <ø> (+0.05%) ⬆️
integration 24.54% <ø> (+<0.01%) ⬆️
unit 90.43% <ø> (+<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.

@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 from a44def2 to 20aa5ef Compare February 12, 2025 00:26
…omponents.

- Fix JSX class name warning.
- Remove duplicate titles.
- Flesh out `support_level` frontmatter.
@GirlBossRush GirlBossRush force-pushed the badge-frontmatter-tidy-v2 branch 2 times, most recently from 8f060e4 to 5ab0abf Compare February 12, 2025 16:28
@GirlBossRush GirlBossRush force-pushed the badge-frontmatter-tidy-v2 branch from 5ab0abf to 64ed946 Compare February 12, 2025 16:32
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