Skip to content

Commit

Permalink
website/docs: update template reference (#10166)
Browse files Browse the repository at this point in the history
docs: update template reference

Signed-off-by: Emmanuel Ferdman <[email protected]>
  • Loading branch information
emmanuel-ferdman authored Jun 19, 2024
1 parent c7c7e28 commit e6fd7cc
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions website/developer-docs/docs/templates/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ The most common types are:

### Add a new integration

To add documentation for a new integration (with support level Community or Vendor), please use the integration templates [`service.md`](https://github.com/goauthentik/authentik/blob/main/website/integrations/_template/service.md) from our GitHub repo. You can download the template using the following command:
To add documentation for a new integration (with support level Community or Vendor), please use the integration templates [`service.md`](https://github.com/goauthentik/authentik/blob/main/website/integrations/template/service.md) from our GitHub repo. You can download the template using the following command:

```shell
wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/integrations/_template/service.md
wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/integrations/template/service.md
```
2 changes: 1 addition & 1 deletion website/developer-docs/docs/writing-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Following the guidelines will make getting your PRs merged much easier and faste

In addition to following the [Style Guide](./style-guide.mdx) please review the following guidelines.

For new integration documentation, please use the Integrations template in our [Github repo](https://github.com/goauthentik/authentik) at `/website/integrations/_template/service.md`.
For new integration documentation, please use the Integrations template in our [Github repo](https://github.com/goauthentik/authentik) at `/website/integrations/template/service.md`.

- Make sure to add the service to a fitting category in `/website/sidebarsIntegrations.js`. If this is not done the service will not appear in the table of contents to the left.

Expand Down
2 changes: 1 addition & 1 deletion website/developer-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ This is documented in the [developer docs](./setup/frontend-dev-environment.md)

Contributions to the technical documentation are greatly appreciated. Open a PR if you have improvements to make or new content to add. If you have questions or suggestions about the documentation, open an Issue. No contribution is too small.

Please be sure to refer to our [Style Guide](../developer-docs/docs/style-guide.mdx) for the docs, and use a [template](./docs/templates/index.md) to make it easier for you. The style guidelines are also used for any Integrations documentation, and we have a template for Integrations as well, in our [Github repo](https://github.com/goauthentik/authentik) at `/website/integrations/_template/service.md`.
Please be sure to refer to our [Style Guide](../developer-docs/docs/style-guide.mdx) for the docs, and use a [template](./docs/templates/index.md) to make it easier for you. The style guidelines are also used for any Integrations documentation, and we have a template for Integrations as well, in our [Github repo](https://github.com/goauthentik/authentik) at `/website/integrations/template/service.md`.

### Pull Requests

Expand Down
4 changes: 2 additions & 2 deletions website/integrations/services/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Below is a list of all applications that are known to work with authentik. All a

### Add a new application

To add documentation for a new application (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:
To add documentation for a new application (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:

```shell
wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/integrations/_template/service.md
wget https://raw.githubusercontent.com/goauthentik/authentik/main/website/integrations/template/service.md
```

Don't forget to edit the `sidebarsIntegrations.js` file to add your new integration to the lefthand navigation bar.
Expand Down

0 comments on commit e6fd7cc

Please sign in to comment.