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

Add tts-documentation-url #1372

Merged
merged 3 commits into from
Sep 11, 2024
Merged

Add tts-documentation-url #1372

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e4f5bf5
doc: Add stack-documentation-url
LDannijs Aug 15, 2024
3835532
doc: Update wording
LDannijs Aug 20, 2024
ab61e9d
Merge branch 'TheThingsIndustries:master' into stack-documentation-url
LDannijs Sep 10, 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
7 changes: 6 additions & 1 deletion doc/content/integrations/webhooks/webhook-templates/format.md
View file
Open in desktop
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
Loading