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: add default values change warning #12777

Merged

Conversation

4d62
Copy link
Contributor

@4d62 4d62 commented Jan 23, 2025

sdko/integrations-all/values-changed-warning

From meeting: https://www.notion.so/authentiksecurity/Check-ins-17caee05b24e80a0aec6c7d508406435?pvs=4#1e85c3daa1e94d939f70acc5745a6c3f

What?

This PR adds a message under the preparation section of every integration guide mentioning that only values that have been changed from their defaults are mentioned in the guide + that configuration errors might lead to access errors

How?

Ran the following script from the root of the authentik repository:

find website/integrations/services/ -type f \( -name "*.md" -o -name "*.mdx" \) -exec perl -i -pe \
'if (/^- `authentik\.company` is the FQDN of the authentik installation\./) {
    $_ .= "\n:::note\nThis documentation lists only the settings that have been changed from their default values. Be aware that any changes other than those explicitly mentioned in this guide could cause issues accessing your application.\n:::\n"
}' {} +

There are a few scenarios where this didn't work:

  • If the documentation used the old placeholder format
  • If the regex match sentence was not the last one in the preparation section
  • And more

If that was the case, the block was inserted manually. (Worked for almost all pages 75-80%)

What else?

Note update

The note's first sentence was updated. As a result, I ran the following command from the root of the authentik repository to find and replace:

find website/integrations/services/ -type f \( -iname "*.md" -o -iname "*.mdx" \) -exec perl -pi -e 's/This documentation lists only the settings that have been changed from their default values./This documentation lists only the settings that you need to change from their default values./g' {} +

Details

REPLACE ME


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)

@4d62 4d62 requested a review from a team as a code owner January 23, 2025 02:36
Copy link

netlify bot commented Jan 23, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit f8e012d
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67999446119c4e00084e3896

Copy link

netlify bot commented Jan 23, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit f8e012d
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/6799944620e9560008dc5f3d
😎 Deploy Preview https://deploy-preview-12777--authentik-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

codecov bot commented Jan 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.69%. Comparing base (692a6be) to head (f8e012d).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12777      +/-   ##
==========================================
- Coverage   92.75%   92.69%   -0.06%     
==========================================
  Files         769      769              
  Lines       38929    38929              
==========================================
- Hits        36108    36085      -23     
- Misses       2821     2844      +23     
Flag Coverage Δ
e2e 48.48% <ø> (-0.09%) ⬇️
integration 24.60% <ø> (ø)
unit 90.39% <ø> (ø)

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.

@4d62 4d62 requested a review from tanberry January 27, 2025 20:12
4d62 added a commit to 4d62/authentik that referenced this pull request Jan 29, 2025
@4d62
Copy link
Contributor Author

4d62 commented Jan 29, 2025

sigh

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.

Wow, great note to add to all 100+ Integration guides, thanks @4d62 .

@tanberry tanberry enabled auto-merge (squash) January 29, 2025 02:44
@tanberry tanberry merged commit 773c57b into goauthentik:main Jan 29, 2025
66 checks passed
@4d62 4d62 deleted the sdko/integrations-all/values-changed-warning branch January 29, 2025 03:01
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.

2 participants