8000 docs: add docs on general Terraform usage by msanft · Pull Request #1263 · edgelesssys/constellation · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

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

Merged
merged 9 commits into from
Feb 28, 2023
Merged

Conversation

msanft
Copy link
Contributor
@msanft msanft commented Feb 23, 2023

Proposed change(s)

  • Our docs featured multiple references to Terraform state files, using Terraform, etc. This PR should add a general documentation page on how Terraform is being used by Constellation to manage cloud resources as stated here. This includes:
  • Instructions on interacting with Terraform state manually
  • Instructions on how and where to keep Terraform state files

Checklist

  • Add labels (e.g., for changelog category)
  • Link to Milestone

@msanft msanft added the documentation Improvements or additions to documentation label Feb 23, 2023
@msanft msanft added this to the v2.6.0 milestone Feb 23, 2023
@msanft msanft requested a review from thomasten as a code owner February 23, 2023 09:51
@msanft msanft requested a review from datosh February 23, 2023 09:52
@netlify
Copy link
netlify bot commented Feb 23, 2023

Deploy Preview for constellation-docs ready!

Name Link
🔨 Latest commit dfd2c94
🔍 Latest deploy log https://app.netlify.com/sites/constellation-docs/deploys/63fc6cfb53fbbb0007da283f
😎 Deploy Preview https://deploy-preview-1263--constellation-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@msanft
Copy link
Contributor Author
msanft commented Feb 23, 2023

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?

Copy link
Member
@thomasten thomasten left a 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.

8000
@msanft
Copy link
Contributor Author
msanft commented Feb 24, 2023

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?

@thomasten
Copy link
Member

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.

@msanft msanft requested review from thomasten and datosh February 27, 2023 08:42
@msanft msanft merged commit a2096c2 into main Feb 28, 2023
@msanft msanft deleted the feat/terraformUsageDocs branch February 28, 2023 09:36
miampf pushed a commit that referenced this pull request Mar 2, 2023
* 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
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

Successfully merging this pull request may close these issues.

3 participants
0