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

Clarify early on the different types of drifts #72

Open
sjourdan opened this issue Jun 15, 2021 · 2 comments
Open

Clarify early on the different types of drifts #72

sjourdan opened this issue Jun 15, 2021 · 2 comments

Comments

@sjourdan
Copy link
Contributor

As reported on Discord by the user "ptaag": the different types of drifts that are returned by the driftctl CLI aren't easily explained on the docs: what is a missing resource? what is an unmanaged resource? etc.

We should clarify that as early as page 1 of the docs site so as to let users know immediately what they will get from the tool!

@sjourdan sjourdan added kind/documentation Improvements or additions to documentation priority/1 p1 and removed kind/documentation Improvements or additions to documentation labels Jun 24, 2021
@sjourdan
Copy link
Contributor Author

sjourdan commented Jul 7, 2021

Let's add a new block on the first "welcome" documentation page, like an overview, so users know ASAP what they will get from the product.

Draft TBD

Here's a typical driftctl output to insert in 1st-page doc:

Found 79 resource(s)
 - 8% coverage
 - 7 resource(s) managed by Terraform
     - 1/7 resource(s) out of sync with Terraform state
 - 72 resource(s) not managed by Terraform
 - 0 resource(s) found in a Terraform state but missing on the cloud provider

@sjourdan
Copy link
Contributor Author

sjourdan commented Jul 7, 2021

@GeraldCrescione WDYT about syncing www content and documentation 1st-page to make it a coherent welcome page?

maybe also adapt the youtube link (old FOSDEM vid??) etc.

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

No branches or pull requests

2 participants