authentik icon indicating copy to clipboard operation
authentik copied to clipboard

website/integrations: update part of the documentation to new style and cleanup

Open dominic-r opened this issue 1 year ago • 7 comments

Details

This PR updates the remaining integration documentation pages to match the new style guide


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 avatar Aug 22 '24 21:08 dominic-r

Deploy Preview for authentik-storybook canceled.

Name Link
Latest commit 62c80745026f1c816c467df4891e3364713c6baf
Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/66d70f062b23550008939897

netlify[bot] avatar Aug 22 '24 21:08 netlify[bot]

Deploy Preview for authentik-docs canceled.

Name Link
Latest commit 62c80745026f1c816c467df4891e3364713c6baf
Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/66d70f06275be3000853305e

netlify[bot] avatar Aug 22 '24 21:08 netlify[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.76%. Comparing base (78e4370) to head (62c8074). Report is 71 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11030      +/-   ##
==========================================
- Coverage   92.77%   92.76%   -0.02%     
==========================================
  Files         736      736              
  Lines       36426    36426              
==========================================
- Hits        33796    33789       -7     
- Misses       2630     2637       +7     
Flag Coverage Δ
e2e 49.26% <ø> (-0.02%) :arrow_down:
integration 25.01% <ø> (ø)
unit 90.23% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Aug 22 '24 21:08 codecov[bot]

Thanks @4d62 some good catches and fixes in here. I see you have it as Draft, sorry I hope it's ok I went ahead and added a few edits. Let me know when you're ready for final review.

Also, sorry to say, looks like the build failed on lint-prettier. Can you run make website and push again?

tanberry avatar Aug 27 '24 20:08 tanberry

@tanberry Hi, all good. If you don't mind i'll just finish with the rest of the integration documentation before running the make commands. As for the content itself, it would need some double checking, but I don't have experience with all the things so I wouldn't be able to confirm or deny.

dominic-r avatar Aug 27 '24 20:08 dominic-r

I just updated general styles on the existing docs but i feel like i'll need to pass through it again and make sure it follows everything as I do see some missing things

dominic-r avatar Aug 27 '24 20:08 dominic-r

@tanberry Hi, all good. If you don't mind i'll just finish with the rest of the integration documentation before running the make commands. As for the content itself, it would need some double checking, but I don't have experience with all the things so I wouldn't be able to confirm or deny.

Okeee sounds good, just please don't make TOOOOO big of a PR... maybe sections at a time? :-) I'm a fan of nice discreet chunks in a PR; smaller PRs seem to go on more smoothly.

tanberry avatar Aug 28 '24 12:08 tanberry