search

StackExchange / dnscontrol

Infrastructure as code for DNS!
https://dnscontrol.org/
MIT License
3.13k stars 399 forks source link

DOCS: Change documentation directory structure to match output #2912

Closed cafferata closed 6 months ago

cafferata commented 6 months ago

Looking good so far!

One more simplification:

  1. Rename the provider subdirectory to service-provider-specific.

Are you open to breaking old URLs? I am. Here are some simplifications that would break old URLs, but would simplify functionTypes.go:

  1. Don't downcase function names. https://docs.dnscontrol.org/language-reference/domain-modifiers/aaaa would be https://docs.dnscontrol.org/language-reference/domain-modifiers/AAAA
  2. Don't modify provider names. Why should a user of CLOUDFLAREAPI need to know the URL comtains cloudflare-dns instead? https://docs.dnscontrol.org/service-providers/providers/cloudflare-dns would be https://docs.dnscontrol.org/service-providers/providers/CLOUDFLAREAPI (This also eliminates the need for the providerNames variable.

Originally posted by @tlimoncelli in https://github.com/StackExchange/dnscontrol/issues/2905#issuecomment-2041453176

cafferata commented 6 months ago

@tlimoncelli I was about to start preparing for this work and then I wondered. What is the added value of the URL prefix 'service providers'?

Would it make more sense to shorten/simplify the URLs?

-https://docs.dnscontrol.org/service-providers/providers/akamaiedgedns
+https://docs.dnscontrol.org/providers/akamaiedgedns
-https://docs.dnscontrol.org/service-providers/providers/transip
+https://docs.dnscontrol.org/provider/transip

What do you think? 🙏🏻

tlimoncelli commented 6 months ago

Excellent point! Shorten/simplify is a better! (or we might say... it is shorter and simpler!)