Skip to content
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

Documention on template function library #79

Open
eikenb opened this issue Nov 10, 2021 · 1 comment
Open

Documention on template function library #79

eikenb opened this issue Nov 10, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@eikenb
Copy link
Contributor

eikenb commented Nov 10, 2021

With the majority of template library functions moving into hashicat, it would be good if the downstream applications had decent reference documentation to refer to. Currently the template functions have basic docs, but nothing compared to the more extensive docs as they current exist in consul-template.

I'd like to hit somewhere between the verbosity of the current consul-template docs and the brief hashicat docs. I thinking the standard gdoc format with examples should work as a good starting point.

@eikenb eikenb added the documentation Improvements or additions to documentation label Nov 10, 2021
@eikenb
Copy link
Contributor Author

eikenb commented Nov 10, 2021

Also compare the current function godoc comments (in hashicat) to the consul-template basic description to look for improvements to the godoc comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant