website/integrations: add Actual budget #12590
Conversation
Signed-off-by: NiceDevil <[email protected]>
Signed-off-by: NiceDevil <[email protected]>
✅ 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 #12590 +/- ##
=======================================
Coverage 92.76% 92.76%
=======================================
Files 770 769 -1
Lines 38873 38840 -33
=======================================
- Hits 36059 36029 -30
+ Misses 2814 2811 -3
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.
Hey, thanks for your contribution. Just a few pointers to get this MR going. I'll do a more thorough review once some of these issues are fixed as I will have a better understanding / overview of this guide.
Also, I noticed the referenced UI elements are code-blocked. They should be put in bold as per the authentik developer documentation.
Please do let me know if you have any questions.
| - `actual.company` is the FQDN of the Actual Budget install. | ||
| - `authentik.company` is the FQDN of the authentik install. | ||
|
|
||
| ## authentik configuration |
There was a problem hiding this comment.
We are in the process of updating documentation to use the Wizard instead of manual application/provider configuration. Would it be possible to update this section to reflect these changes? Please do LMK if you have any Wizard-related questions
There was a problem hiding this comment.
Heya, good morning 😊 thank you for reviewing my PR again!
Is there an example or template on how the documentation pages should look like after we all should use the wizard instead of the manual steps?
Just oriented myself now the last PR for Semaphore UI 😂
There was a problem hiding this comment.
Hi @nicedevil007 , you can refer yourself to the Komga integration for now
There was a problem hiding this comment.
Is this mandatory for this PR? I would do it for my next guide, I don't want to start from scratch again 😭
Learned something new how git works and what I should try to avoid next time (node modules 😂 f.e.)
I guess this guide is close to the same structure as my other guides I already have written here an you reviewed, at least I hope so 😊
There was a problem hiding this comment.
If @tanberry is fine with keeping the change for a later PR, it's fine with me
There was a problem hiding this comment.
You'd at least need to fix this:
Also, I noticed the referenced UI elements are code-blocked. They should be put in bold as per the authentik developer documentation.
There was a problem hiding this comment.
Let's leave it as it is for now, and change it to use the Wizard later. The Wizard is still in Preview, anyway... so when we make it the default then we can update all of the Integration guides. :-)
Thanks @nicedevil007 for this guide! Let me review quickly (thanks @4d62 for your edits!) and let's get this merged...
Co-authored-by: 4d62 <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Signed-off-by: NiceDevil <[email protected]>
Signed-off-by: NiceDevil <[email protected]>
|
|
||
| > Actual Budget is a super-fast and privacy-focused app for managing your finances. At its core is the well-proven and much-loved envelope budgeting methodology. | ||
| > You own your data and can do whatever you want with it. It features multi-device sync, optional end-to-end encryption, and much more. | ||
| > |
There was a problem hiding this comment.
Normally I would rewrite the markety-hype description of the product, and state plainly what the product does, common use cases, etc. However, since this is a direct quote from the product's website, we can leave it for now. As a future project, we will probably rewrite all of them.
There was a problem hiding this comment.
I can do it for this PR as well, we don't have to wait 😂
There was a problem hiding this comment.
OK, a few edits, but overall looks great. We really appreciate your adding another integration guide, @nicedevil007 !
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
Co-authored-by: Tana M Berry <[email protected]> Signed-off-by: NiceDevil <[email protected]>
|
Ahh I got it, changed all to bold now. I have one question now as I read through the docs again. Shouldn't this part:
then look like this?
According to this: And yes I guess then I have to rewrite a bit more. Oh, and finally, a big thank you to both of you for helping me improve my understanding of Git with every pull request! I truly appreciate it! But if I remember right, most documentations here are done with the code stuff "``" |
Co-authored-by: 4d62 <[email protected]> Signed-off-by: NiceDevil <[email protected]>
UI elements are bolded, values (such as the URL) are in code text, and variables are italicized. So yes, your rewrite is good, except for not sure why Authentik is bolded. But perhaps in the Actual Budget UI it is a selection... it's fine how it is! |
remove the part about client id and secret with description that it is from authentik because step 6 clears this already up and during the setup of the provider in authentik there is a hint that ID and secret is need later in this guide Signed-off-by: NiceDevil <[email protected]>
There was a problem hiding this comment.
Thanks again for this contribution, @nicedevil007 ! It looks really good, and thanks for your patience with my and @4d62 's constant edits, lol.
I know what you mean about the more you use git the more clear it becomes, so yeah this PR has been good practice I imagine. I am curious what you mentioned about modules, node modules? What was that exactly? Are you combining multiple repos using modules?
I think we can merge this now!
now with italic instead of codestuff for placeholders or variables Signed-off-by: NiceDevil <[email protected]>
oh I just changed it to italic now everywhere whaaaaaaaaaa node_modules :D => I raised an earlier PR with ~ 56.000 files changed because I uploaded all my nodemodules to the git as well... @4d62 noticed this and teached me. btw: I raised an issue here => actualbudget/actual#4121 |
Details
I created a new documentation for Actual Budget. This got a recent update. Now it supports OpenID Connect :)
Checklist
ak test authentik/)make lint-fix)If applicable
make website)