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 & integration template: revamp #12929

Open
wants to merge 17 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 132282a
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67d4a516b2e16a0008938bf0

Copy link

netlify bot commented Feb 4, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit 132282a
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67d4a5168487110008a4b83a
😎 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.73%. Comparing base (876fecc) to head (132282a).
Report is 20 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12929      +/-   ##
==========================================
- Coverage   92.76%   92.73%   -0.03%     
==========================================
  Files         794      794              
  Lines       40419    40425       +6     
==========================================
- Hits        37494    37489       -5     
- Misses       2925     2936      +11     
Flag Coverage Δ
e2e 47.99% <ø> (-0.01%) ⬇️
integration 24.31% <ø> (+0.23%) ⬆️
unit 90.50% <ø> (-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.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@dominic-r dominic-r changed the title website/docs: style guide: revamp website/docs: style guide & integration template: revamp Feb 13, 2025
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.

Yay, looks great, thank you @dominic-r. Lets wait until 2025.2 goes out before we merge (since the UI will not change until then), but it is ready to merge on release day.

@dominic-r dominic-r force-pushed the sdko/docs/style-guide-n-template/prepare-2025-2 branch from 2d5fa82 to b53b3f0 Compare February 22, 2025 16:18
dominic-r and others added 11 commits February 26, 2025 18:41
Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Dominic R <[email protected]>
Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Dominic R <[email protected]>
Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: Dominic R <[email protected]>
Signed-off-by: Dominic R <[email protected]>
@dominic-r dominic-r force-pushed the sdko/docs/style-guide-n-template/prepare-2025-2 branch from b53b3f0 to 375fc18 Compare February 26, 2025 23:41
@dominic-r
Copy link
Contributor Author

Depends on #13179

@dominic-r dominic-r mentioned this pull request Mar 7, 2025
6 tasks
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