diff --git a/website/developer-docs/docs/templates/index.md b/website/developer-docs/docs/templates/index.md index f93ae5120a5a..6653f54f648e 100644 --- a/website/developer-docs/docs/templates/index.md +++ b/website/developer-docs/docs/templates/index.md @@ -2,7 +2,7 @@ title: "Templates" --- -In technical documentation, there are document "types" (similar to how there are data types). +In technical documentation, there are document "types" (similar to how there are data types). We have templates for the different types, to make it super-easy for whomever wants to contribute some documentation! The most common types are: @@ -14,4 +14,10 @@ The most common types are: - [**Reference**](./reference.md): this is typically tables or lists of reference information, such as configuration values, or functions, or most commmonly APIs. -We have templates for the different types, to make it super-easy for whomever wants to contribute some documentation! +### Add a new integration + +To add documentation for a new [integration](../../../integrations/) (with support level Community or Vendor), please use the integration template [`service.md`](https://github.com/goauthentik/authentik/blob/main/website/integrations/_template/service.md) file from our GitHub repo. You can download the template file using the following command: + +``` +wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/integrations/_template/service.md +``` diff --git a/website/integrations/services/index.mdx b/website/integrations/services/index.mdx index 3f91095cdc25..ac1ee323502e 100644 --- a/website/integrations/services/index.mdx +++ b/website/integrations/services/index.mdx @@ -6,20 +6,25 @@ slug: / import DocCardList from "@theme/DocCardList"; import { useCurrentSidebarCategory } from "@docusaurus/theme-common"; -Below is a list of all applications that are known to work with authentik. +Below is a list of all integrations, or applications that are known to work with authentik. All integrations will have one of these badges: -All integrations will have a combination of these badges: +- Support level: Community The integration + is community maintained. -- Support level: Community +- Support level: Vendor The integration + is supported by the vendor. - The integration is community maintained. +- Support level: authentik The integration + is regularly tested by the authentik team. -- Support level: Vendor +### Add a new integration - The integration is supported by the vendor. +To add documentation for a new integration (with support level Community or Vendor), please use the integration template [`service.md`](https://github.com/goauthentik/authentik/blob/main/website/integrations/_template/service.md) file from our GitHub repo. You can download the template file using the following command: -- Support level: authentik +``` +wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/integrations/_template/service.md +``` - The integration is regularly tested by the authentik team. +## Integration categories