search

GoogleCloudPlatform / policy-library

A library of constraint templates and sample constraints for Constraint Framework tools
Apache License 2.0
223 stars 129 forks source link

Add autogenerated documentation #321

Closed morgante closed 4 years ago

morgante commented 4 years ago

This adds a kpt function which automatically generates documentation for constraint templates, policy bundles, and sample constraints.

Since kpt requires a number of generated files, review should focus on generate_docs.ts and the docs themselves.

morgante commented 4 years ago

@briantkennedy @AdrienWalkowiak PTAL

morgante commented 4 years ago

Looks good, but we should file a feature request with kpt to add a // GENERATED CODE DO NOT EDIT to each of the gen files.

FR filed: https://github.com/GoogleContainerTools/kpt-functions-sdk/issues/131