-
-
Notifications
You must be signed in to change notification settings - Fork 1k
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
base: main
Are you sure you want to change the base?
website/docs: style guide & integration template: revamp #12929
Conversation
✅ Deploy Preview for authentik-storybook canceled.
|
✅ Deploy Preview for authentik-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
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
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this 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.
2d5fa82
to
b53b3f0
Compare
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]>
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]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: Dominic R <[email protected]>
Signed-off-by: Dominic R <[email protected]>
b53b3f0
to
375fc18
Compare
Depends on #13179 |
Signed-off-by: Dominic R <[email protected]>
Signed-off-by: Dominic R <[email protected]>
Signed-off-by: Dominic R <[email protected]>
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
ak test authentik/
)make lint-fix
)If an API change has been made
make gen-build
)If changes to the frontend have been made
make web
)If applicable
make website
)