Proposal: I'd like to add a "How to Write Good Templates" guide to the docs

[paradisfm]

Hey!

I’ve been using Gomplate for a bit—my use case in particular is porting our Helm values generation away from Consul—and I think it would be really helpful to have a section in the docs about how to write good templates. Not just the syntax and usage, but things like patterns, structure, and general best practices.

I’d like to take a stab at writing this myself, covering topics more or less like:

• Naming conventions & organizing templates
• Making templates reusable and readable
• Common pitfalls
• Maybe a couple examples of "good" templates (minus, of course, any proprietary info)

Would you be open to a PR for this? Happy to get feedback or iterate on it with the maintainers.

Thanks!

[hairyhenderson]

Hi @paradisfm - that sounds like a fine idea. Go ahead and open a PR for it and I'll review when I get the chance!

[paradisfm]

hey! pr has been opened - ready for review, no rush. thanks :D

[github-actions]

This issue is stale because it has been open for 60 days with no
activity. If it is no longer relevant or necessary, please close it.
Given no action, it will be closed in 14 days.

If it's still relevant, one of the following will remove the stale
marking:

• A maintainer can add this issue to a milestone to indicate that
  it's been accepted and will be worked on
• A maintainer can remove the stale label
• Anyone can post an update or other comment

[paradisfm]

meow

[hairyhenderson]

@paradisfm looks like the PR got closed due to inaction, and this issue too - if you want to try again you should be able to reopen them..

[paradisfm]

@hairyhenderson hey, any chance you can un-stale the pr and approve it? it looks like my attempts to do so did not work. i am in the process of updating my resume so i would like to claim this contribution :)

[github-actions]

This issue is stale because it has been open for 60 days with no
activity. If it is no longer relevant or necessary, please close it.
Given no action, it will be closed in 14 days.

If it's still relevant, one of the following will remove the stale
marking:

• A maintainer can add this issue to a milestone to indicate that
  it's been accepted and will be worked on
• A maintainer can remove the stale label
• Anyone can post an update or other comment