Skip to content

Commit 8d660f6

Browse files
committed
DOCS: Link to BIND and TransIP as worked metadata examples
1 parent ce890ad commit 8d660f6

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

documentation/advanced-features/writing-providers.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -163,9 +163,14 @@ The optional `PostWrite` hook on `CredsMetadata` lets the provider
163163
prepare local resources after the wizard writes `creds.json` (BIND uses
164164
this to create the zone files directory).
165165

166-
Worked examples: `providers/bind/bindProvider.go` (simple plus a
167-
`PostWrite` hook) and `providers/transip/transipProvider.go` (two auth
168-
methods expressed via `Internal` plus `ShowIf`).
166+
The BIND and TransIP registrations in this repository are worked
167+
examples maintainers can copy from:
168+
169+
- [`providers/bind/bindProvider.go`][bind-source]: the simple shape, plus a `PostWrite` hook that creates the zone files directory.
170+
- [`providers/transip/transipProvider.go`][transip-source]: an auth method selector (`Internal` plus `ShowIf`) that branches between a short lived access token and an account name paired with a PEM private key.
171+
172+
[bind-source]: https://github.com/StackExchange/dnscontrol/blob/main/providers/bind/bindProvider.go
173+
[transip-source]: https://github.com/StackExchange/dnscontrol/blob/main/providers/transip/transipProvider.go
169174

170175
Providers without registered metadata still work; users just create the
171176
`creds.json` entry from the provider's documentation page rather than

0 commit comments

Comments
 (0)