-
Notifications
You must be signed in to change notification settings - Fork 54
docs: add docs on general Terraform usage #1263
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
Conversation
✅ Deploy Preview for constellation-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
I'm not yet a 100% happy with how these turned out but I can't really figure out what I don't like neither. Maybe you (@thomasten & @datosh ) can have a look over these with the briskness of a new reader and see where room for improvement could be. On another note, when running the docs locally, the new page does not show up in the sidebar. I assume this is expected and caused by the versioned sidebars? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What I'm not yet happy with (and maybe it's the same with you) is that we do have the reference page now, but still haven't reduced the Terraform references and duplications throughout the docs (which I believe is what you actually wanted to achieve). Below are some ideas for this.
That definitely is a good point. But I was rather unsure about how the Terraform page itself is looking like. As a user (who possibly didn't work with Terraform before), do you think it's comprehensible? |
I think users should only use Terraform with Constellation if they have worked with Terraform before, so IMO the page only needs to target such users. Maybe change "basic familiarity" to "familiarity" in the info box. |
* add docs on general tf usage * reminder to not delete terraform dir * fix spelling check * add to sidebar * reference terraform page * embed link into natural language * mention iam folder * separate hack tools from official tf docs * assume familiarity with tf
Proposed change(s)
Checklist