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

📝 Updated Getting Started / Concepts #4

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

lucaspr2
Copy link

@lucaspr2 lucaspr2 commented Mar 3, 2025

  • Added a more detailed explanation to all topics
  • Revised locking section and added link to more info on topic
  • Documented Auto-Plan/Apply toggle mechanics with default behaviors
  • Enhanced tag examples with concrete workflow demonstration

@lucaspr2 lucaspr2 self-assigned this Mar 3, 2025
@lucaspr2 lucaspr2 added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 3, 2025

:::note
Default settings work for most teams. Customize only if you need specific lock timing or policies.
:::
## Tags and Tag Sets
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tags and tag queries are introduced a little late. Moving them higher in the document, preferably before locks, would be a good idea.


Terrateam offers two automated operations:
## Auto-Plan and Auto-Apply
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto-Plan and Auto-Apply could benefit from a brief summary. Please add a one-line description before the configuration example for clarity.


Tags provide a flexible way to organize and manage your Terraform resources within Terrateam.
Tags enable precise resource management across complex infrastructures.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Tags enable precise resource management across complex infrastructures.
Tags facilitate effective resource management in complex environments infrastructures.

@@ -29,34 +34,72 @@ Repository
|-- Directory 2
|-- Workspace: default
```

:::note
Terrateam executes operations like plan and apply within the context of a Dirspace.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Terrateam executes" appears three times in the text. You could mention it once, then reference it in the later sections.

lucaspr2 and others added 4 commits March 10, 2025 14:48
Co-authored-by: Damian Furfuro <85168963+Arcapas@users.noreply.github.com>
Co-authored-by: Damian Furfuro <85168963+Arcapas@users.noreply.github.com>
Co-authored-by: Damian Furfuro <85168963+Arcapas@users.noreply.github.com>
@lucaspr2 lucaspr2 requested a review from htessaro March 10, 2025 18:00
@lucaspr2 lucaspr2 assigned htessaro and unassigned Arcapas Mar 10, 2025
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants