terraform-plugin-docs icon indicating copy to clipboard operation
terraform-plugin-docs copied to clipboard

the docs/guides subfolder is deleted when I run go generate

Open remyleone opened this issue 4 years ago • 2 comments

I've setup a docs/guides folder containing human written content. When I run the go generate command, the guides subfolder is deleted.

remyleone avatar Jan 13 '21 17:01 remyleone

The tool assumes it "owns" the docs directory tree, if you have static content you want to copy over, put it in the templates/guides directory and I believe it will just be copied over as-is.

paultyng avatar Jan 26 '21 19:01 paultyng

I wondered about this as well. i have verified that templates/guides/* does indeed get copied to the docs/ folder, but this was not clearly explained in the README.md of this repo, at least for me (and probaly remy).

It would be nice if this was more explicitly called out in the README I think since at least two people have been puzzled by this.

It would be nice if the guides folder was auto-indexed, but I guess we can manually add links to Guides somewhere in our templates/index.md.tmpl?

I need guides to provide more than one example for a resource (basic, versus highly advanced) without combining them into one resource.tf file Perhaps I'm actually interested in #6 ??

brettjacobson avatar Feb 24 '21 18:02 brettjacobson