-
Notifications
You must be signed in to change notification settings - Fork 118
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: Generate CloudFormation and Terraform docs files via AVD docs generator #878
feat: Generate CloudFormation and Terraform docs files via AVD docs generator #878
Conversation
To be clear, this is not yet working properly. Just wanted to push this up for comments. Once it's working correctly, I'll regenerate all the files and include in this PR (unless that should be done as a separate PR after this change lands). |
Hey @reedloden - I didn't want to push directly to your branch so here is the result of some fiddling... thanks for doing this, needed doing Terraform Template var terraformMarkdownTemplate = `
{{ .Resolution }}
{{ if .Terraform.GoodExamples }}{{ range .Terraform.GoodExamples }}` + "```hcl" + `{{ . }}
` + "```" + `
{{ end}}{{ end }}
{{ if .Terraform.Links }}#### Remediation Links{{ range .Terraform.Links }}
- {{ . }}
{{ end}}{{ end }}
` CloudFormation Template var cloudformationMarkdownTemplate = `
{{ .Resolution }}
{{ if .CloudFormation.GoodExamples }}{{ range .CloudFormation.GoodExamples }}` + "```yaml" + `{{ . }}
` + "```" + `
{{ end}}{{ end }}
{{ if .CloudFormation.Links }}#### Remediation Links{{ range .CloudFormation.Links }}
- {{ . }}
{{ end}}{{ end }}
` |
dea5d39
to
31a27d8
Compare
@owenrumney Thanks! I had to make a slight tweak to the CloudFormation template, as the |
I do see some cases where the existing docs may have been slightly better. I'm a bit time-constrained right now to go through each one, but feel free to make any necessary changes and push to my branch. |
…enerator Rather than rely on manual creation of `CloudFormation.md` and `Terraform.md`, generate them the same way as `docs.md` via the `avd_generator` program.
Signed-off-by: Owen Rumney <[email protected]>
Hey @reedloden - I've been away on hols, I'll look at this today and just push it. Thanks for the efforts |
9fb65d9
to
378209f
Compare
Rather than rely on manual creation of
CloudFormation.md
andTerraform.md
, generate them the same way asdocs.md
via theavd_generator
program.