Skip to content

Commit

Permalink
Revert "website: latest migration to new structure" (#11634)
Browse files Browse the repository at this point in the history
Revert "website: latest migration to new structure (#11522)"

This reverts commit 9a89a5f.
  • Loading branch information
tanberry authored Oct 8, 2024
1 parent 9a89a5f commit 6b2fced
Show file tree
Hide file tree
Showing 336 changed files with 826 additions and 2,579 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--
👋 Hi there! Welcome.
Please check the Contributing guidelines: https://docs.goauthentik.io/docs/developer-docs/#how-can-i-contribute
Please check the Contributing guidelines: https://goauthentik.io/developer-docs/#how-can-i-contribute
-->

## Details
Expand Down
3 changes: 2 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,14 @@ pg_name := $(shell python -m authentik.lib.config postgresql.name 2>/dev/null)
CODESPELL_ARGS = -D - -D .github/codespell-dictionary.txt \
-I .github/codespell-words.txt \
-S 'web/src/locales/**' \
-S 'website/docs/developer-docs/api/reference/**' \
-S 'website/developer-docs/api/reference/**' \
authentik \
internal \
cmd \
web/src \
website/src \
website/blog \
website/developer-docs \
website/docs \
website/integrations \
website/src
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ For bigger setups, there is a Helm Chart [here](https://github.com/goauthentik/h

## Development

See [Developer Documentation](https://docs.goauthentik.io/docs/developer-docs/?utm_source=github)
See [Developer Documentation](https://goauthentik.io/developer-docs/?utm_source=github)

## Security

Expand Down
2 changes: 1 addition & 1 deletion authentik/blueprints/v1/importer.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
from authentik.tenants.models import Tenant

# Context set when the serializer is created in a blueprint context
# Update website/docs/customize/blueprints/v1/models.md when used
# Update website/developer-docs/blueprints/v1/models.md when used
SERIALIZER_CONTEXT_BLUEPRINT = "blueprint_entry"


Expand Down
2 changes: 1 addition & 1 deletion authentik/lib/default.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# update website/docs/install-config/configuration/configuration.mdx
# update website/docs/installation/configuration.mdx
# This is the default configuration file
postgresql:
host: localhost
Expand Down
2 changes: 1 addition & 1 deletion authentik/outposts/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ class ServiceConnectionInvalid(SentryIgnoredException):
class OutpostConfig:
"""Configuration an outpost uses to configure it self"""

# update website/docs/add-secure-apps/outposts/_config.md
# update website/docs/outposts/_config.md

authentik_host: str = ""
authentik_host_insecure: bool = False
Expand Down
2 changes: 1 addition & 1 deletion authentik/stages/prompt/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
class FieldTypes(models.TextChoices):
"""Field types an Prompt can be"""

# update website/docs/add-secure-apps/flows-stages/stages/prompt/index.md
# update website/docs/flow/stages/prompt/index.md

# Simple text field
TEXT = "text", _("Text: Simple Text input")
Expand Down
2 changes: 1 addition & 1 deletion scripts/api-ts-templates/README.mustache
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This package provides a generated API Client for [authentik](https://goauthentik

### Building

See https://docs.goauthentik.io/docs/developer-docs/making-schema-changes
See https://goauthentik.io/developer-docs/making-schema-changes

### Consuming

Expand Down
2 changes: 1 addition & 1 deletion web/src/admin/applications/ApplicationListPage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import "@goauthentik/admin/applications/ApplicationForm";
import { DEFAULT_CONFIG } from "@goauthentik/common/api/config";
import { PFSize } from "@goauthentik/common/enums.js";
import "@goauthentik/components/ak-app-icon";
import MDApplication from "@goauthentik/docs/add-secure-apps/applications/index.md";
import MDApplication from "@goauthentik/docs/applications/index.md";
import "@goauthentik/elements/Markdown";
import "@goauthentik/elements/buttons/SpinnerButton";
import "@goauthentik/elements/forms/DeleteBulkForm";
Expand Down
2 changes: 1 addition & 1 deletion web/src/admin/blueprints/BlueprintForm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ export class BlueprintForm extends ModelForm<BlueprintInstance, string> {
target="_blank"
rel="noopener noreferrer"
href="${docLink(
"/docs/customize/blueprints/?utm_source=authentik#storage---oci",
"/developer-docs/blueprints/?utm_source=authentik#storage---oci",
)}"
>${msg("Documentation")}</a
>
Expand Down
4 changes: 1 addition & 3 deletions web/src/admin/outposts/OutpostDeploymentModal.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ export class OutpostDeploymentModal extends ModalButton {
<p>
<a
target="_blank"
href="${docLink(
"/docs/add-secure-apps/outposts?utm_source=authentik#deploy",
)}"
href="${docLink("/docs/outposts?utm_source=authentik#deploy")}"
rel="noopener noreferrer"
>${msg("View deployment documentation")}</a
>
Expand Down
4 changes: 2 additions & 2 deletions web/src/admin/outposts/OutpostForm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ export class OutpostForm extends ModelForm<Outpost, string> {
<a
target="_blank"
rel="noopener noreferrer"
href="${docLink("/docs/add-secure-apps/outposts?utm_source=authentik")}"
href="${docLink("/docs/outposts?utm_source=authentik")}"
>${msg("See documentation")}</a
>.
</p>
Expand Down Expand Up @@ -251,7 +251,7 @@ export class OutpostForm extends ModelForm<Outpost, string> {
target="_blank"
rel="noopener noreferrer"
href="${docLink(
"/docs/add-secure-apps/outposts?utm_source=authentik#configuration",
"/docs/outposts?utm_source=authentik#configuration",
)}"
>${msg("Documentation")}</a
>
Expand Down
4 changes: 1 addition & 3 deletions web/src/admin/policies/expression/ExpressionPolicyForm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,7 @@ export class ExpressionPolicyForm extends BasePolicyForm<ExpressionPolicy> {
<a
rel="noopener noreferrer"
target="_blank"
href="${docLink(
"/docs/customize/policies/expression?utm_source=authentik",
)}"
href="${docLink("/docs/policies/expression?utm_source=authentik")}"
>
${msg("See documentation for a list of all variables.")}
</a>
Expand Down
2 changes: 1 addition & 1 deletion web/src/admin/property-mappings/BasePropertyMappingForm.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export abstract class BasePropertyMappingForm<T extends PropertyMapping> extends
string
> {
docLink(): string {
return "/docs/add-secure-apps/providers/property-mappings/expression?utm_source=authentik";
return "/docs/providers/property-mappings/expression?utm_source=authentik";
}

getSuccessMessage(): string {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ export class PropertyMappingProviderRACForm extends BasePropertyMappingForm<RACP
target="_blank"
rel="noopener noreferrer"
href="${docLink(
"/docs/add-secure-apps/providers/property-mappings/expression?utm_source=authentik",
"/docs/providers/property-mappings/expression?utm_source=authentik",
)}"
>
${msg("See documentation for a list of all variables.")}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { LDAPSourcePropertyMapping, PropertymappingsApi } from "@goauthentik/api
@customElement("ak-property-mapping-source-ldap-form")
export class PropertyMappingSourceLDAPForm extends BasePropertyMappingForm<LDAPSourcePropertyMapping> {
docLink(): string {
return "/docs/user-sources/sources/property-mappings/expressions?utm_source=authentik";
return "/docs/sources/property-mappings/expressions?utm_source=authentik";
}

loadInstance(pk: string): Promise<LDAPSourcePropertyMapping> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { OAuthSourcePropertyMapping, PropertymappingsApi } from "@goauthentik/ap
@customElement("ak-property-mapping-source-oauth-form")
export class PropertyMappingSourceOAuthForm extends BasePropertyMappingForm<OAuthSourcePropertyMapping> {
docLink(): string {
return "/docs/user-sources/sources/property-mappings/expressions?utm_source=authentik";
return "/docs/sources/property-mappings/expressions?utm_source=authentik";
}

loadInstance(pk: string): Promise<OAuthSourcePropertyMapping> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { PlexSourcePropertyMapping, PropertymappingsApi } from "@goauthentik/api
@customElement("ak-property-mapping-source-plex-form")
export class PropertyMappingSourcePlexForm extends BasePropertyMappingForm<PlexSourcePropertyMapping> {
docLink(): string {
return "/docs/user-sources/sources/property-mappings/expressions?utm_source=authentik";
return "/docs/sources/property-mappings/expressions?utm_source=authentik";
}

loadInstance(pk: string): Promise<PlexSourcePropertyMapping> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { PropertymappingsApi, SAMLSourcePropertyMapping } from "@goauthentik/api
@customElement("ak-property-mapping-source-saml-form")
export class PropertyMappingSourceSAMLForm extends BasePropertyMappingForm<SAMLSourcePropertyMapping> {
docLink(): string {
return "/docs/user-sources/sources/property-mappings/expressions?utm_source=authentik";
return "/docs/sources/property-mappings/expressions?utm_source=authentik";
}

loadInstance(pk: string): Promise<SAMLSourcePropertyMapping> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { PropertymappingsApi, SCIMSourcePropertyMapping } from "@goauthentik/api
@customElement("ak-property-mapping-source-scim-form")
export class PropertyMappingSourceSCIMForm extends BasePropertyMappingForm<SCIMSourcePropertyMapping> {
docLink(): string {
return "/docs/user-sources/sources/property-mappings/expressions?utm_source=authentik";
return "/docs/sources/property-mappings/expressions?utm_source=authentik";
}

loadInstance(pk: string): Promise<SCIMSourcePropertyMapping> {
Expand Down
2 changes: 1 addition & 1 deletion web/src/admin/providers/oauth2/OAuth2ProviderViewPage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { DEFAULT_CONFIG } from "@goauthentik/common/api/config";
import { EVENT_REFRESH } from "@goauthentik/common/constants";
import renderDescriptionList from "@goauthentik/components/DescriptionList";
import "@goauthentik/components/events/ObjectChangelog";
import MDProviderOAuth2 from "@goauthentik/docs/add-secure-apps/providers/oauth2/index.md";
import MDProviderOAuth2 from "@goauthentik/docs/providers/oauth2/index.md";
import { AKElement } from "@goauthentik/elements/Base";
import "@goauthentik/elements/CodeMirror";
import "@goauthentik/elements/EmptyState";
Expand Down
18 changes: 9 additions & 9 deletions web/src/admin/providers/proxy/ProxyProviderViewPage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ import { EVENT_REFRESH } from "@goauthentik/common/constants";
import { convertToSlug } from "@goauthentik/common/utils";
import "@goauthentik/components/ak-status-label";
import "@goauthentik/components/events/ObjectChangelog";
import MDCaddyStandalone from "@goauthentik/docs/add-secure-apps/providers/proxy/_caddy_standalone.md";
import MDNginxIngress from "@goauthentik/docs/add-secure-apps/providers/proxy/_nginx_ingress.md";
import MDNginxPM from "@goauthentik/docs/add-secure-apps/providers/proxy/_nginx_proxy_manager.md";
import MDNginxStandalone from "@goauthentik/docs/add-secure-apps/providers/proxy/_nginx_standalone.md";
import MDTraefikCompose from "@goauthentik/docs/add-secure-apps/providers/proxy/_traefik_compose.md";
import MDTraefikIngress from "@goauthentik/docs/add-secure-apps/providers/proxy/_traefik_ingress.md";
import MDTraefikStandalone from "@goauthentik/docs/add-secure-apps/providers/proxy/_traefik_standalone.md";
import MDHeaderAuthentication from "@goauthentik/docs/add-secure-apps/providers/proxy/header_authentication.md";
import MDCaddyStandalone from "@goauthentik/docs/providers/proxy/_caddy_standalone.md";
import MDNginxIngress from "@goauthentik/docs/providers/proxy/_nginx_ingress.md";
import MDNginxPM from "@goauthentik/docs/providers/proxy/_nginx_proxy_manager.md";
import MDNginxStandalone from "@goauthentik/docs/providers/proxy/_nginx_standalone.md";
import MDTraefikCompose from "@goauthentik/docs/providers/proxy/_traefik_compose.md";
import MDTraefikIngress from "@goauthentik/docs/providers/proxy/_traefik_ingress.md";
import MDTraefikStandalone from "@goauthentik/docs/providers/proxy/_traefik_standalone.md";
import MDHeaderAuthentication from "@goauthentik/docs/providers/proxy/header_authentication.md";
import { AKElement } from "@goauthentik/elements/Base";
import "@goauthentik/elements/CodeMirror";
import "@goauthentik/elements/Markdown";
Expand Down Expand Up @@ -166,7 +166,7 @@ export class ProxyProviderViewPage extends AKElement {
return input;
}
const extHost = new URL(this.provider.externalHost);
// See website/docs/add-secure-apps/providers/proxy/forward_auth.mdx
// See website/docs/providers/proxy/forward_auth.mdx
if (this.provider?.mode === ProxyMode.ForwardSingle) {
return input
.replaceAll("authentik.company", window.location.hostname)
Expand Down
2 changes: 1 addition & 1 deletion web/src/admin/providers/scim/SCIMProviderViewPage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import "@goauthentik/admin/rbac/ObjectPermissionsPage";
import { DEFAULT_CONFIG } from "@goauthentik/common/api/config";
import { EVENT_REFRESH } from "@goauthentik/common/constants";
import "@goauthentik/components/events/ObjectChangelog";
import MDSCIMProvider from "@goauthentik/docs/add-secure-apps/providers/scim/index.md";
import MDSCIMProvider from "@goauthentik/docs/providers/scim/index.md";
import { AKElement } from "@goauthentik/elements/Base";
import "@goauthentik/elements/Markdown";
import "@goauthentik/elements/SyncStatusCard";
Expand Down
2 changes: 1 addition & 1 deletion website/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ yarn-error.log*

static/docker-compose.yml
static/schema.yaml
docs/developer-docs/api/reference/**
developer-docs/api/reference/**
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Flow executor (backend)
---

A big focus of authentik is the flows system, which allows you to combine and build complex conditional processes using stages and policies. Normally, these flows are automatically executed in the browser using authentik's [standard browser-based flow executor (/if/flows)](../../add-secure-apps/flows-stages/flow/executors/if-flow.md).
A big focus of authentik is the flows system, which allows you to combine and build complex conditional processes using stages and policies. Normally, these flows are automatically executed in the browser using authentik's [standard browser-based flow executor (/if/flows)](/docs/flow/executors/if-flow).

However, any flow can be executed via an API from anywhere, in fact that is what every flow executor does. With a few requests you can execute flows from anywhere, and integrate authentik even better.

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Hackathon 2023

![hackathon-image](./horizontal-brandon-frie-rdHeGGn7rwQ-unsplash.jpg)

**REGISTRATION NOW CLOSED. PLEASE JOIN US FOR A FUTURE AUTHENTIK HACKATHON.**
**REGISTRATION NOW CLOSED! PLEASE JOIN US FOR A FUTURE AUTHENTIK HACKATHON.**

^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Contributing to authentik
slug: /
---

:+1::tada: Thanks for taking the time to contribute! :tada::+1:
Expand Down Expand Up @@ -116,7 +117,7 @@ When you are creating an enhancement suggestion, please fill in [the template](h

authentik can be run locally, all though depending on which part you want to work on, different pre-requisites are required.

This is documented in the [developer docs](./setup/frontend-dev-environment.md).
This is documented in the [developer docs](./setup/frontend-dev-environment.md)

### Help with the Docs

Expand All @@ -135,13 +136,13 @@ The process described here has several goals:

Please follow these steps to have your contribution considered by the maintainers:

1. Follow the [styleguides](#style-guides)
1. Follow the [styleguides](#styleguides)
2. After you submit your pull request, verify that all [status checks](https://help.github.com/articles/about-status-checks/) are passing <details><summary>What if the status checks are failing?</summary>If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.</details>
3. Ensure your Code has tests. While it is not always possible to test every single case, the majority of the code should be tested.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

## Style guides
## Styleguides

### PR naming

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Depending on platform, some native dependencies might be required. On macOS, run

### Instructions

1. Clone the git repo from https://github.com/goauthentik/authentik.
2. In the cloned repository, follow the docker-compose installation instructions [here](../../install-config/install/docker-compose).
1. Clone the git repo from https://github.com/goauthentik/authentik
2. In the cloned repository, follow the docker-compose installation instructions [here](/docs/installation/docker-compose)
3. Add the following entry to your `.env` file:

```
Expand All @@ -29,7 +29,7 @@ Depending on platform, some native dependencies might be required. On macOS, run

This will cause authentik to use the beta images.

4. Add this volume mapping to your compose file.
4. Add this volume mapping to your compose file

```yaml
services:
Expand Down
File renamed without changes.

This file was deleted.

Loading

0 comments on commit 6b2fced

Please sign in to comment.