Skip to content

Commit

Permalink
Add tts-documentation-url (#1372)
Browse files Browse the repository at this point in the history
* doc: Add stack-documentation-url

* doc: Update wording
  • Loading branch information
LDannijs authored Sep 11, 2024
1 parent 4de85c6 commit e738f7b
Showing 1 changed file with 6 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,13 @@ All of the webhook templates must contain the following fields which describe th
- `logo-url`: The URL of the logo of the service.
- `info-url`: The URL of the main page of the service.
- `documentation-url`: The URL of the documentation of the service.
- `tts-documentation-url`: The URL of the documentation of the service on `thethingsindustries.com/docs`.

The difference between `documentation-url` and `info-url` is that `info-url` should lead to the home page of the service (i.e. `https://www.thethingsnetwork.org/`), while `documentation-url` should lead directly to the location of the documentation (i.e. `https://www.thethingsnetwork.org/docs/applications/example/`).
Here are the differences between `info-url`, `documentation-url` and `tts-documentation-url`:

- `info-url` should lead to the home page of the service (i.e. `https://www.thethingsnetwork.org/`).
- `documentation-url` should be used for the location of the documentation on the service's page (i.e. `https://www.thethingsnetwork.org/docs/applications/example/`).
- `tts-documentation-url` meanwhile should be used for the guides in our documentation (see [cloud-integrations]({{< relref "../../cloud-integrations/_index.md" >}})).

## Template Fields

Expand Down

0 comments on commit e738f7b

Please sign in to comment.