Open tlimoncelli opened 1 month ago
I am in favor of the proposed solution. π I am happy to help with redesigning the documentation generator. π€
I am in favor of the proposed solution. π I am happy to help with redesigning the documentation generator. π€
yes, please!
CC @cafferata
Problem statement:
Proposed solution:
Ideally everything related to a particular rtypes would be isolated to a single directory that includes code, documentation, tests, etc. exclusively for that rtype.
I don't think we can get there in one step, but I think we can improve the current situation.
Proposal:
$git/rtypes/NAME/
or$git/providers/PROVIDERNAME/rtypes/NAME/
whereNAME
is the rtype name.$git/rtypes/NAME/documentation/
or$git/providers/PROVIDERNAME/rtypes/NAME/documentation/
. The documentation system should find it there automagicallly.Implementation:
I'm using https://github.com/StackExchange/dnscontrol/pull/3035 (CF_SINGLE_REDIRECT) as an opportunity to improve some of these issues.
var CF_SINGLE_REDIRECT = rawrecordBuilder('CF_SINGLE_REDIRECT');
CF_SINGLE_REDIRECT
is in$git/providers/cloudflare/rtypes/cfsingleredirect/
No change to where documentation is (that's going to require changes to the go generate code) nor other changes. However this is a start.