https://cloudposse.com logo
Join Slack
Powered by
Anyone doing anything cool with atmos docs?
# atmos
z
Anyone doing anything cool with atmos docs?
Thinking about creating READMEs for displaying DAG using pre-commit hooks off the top of my head
a
would be very useful, thanks
also, atmos.tools/examples you can add it to the examples
z
🤔 nah that's not what I meant. I thought atmos had the ability to generate READMEs in my codebase somewhere
atmos docs generate
m
what kind of readmes? terraform-docs?
If so, you can use github.com/antonbabenko/pre-commit-terraform#… till atmos will add hook for 
terraform-docs
as well Or even after it, as it provide more stuff than basic terraform-docs can do
z
You can do all kinds of generic templating with atmos
e
Atmos supports native 
atmos docs generate
which under the hood supports a mashup of 
gomplate
and 
terraform-docs
(as go modules), so no separate binaries
Using 
atmos docs generate
can do everything you can do with 
terraform-docs
plus the templating power of 
gomplate
and all the atmos functions.
Have not explored how to display a DAG with it, but the use-case makes sense.
On https://github.com/cloudposse/* all of our READMEs are generated using atmos docs
The other benefit is you can centrally define a template for your organization, then generate docs consistently for every project/repo
Here, you can see we import an atmos config from our centralized repo
And that is our docs configuration
3 Views
Open in Slack
PreviousNext
Powered by