✅ Deploy Preview for authentik-docs ready!

Name	Link
🔨 Latest commit	8ee5785
🔍 Latest deploy log	https://app.netlify.com/sites/authentik-docs/deploys/66565f6774490c0008a4e35f
😎 Deploy Preview	https://deploy-preview-9713--authentik-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

✅ Deploy Preview for authentik-storybook canceled.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.63%. Comparing base (fd66be9) to head (8ee5785).
Report is 65 commits behind head on main.

@@            Coverage Diff             @@
##             main    #9713      +/-   ##
==========================================
- Coverage   92.64%   92.63%   -0.01%     
==========================================
  Files         710      710              
  Lines       34706    34744      +38     
==========================================
+ Hits        32152    32185      +33     
- Misses       2554     2559       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

I've noticed that integration documentation varies greatly in style—from the inclusion of images to the use of numbers in headers, and more. I'd be happy to update older documentation to match the new style guide you mentioned once it's released, if needed.

@4d62ext you're right, the variation amongst the Integrations docs is wild... I have been sorta kinda trying to get a hold on it all, but haven't managed to yet. Your help, as much or as little as you have time for, would be greatly appreciated.

I think that the biggest variations are in the headers (as you pointed out), the capitalization, and the ordering of the sections (sometimes authentik is first, sometimes it is last). And yes, also the use of numbered Steps. That is something I struggle with even in our regular docs; whether or not to use numbered steps. It has become less and less common, but my old-fashioned self thinks they are very useful. Sometimes several steps can be grouped together into one section, and that section labeled Step 1 ... as opposed to numbering literally every line and having 27 steps, lol. But it is a tricky one. I'd like your input on whether it makes sense in the Integration docs.

Finally, I did just push a PR #9900 with our baby Style Guide... we are open to input on that as well; it's just a start.

Thank you for all your help with authentik!

Oh, forgot to say... in general, I'd like to limit the use of screenshots/images in the docs (too much maintenance). The only time we want to use them is if there is a particularly difficult-to-find UI element, and we need to show where it is.

@tanberry I personally find it better if it is streamlined it into just a list of steps without necessarily distinguishing between the two sections. It feels less cramped and also allows proper headers and sections (Ex: steps directly in h2 instead of authentik Settings being h2 and a step being h3) As for the numbering in headers, I'm inclined to agree with you. Most documentation pages are self-explanatory and a chunk of the images could be removed. I'll open a few pull requests once the style guide is released and my contribution in #9899 is marked ready for review. It is simply renaming functions so it should not take too much time. Mabye a few test fixes as well.

Thanks again, @4d62ext ! I am not sure if I prefer the way you did it, with the H2s being steps that continue in numbering through the two sections, or keeping the authentik config and service config as separate sections with separately numbered steps. I'll have a chat with the team and tweak the template (that no one can find anyway haha) to reflect the decision.

But in the meantime let's get this important integration doc out there! :-)