website/integrations: Update to Wizard and Styling Guide #12919
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 #12919 +/- ##
=======================================
Coverage 92.72% 92.72%
=======================================
Files 770 770
Lines 38945 38945
=======================================
Hits 36113 36113
Misses 2832 2832
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Hi, thank you for your contribution! Unfortunately, some of the changes in this PR will have to be superseded by this PR due to the nature/quantity of the changes. #12716 and merging as-is would cause unnecessary merge conflicts.
Please do let me know when the duplicate part(s) are removed and i'd be happy to take a look at this
goauthentik#12716 Signed-off-by: NiceDevil <17103076+nicedevil007@users.noreply.github.com>
|
Guess actual budget was the only one that was in the PR mentioned. So I took a look at the other changes on the PR you linked here. As I go over my old PRs files I found the setting:
Should this not be in all PRs that reference the Wizard to create the SP/App. And yes I know: Would be a story for an other day :) I guess the maingoal of all you nice guys here that are responsible for documentation want to change all guides to the Wizard at anytime. |
|
Actually, it's not just changing all to use the wizard, naming all throughout the docs also needs to get updated as the word "wizard" will no longer appear in the UI. As for the setting you found, I do believe the following sentence from the new template includes this: |
ok :) so this PR is there anything I should do right now? |
There was a problem hiding this comment.
Hi. Thanks for this! Just a few things I noticed. Other than that, it looks quite good and I appreciate the time you took to update your previous contributions. Once this PR is accepted by @tanberry as well as myself, I'll merge relevant changes to my working branch to add the React component/new authentik configuration format. Nevertheless, it is greatly appreciated 🙏
| @@ -0,0 +1,87 @@ | |||
| --- | |||
There was a problem hiding this comment.
Why is the engomo documentation renamed to use a mdx file? No React components are being used. It doesn't really matter that much as it shows up in the UI the same, I'm just curious. I'll be sure to outline this in the style guide!
There was a problem hiding this comment.
Thought this is the right format nowadays, so I used the update to get to this file extension as well. Was the one I took on most of my other PRs as well. Just to be honest, I never thought about it what is the right or wrong one. Just wanted to make everything similar 🙈
| @@ -14,6 +14,8 @@ sidebar_label: RustDesk Server Pro | |||
| > Ideal for businesses, it provides full control over data while ensuring scalable and reliable remote access. | |||
| > | |||
| > -- https://rustdesk.com/ | |||
| > | |||
| > This guide explains how to configure Rustdesk Server Pro to use authentik as the OAuth provider for logging in to the Web GUI. | |||
There was a problem hiding this comment.
This added sentence is not part of the integration template.
There was a problem hiding this comment.
Was a line on all my other docs why I added it here now as well. As I started making docs for authentik I just copied anyone else others doc from a different app and started from this point 😂
There was a problem hiding this comment.
haha yea I get it. I can't say I never did the same with some stuff. I'm just trying to standardize existing documentation to get a good base. That means a lot of cleanup, yes, but I think it's for the good. The sentence itself is a good idea, but I feel like it's already implied if you get what I mean
There was a problem hiding this comment.
So if the most recent template is the best I can start; then I can start from scratch before you review the rest from here and then having to review it again. I'm absolutely on your side on standardizing stuff. That was sometimes a problem here for me. Started first PRs with fortigate stuff here then I copy pasted my old Fortigate guide and used it as my template for next PR, then stuff told me to use on FGT wasn't good anymore 😂 will do my best to keep this docs here as you want 👌
Used new knowledge on how to better contribute to update my "old" OAuth Docs.
Ty @dominic-r
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)