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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 4 commits into from
Mar 21, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9b41dda
add link to template
Mar 21, 2024
94b3db2
add link in devdocs too
Mar 21, 2024
6ef6609
fix links and tweaks
Mar 21, 2024
7d640a7
extra files
Mar 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions website/developer-docs/docs/templates/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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 changes: 13 additions & 8 deletions website/integrations/services/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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} />
Loading