habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website/deverlop-docs website/integrations: add links to integrations template (#8995)

Browse Source 
* add link to template

* add link in devdocs too

* fix links and tweaks

* extra files

---------

Co-authored-by: Tana M Berry <tana@goauthentik.com>
This commit is contained in:
Tana M Berry
2024-03-21 12:49:51 -05:00
committed by GitHub
parent da2eddfb5a
commit 51a33f330c
2 changed files with 21 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
website/developer-docs/docs/templates/index.md vendored
View File

@ -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
```

21
website/integrations/services/index.mdx
View File

@ -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:
- <span class="badge badge--secondary">Support level: Community</span> The integration
is community maintained.
- <span class="badge badge--secondary">Support level: Community</span>
- <span class="badge badge--info">Support level: Vendor</span> The integration
is supported by the vendor.
The integration is community maintained.
- <span class="badge badge--primary">Support level: authentik</span> The integration
is regularly tested by the authentik team.
- <span class="badge badge--info">Support level: Vendor</span>
### 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:
- <span class="badge badge--primary">Support level: authentik</span>
```
wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/integrations/_template/service.md
```
The integration is regularly tested by the authentik team.
## Integration categories
<DocCardList items={useCurrentSidebarCategory().items} />