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: add api reference docs to redirect file #12551

Merged
merged 1 commit into from
Jan 3, 2025
Merged

Conversation

tanberry
Copy link
Contributor

@tanberry tanberry commented Jan 3, 2025

This PR adds a section to the netlify.toml file to redirect api reference docs from their old, pre-migration location.


If applicable

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

@tanberry tanberry requested a review from a team as a code owner January 3, 2025 16:21
Copy link

netlify bot commented Jan 3, 2025

Deploy Preview for authentik-storybook canceled.

Name Link
🔨 Latest commit aefefbd
🔍 Latest deploy log https://app.netlify.com/sites/authentik-storybook/deploys/67780e74e95d5b00083582da

Copy link

netlify bot commented Jan 3, 2025

Deploy Preview for authentik-docs ready!

Name Link
🔨 Latest commit aefefbd
🔍 Latest deploy log https://app.netlify.com/sites/authentik-docs/deploys/67780e74aa0cb90008fbf102
😎 Deploy Preview https://deploy-preview-12551--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 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.75%. Comparing base (10ab6e4) to head (aefefbd).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #12551      +/-   ##
==========================================
- Coverage   92.76%   92.75%   -0.01%     
==========================================
  Files         770      770              
  Lines       38873    38873              
==========================================
- Hits        36059    36057       -2     
- Misses       2814     2816       +2     
Flag Coverage Δ
e2e 48.70% <ø> (-0.01%) ⬇️
integration 24.58% <ø> (ø)
unit 90.38% <ø> (-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 enabled auto-merge (squash) January 3, 2025 16:42
@tanberry tanberry merged commit 3cbfd83 into main Jan 3, 2025
71 checks passed
@tanberry tanberry deleted the docs-api-redirects branch January 3, 2025 16:44
Copy link
Contributor

github-actions bot commented Jan 3, 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-aefefbd4664e6a32a0b1071df02435c879f1c8cf
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-aefefbd4664e6a32a0b1071df02435c879f1c8cf-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
global:
    image:
        repository: ghcr.io/goauthentik/dev-server
        tag: gh-aefefbd4664e6a32a0b1071df02435c879f1c8cf

For arm64, use these values:

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-aefefbd4664e6a32a0b1071df02435c879f1c8cf-arm64

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

kensternberg-authentik added a commit that referenced this pull request Jan 8, 2025
* main:
  core: bump golang.org/x/oauth2 from 0.24.0 to 0.25.0 (#12571)
  website: bump the docusaurus group in /website with 9 updates (#12569)
  core: bump github.com/coreos/go-oidc/v3 from 3.11.0 to 3.12.0 (#12572)
  core: bump ruff from 0.8.5 to 0.8.6 (#12573)
  ci: release: fix AWS cfn template permissions (#12576)
  translate: Updates for file web/xliff/en.xlf in fr (#12578)
  translate: Updates for file locale/en/LC_MESSAGES/django.po in fr (#12577)
  sources/kerberos: authenticate with the user's username instead of the first username in authentik (#12497)
  website/integrations: Fix deprecated terraform ressource authentik_scope_mapping in docs (#12554)
  website/user-sources Fix Free IPA docs page (#12549)
  core: bump aws-cdk-lib from 2.173.4 to 2.174.0 (#12574)
  website/integrations: semaphore: fix formatting (#12567)
  website: bump aws-cdk from 2.173.4 to 2.174.0 in /website (#12570)
  website/integrations: Update Frappe Application index.md (#12527)
  website: add api reference docs to redirect file (#12551)
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