Skip to content

website/docs: Prepare for monorepo.#14119

Merged
GirlBossRush merged 6 commits intomainfrom
monorepo-docusaurus-prep
Apr 24, 2025
Merged

website/docs: Prepare for monorepo.#14119
GirlBossRush merged 6 commits intomainfrom
monorepo-docusaurus-prep

Conversation

@GirlBossRush
Copy link
Contributor

@GirlBossRush GirlBossRush commented Apr 17, 2025

Depends on #14120

Details

This PR updates the docs package in preparation for the monorepo branch. The changes applied are primarily linter and formatter fixes, with some additional type checking applied.

Also included is some partial improvements to the version dropdown's copy, clarifying our current default of showing docs planned for the next release of authentik.


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)

@netlify
Copy link

netlify bot commented Apr 17, 2025

Deploy Preview for authentik-storybook ready!

Name Link
🔨 Latest commit b9a6b01
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/680a7d841913370008bdb535
😎 Deploy Preview https://deploy-preview-14119--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 17, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit b9a6b01
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/680a7d845a9ce900088505c1
😎 Deploy Preview https://deploy-preview-14119--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.

@GirlBossRush GirlBossRush force-pushed the monorepo-docusaurus-prep branch from 9fc0a18 to 6f04c50 Compare April 17, 2025 01:30
@codecov
Copy link

codecov bot commented Apr 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.75%. Comparing base (3379566) to head (b9a6b01).
Report is 2 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14119      +/-   ##
==========================================
+ Coverage   92.70%   92.75%   +0.04%     
==========================================
  Files         809      809              
  Lines       41533    41533              
==========================================
+ Hits        38505    38525      +20     
+ Misses       3028     3008      -20     
Flag Coverage Δ
e2e 47.85% <ø> (+0.07%) ⬆️
integration 24.39% <ø> (ø)
unit 90.57% <ø> (ø)

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.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@GirlBossRush GirlBossRush force-pushed the monorepo-docusaurus-prep branch 2 times, most recently from c785bab to cabe58c Compare April 17, 2025 02:56
@GirlBossRush GirlBossRush self-assigned this Apr 17, 2025
@GirlBossRush GirlBossRush force-pushed the monorepo-docusaurus-prep branch 2 times, most recently from cdc3772 to de275f9 Compare April 17, 2025 04:11
@GirlBossRush GirlBossRush marked this pull request as ready for review April 17, 2025 04:12
@GirlBossRush GirlBossRush requested review from a team as code owners April 17, 2025 04:12
@GirlBossRush GirlBossRush force-pushed the monorepo-docusaurus-prep branch 4 times, most recently from 7d76055 to b566877 Compare April 17, 2025 04:38
@github-actions
Copy link
Contributor

github-actions bot commented Apr 17, 2025

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-3f76f3cbf7b5fe405df2f6e1cf6f12de258db99f
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
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-3f76f3cbf7b5fe405df2f6e1cf6f12de258db99f

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

@GirlBossRush GirlBossRush changed the title website: Prepare for monorepo. website/docs: Prepare for monorepo. Apr 21, 2025
@GirlBossRush GirlBossRush force-pushed the monorepo-docusaurus-prep branch from b566877 to 825fa8f Compare April 21, 2025 19:08
@GirlBossRush GirlBossRush requested a review from a team as a code owner April 21, 2025 19:08
@GirlBossRush GirlBossRush force-pushed the monorepo-docusaurus-prep branch 3 times, most recently from d0e0ddd to 3e817e6 Compare April 22, 2025 14:26
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 so much @GirlBossRush I so look forward to the new version picker!

@GirlBossRush GirlBossRush force-pushed the monorepo-docusaurus-prep branch from 3e817e6 to 085a055 Compare April 23, 2025 17:27
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.

A couple of textual examples that users depend upon were changed, and I'd like to see those restored for consistency. Prettier will "fix" tables where some lines are longer than the limit in a way that breaks the point of using a table: to help the dev (or learner) understand that it is a table, and it can be understood as a spreadsheet-like thing.

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.

Much better!

@GirlBossRush GirlBossRush force-pushed the monorepo-docusaurus-prep branch from 2b38f92 to 3f76f3c Compare April 24, 2025 01:51
@GirlBossRush GirlBossRush force-pushed the monorepo-docusaurus-prep branch from efc0929 to b9a6b01 Compare April 24, 2025 18:05
@GirlBossRush GirlBossRush enabled auto-merge (squash) April 24, 2025 18:10
@GirlBossRush GirlBossRush merged commit 5bdef1c into main Apr 24, 2025
87 of 89 checks passed
@GirlBossRush GirlBossRush deleted the monorepo-docusaurus-prep branch April 24, 2025 18:22
melizeche added a commit that referenced this pull request Apr 24, 2025
melizeche added a commit that referenced this pull request Apr 24, 2025
GirlBossRush added a commit that referenced this pull request May 2, 2025
@GirlBossRush GirlBossRush mentioned this pull request May 5, 2025
6 tasks
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