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/docs: style guide: revamp #12929

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

Conversation

dominic-r
Copy link
Contributor

What?

This PR revamps the style guide and provides an updated version of the integration template in lieu of having an approximate non-written-with-new-app-creation-method template. I also took the time to highlight some things I noticed while reviewing PRs and some things I questioned myself about.

A good chunk of this PR is reformatting and rewriting existing information. Rest assured... new stuff was added.

I wanna try to get this done before I do more batch PRs, just to give myself (and others who contribute to integrations during this transition period) a stable base.

Hi @tanberry :) Have fun! I know you mentioned that other style guide, but I feel like integrating parts of it gradually would be more beneficial

Details

REPLACE ME


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)

@dominic-r dominic-r requested a review from a team as a code owner February 4, 2025 01:04
Copy link

netlify bot commented Feb 4, 2025

Deploy Preview for authentik-storybook canceled.

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

Copy link

netlify bot commented Feb 4, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit aa3dfd1
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67a16bd1ce0c5d0008d8da8c
😎 Deploy Preview https://deploy-preview-12929--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 Feb 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.74%. Comparing base (e4b6df3) to head (aa3dfd1).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12929      +/-   ##
==========================================
+ Coverage   92.72%   92.74%   +0.01%     
==========================================
  Files         770      770              
  Lines       38945    38945              
==========================================
+ Hits        36112    36118       +6     
+ Misses       2833     2827       -6     
Flag Coverage Δ
e2e 48.56% <ø> (+0.01%) ⬆️
integration 24.59% <ø> (ø)
unit 90.37% <ø> (+<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.

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.

1 participant