-
Notifications
You must be signed in to change notification settings - Fork 0
Implement smarter validation for docfx.json #24
Copy link
Copy link
Open
Labels
area/prefectIssues concerning the Prefect tool itselfIssues concerning the Prefect tool itselfarea/reference-bonsaiIssues concerning the Bonsai Foundation reference templateIssues concerning the Bonsai Foundation reference templateaspect/documentationIssues concerning aspects of documentation websites in reference templatesIssues concerning aspects of documentation websites in reference templatesconcept/flexibilityIssues concerning flexibility and configurability of the reference templatesIssues concerning flexibility and configurability of the reference templates
Description
Metadata
Metadata
Assignees
Labels
area/prefectIssues concerning the Prefect tool itselfIssues concerning the Prefect tool itselfarea/reference-bonsaiIssues concerning the Bonsai Foundation reference templateIssues concerning the Bonsai Foundation reference templateaspect/documentationIssues concerning aspects of documentation websites in reference templatesIssues concerning aspects of documentation websites in reference templatesconcept/flexibilityIssues concerning flexibility and configurability of the reference templatesIssues concerning flexibility and configurability of the reference templates
DocfxConfigurationRuleexists, but is currently disabled. (Meaning the contents ofdocfx.jsonare checked very strictly.)It is a left-over from an earlier approach where I planned to spot check various aspects of
docfx.jsonand still allow the massive amount of divergence we had before. In the end I buckled down and redid ourdocfx.jsontemplate entirely.I think a better approach with this new template would be to compare the JSON documents directly and only allowing a select number of properties to diverge. (Basically a handful of the
globalMetadatasub-properties.)(I do think the rule should still be pretty strict though, it's just too easy to shoot yourself in the foot in subtle ways with docfx.)