From 28055dc6f7105145f7dafde6120466deb7386948 Mon Sep 17 00:00:00 2001 From: Tom Limoncelli Date: Wed, 15 Mar 2023 12:12:51 -0400 Subject: [PATCH] DOCS: Clarify/fix official and community support (#2172) --- build/generate/featureMatrix.go | 9 +++++---- documentation/writing-providers.md | 1 + providers/luadns/luadnsProvider.go | 2 +- providers/namedotcom/namedotcomProvider.go | 2 +- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/build/generate/featureMatrix.go b/build/generate/featureMatrix.go index 28b68040a..bce608c8b 100644 --- a/build/generate/featureMatrix.go +++ b/build/generate/featureMatrix.go @@ -1,12 +1,13 @@ package main import ( - "github.com/StackExchange/dnscontrol/v3/providers" - _ "github.com/StackExchange/dnscontrol/v3/providers/_all" - "github.com/fbiville/markdown-table-formatter/pkg/markdown" "os" "sort" "strings" + + "github.com/StackExchange/dnscontrol/v3/providers" + _ "github.com/StackExchange/dnscontrol/v3/providers/_all" + "github.com/fbiville/markdown-table-formatter/pkg/markdown" ) func generateFeatureMatrix() error { @@ -72,7 +73,7 @@ func featureEmoji( func matrixData() *FeatureMatrix { const ( - OfficialSupport = "Official Support" + OfficialSupport = "Official Support" // vs. community supported ProviderDNSProvider = "DNS Provider" ProviderRegistrar = "Registrar" DomainModifierAlias = "ALIAS" diff --git a/documentation/writing-providers.md b/documentation/writing-providers.md index 238d9de6e..5291f56fa 100644 --- a/documentation/writing-providers.md +++ b/documentation/writing-providers.md @@ -291,6 +291,7 @@ Here are some last-minute things to check before you submit your PR. 2. Make sure all appropriate documentation is current. (See [Step 8](#step-8-manual-tests)) 3. Check that dependencies are current (See [Step 13](#step-13-dependencies)) 4. Re-run the integration test one last time (See [Step 7](#step-7-integration-test)) +5. Re-read the [maintainer's responsibilities](providers.md) bullet list. By submitting a provider you agree to maintain it, respond to bugs, perioidically re-run the integration test to verify nothing has broken, and if we don't hear from you for 2 months we may disable the provider. ## Step 15: After the PR is merged diff --git a/providers/luadns/luadnsProvider.go b/providers/luadns/luadnsProvider.go index 7988835a4..bb22e33ee 100644 --- a/providers/luadns/luadnsProvider.go +++ b/providers/luadns/luadnsProvider.go @@ -29,7 +29,7 @@ var features = providers.DocumentationNotes{ providers.CanUseTLSA: providers.Can(), providers.DocCreateDomains: providers.Can(), providers.DocDualHost: providers.Can(), - providers.DocOfficiallySupported: providers.Can(), + providers.DocOfficiallySupported: providers.Cannot(), } func init() { diff --git a/providers/namedotcom/namedotcomProvider.go b/providers/namedotcom/namedotcomProvider.go index e395929ee..e73ed0c04 100644 --- a/providers/namedotcom/namedotcomProvider.go +++ b/providers/namedotcom/namedotcomProvider.go @@ -27,7 +27,7 @@ var features = providers.DocumentationNotes{ providers.CanUseSRV: providers.Can("SRV records with empty targets are not supported"), providers.DocCreateDomains: providers.Cannot("New domains require registration"), providers.DocDualHost: providers.Can(), - providers.DocOfficiallySupported: providers.Can(), + providers.DocOfficiallySupported: providers.Cannot(), } func newReg(conf map[string]string) (providers.Registrar, error) {