Skip to content

Commit 85a8885

Browse files
committed
Templates: refine link guidelines, drop example links
1 parent 7f59e31 commit 85a8885

3 files changed

Lines changed: 3 additions & 2 deletions

File tree

templates/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,10 @@ Guidelines:
5252

5353
- The URL must start with `https://`.
5454
- Only add a link if it is useful for configuring the device, e.g. the cloud portal where credentials or tokens are managed, the page of the connected service, or the project page of a generic integration.
55+
- Link the page that describes the actual service being integrated, e.g. the dynamic tariff product page or the dataset page, not the company homepage. The homepage is fine when the whole site is that single service.
56+
- Write for end users: the page should describe the service and ideally offer a signup or account/token call to action. Do not link API documentation or developer portals.
5557
- Do not link general product detail or marketing pages, e.g. the manufacturer page of a charger.
58+
- Use canonical, stable URLs in the provider's default language and without tracking parameters. Verify that the URL is live.
5659
- `link` can be set at the template level (applies to all products) and overridden per product via a `link` entry under `products`.
5760

5861
**Example** (template-level link, overridden by a rebranded product):

templates/definition/tariff/awattar.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
template: awattar
2-
link: https://www.awattar.at/tariffs/hourly
32
products:
43
- brand: Awattar
54
group: price

templates/definition/tariff/energy-charts-api.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
template: energy-charts-api
2-
link: https://energy-charts.info/charts/price_spot_market/chart.htm
32
products:
43
- brand: Energy-Charts
54
description:

0 commit comments

Comments
 (0)