Skip to content

website/docs: move Sources from Integrations into Docs#9515

Merged
tanberry merged 16 commits intomainfrom
docs-move-sources
May 6, 2024
Merged

website/docs: move Sources from Integrations into Docs#9515
tanberry merged 16 commits intomainfrom
docs-move-sources

Conversation

@tanberry
Copy link
Contributor

@tanberry tanberry commented Apr 29, 2024

This PR moves all of the Sources docs over to the Docs menu, out of the Integrations, and cleans up the LDAP Source page.
-- moved /sources directory
-- updated sidebars.js and sidebarsIntegrations/js
-- updated the netlify.toml file to handle redirects for any incoming, external links
-- fixed broken links between files
-- reorganized all the Settings on the LDAP Source page to reflect the UI... [TODO] still need to clarify the Synch parent group field (I don't see it on the UI).

UPDATE: I added a new landing page for Integrations, that links to both Applications and to Sources.

  • The documentation has been updated
  • The documentation has been formatted (make website)

@tanberry tanberry requested a review from a team as a code owner April 29, 2024 19:24
@netlify
Copy link

netlify bot commented Apr 29, 2024

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit dc87a96
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/66395a284ac3d100085f8086
😎 Deploy Preview https://deploy-preview-9515--authentik-storybook.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.

@netlify
Copy link

netlify bot commented Apr 29, 2024

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit dc87a96
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/66395a285d63e30008a6c685
😎 Deploy Preview https://deploy-preview-9515--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.

@tanberry tanberry requested a review from BeryJu April 29, 2024 19:24
@codecov
Copy link

codecov bot commented Apr 29, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.49%. Comparing base (b1b9c8e) to head (dc87a96).

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #9515       +/-   ##
===========================================
+ Coverage   52.00%   92.49%   +40.49%     
===========================================
  Files         669      669               
  Lines       32899    32899               
===========================================
+ Hits        17109    30431    +13322     
+ Misses      15790     2468    -13322     
Flag Coverage Δ
e2e 50.56% <ø> (ø)
integration 25.92% <ø> (ø)
unit 89.78% <ø> (?)

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.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 29, 2024

authentik PR Installation instructions

Instructions for docker-compose

Add the following block to your .env file:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-ghcr.io/goauthentik/dev-server:gh-dc87a96c41a30e879779d2ee771f2640763f71d3
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

For arm64, use these values:

AUTHENTIK_IMAGE=ghcr.io/goauthentik/dev-server
AUTHENTIK_TAG=gh-ghcr.io/goauthentik/dev-server:gh-dc87a96c41a30e879779d2ee771f2640763f71d3-arm64
AUTHENTIK_OUTPOSTS__CONTAINER_IMAGE_BASE=ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s

Afterwards, run the upgrade commands from the latest release notes.

Instructions for Kubernetes

Add the following block to your values.yml file:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
image:
    repository: ghcr.io/goauthentik/dev-server
    tag: gh-ghcr.io/goauthentik/dev-server:gh-dc87a96c41a30e879779d2ee771f2640763f71d3

For arm64, use these values:

authentik:
    outposts:
        container_image_base: ghcr.io/goauthentik/dev-%(type)s:gh-%(build_hash)s
image:
    repository: ghcr.io/goauthentik/dev-server
    tag: gh-ghcr.io/goauthentik/dev-server:gh-dc87a96c41a30e879779d2ee771f2640763f71d3-arm64

Afterwards, run the upgrade commands from the latest release notes.

@tanberry tanberry requested a review from rissson May 1, 2024 12:26
@authentik-automation
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 17.1%, saving 25.93 KB.

Filename Before After Improvement Visual comparison
website/integrations/apps-logo.png 101.84 KB 93.57 KB -8.1% View diff
website/integrations/sources-logo.png 49.77 KB 32.10 KB -35.5% View diff

151 images did not require optimisation.

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.

More nitpicking. Otherwise fine.

Copy link
Member

@rissson rissson left a comment

Choose a reason for hiding this comment

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

I'll approve in principal, not sure I'll have time to review the whole text soon

Tana M Berry added 2 commits May 6, 2024 16:56
Merge branch 'main' into docs-move-sources
@tanberry tanberry merged commit d8b1cd7 into main May 6, 2024
@tanberry tanberry deleted the docs-move-sources branch May 6, 2024 22:49
kensternberg-authentik added a commit that referenced this pull request May 8, 2024
* main: (42 commits)
  website/docs: prepare 2024.4.2 release notes (#9555)
  web: bump the esbuild group in /web with 2 updates (#9616)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in ru (#9611)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in zh_CN (#9560)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in zh-Hans (#9563)
  ci: bump golangci/golangci-lint-action from 5 to 6 (#9615)
  web: bump esbuild from 0.20.2 to 0.21.0 in /web (#9617)
  core: bump cryptography from 42.0.6 to 42.0.7 (#9618)
  core: bump sentry-sdk from 2.0.1 to 2.1.1 (#9619)
  core: bump django from 5.0.4 to 5.0.5 (#9620)
  core, web: update translations (#9613)
  website/docs: move Sources from Integrations into Docs (#9515)
  website/docs: add procedurals to flow inspector docs (#9556)
  core: bump jinja2 from 3.1.3 to 3.1.4 (#9610)
  web: clean up the options rendering in PromptForm (#9564)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in ru (#9608)
  website/docs: add instructions for deploying radius manually with docker compose (#9605)
  sources/scim: fix duplicate groups and invalid schema (#9466)
  core: fix condition in task clean_expiring_models (#9603)
  translate: Updates for file web/xliff/en.xlf in fr (#9600)
  ...
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