Skip to content
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/integrations: all general cleanup and updates #12716

Draft
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

dominic-r
Copy link
Contributor

@dominic-r dominic-r commented Jan 17, 2025

sdko/integration-batch-updates/a

What?

This is part A of the series of PRs to update all integration documentation and remove outdated elements.

Updating all integrations to use the new format for the "authentik configuration" section is a giant part of this. Most integrations use the old application/provider format, this needs to be updated to prepare for the 2025.2 release. Furthermore, some integrations were updated to include the "short" app/provider config. The long config is preferred to retain more information/make docs clearer.

Then, there's general cleanup here and there and matching the style guide.

Notable changes

Addition of IntegrationsMultilineCodeblock

Adds a IntegrationsMultilineCodeblock React component to easily render codeblocks containing <em> tags for example. It is more reusable than using <pre>s and <code>s everywhere. One drawback: All affected files will need to be renamed from .md to .mdx for the component to load correctly. Since @GirlBossRush and I are modifying integration documentation, this is going to be fun for one of us (Probably me) as the majority of the files will need to be renamed.

Needs styling fixes... badly

Usage

import IntegrationsMultilineCodeblock from "@site/src/components/Integrations/IntegrationsCodeblock"

<IntegrationsMultilineCodeblock>
{`
What has to be said
`}
</IntegrationsMultilineCodeblock>

Addition to style guide

  • Usage for multiline codeblocks
  • If need to specify env variable ex: ${OIDC_CLIENT_SECRET}, add $\{OIDC_CLIENT_SECRET} to not add build error.

OIDC configuration for Bookstack

Added configuration to log into Bookstack w/ OIDC instead of just SAML.

Rewriting the AWS integration documentation

This PR introduces a complete rewrite of the AWS documentation including a long awaited and needed restructuring.

Move React component imports to top of file

Moves all imports to react components / tab stuff to the top of the file to make it clearer and follow best-practices

Adding references

At least one reference has been added to each integration documentation page. It would be fun/ideal to require this for future documentation...!

Actual budget configure with env variables/json

You can also configure actual budget w/ env vars or the json file instead of playing around in the ui... interesting

A lot of cleanup

Yea

Internal links

Copy link

netlify bot commented Jan 17, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit d50846c
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67b00bcf87b85700080b85ca

Copy link

netlify bot commented Jan 17, 2025

Deploy Preview for authentik-docs failed. Why did it fail? →

Name Link
🔨 Latest commit d50846c
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67b00bcf87b85700080b85cc

Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.75%. Comparing base (de20897) to head (d50846c).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12716      +/-   ##
==========================================
+ Coverage   92.69%   92.75%   +0.06%     
==========================================
  Files         785      785              
  Lines       39623    39623              
==========================================
+ Hits        36728    36753      +25     
+ Misses       2895     2870      -25     
Flag Coverage Δ
e2e 48.48% <ø> (+0.08%) ⬆️
integration 24.54% <ø> (ø)
unit 90.43% <ø> (+<0.01%) ⬆️

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

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

@tanberry tanberry changed the title website/integrations: all: general cleanup and updates website/integrations: all general cleanup and updates Jan 17, 2025
Copy link
Contributor

@tanberry tanberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @4d62 !

@dominic-r
Copy link
Contributor Author

@tanberry I don't think this is ready for merge yet. I'll finish, if you don't mind, all of the section outlined in notion before merging. Just to not make too many of these

@dominic-r dominic-r force-pushed the sdko/integration-batch-updates/a branch 3 times, most recently from ec33301 to e4217aa Compare January 31, 2025 19:57
nicedevil007 added a commit to nicedevil007/authentik that referenced this pull request Feb 2, 2025
Copy link
Contributor

@kensternberg-authentik kensternberg-authentik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had one request for change; I'm quite serious about not writing your own security code.

@dominic-r dominic-r force-pushed the sdko/integration-batch-updates/a branch from a548660 to c400aba Compare February 12, 2025 23:40
@dominic-r
Copy link
Contributor Author

dominic-r commented Feb 12, 2025

Ken, thanks for the review. Here's an updated version which should fix what was addressed here and on Slack. My dompurify implementation feels botched tho I have absolutely no idea how to make this JSDOM thing work and SSR and whatever else on Netlify. I've passed through the 7 stages of grief with coding

@dominic-r dominic-r force-pushed the sdko/integration-batch-updates/a branch from 16f0f21 to 39eb4d2 Compare February 13, 2025 16:15
Update integrations: Apache Guacamole, ArgoCD, Arube Orchestrator

website/integrations: wmigr + cleanup: work on batch a

website/integrations: all: add note about default values + fix build

try this

Signed-off-by: 4d62 <[email protected]>

Update website/integrations/services/apache-guacamole/index.mdx

Co-authored-by: Tana M Berry <[email protected]>
Signed-off-by: 4d62 <[email protected]>

website/integrations: batch-a: fix some stuff and kbd try

website/integrations: freshrss + gatus: cleanup

website/integrations: frappe: cleanup

website/integrations: fortimanager: cleanup

website/integrations: fix build

website/integrations: fortimanager: set more <em>s and <kbd>s

website/integrations: fortimanager: fix build

website/integrations: aws: wow this is taking longer than I imagined

a few scim things i can add back but idk heh

included w/ goauthentik#12777 now

website: add IntegrationsMultilineCodeblock component

add types

slightly more manageable margins/issues w/ copy button

fix rendering of html tags. This might be overengineered, I have no idea

cloudflare-access + chronograf migrate

fix ide warnings I think

start budibase cleanup, chronograf finish env content, component fix codeql warning

argocd cleanup start; remove tf config to match other docs; touch up apache-guac verif

start aws cleanup #2

bookstack refactor + add oidc config; move imports to top of files

actual budget cfg validation; bookstack upd; cfa add cfg validation; gatus revamp; component support multiline ex: yaml

add references to gatus, freshrss, frappe; frappe new authentik config format, freshrss revamp; fix typo in bookstack cfg

actual budget json file + env too; guac fix import loc

guac ref + add what needs to be added to eval env file first

budibase cleanup + bookstack global ref instead of per provider

fix budibase title

chronograf + cfa; ref + verif steps

lowercase espocrm doc

fortimanager cleanup

espocrm

References -> Ressources for doc section + Firezone cleanup

docuwiki cleanup + chronograf @ cfg verif upd name

fix espocrm elements

id like to think I improved the react component; took not too long im surprised + fix espocrm tag

ken's suggestions

i love you mr IDE

it worked locally...

try something

i like frontend

idk

this literally does nothing

make it od something

fix my mistake

fix package.json
@dominic-r dominic-r force-pushed the sdko/integration-batch-updates/a branch from 39eb4d2 to f6b9221 Compare February 13, 2025 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants