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.

Sign up for GitHub

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

Jump to bottom

documentation: add examples / getting started #127

Open
tormath1 opened this issue Jul 13, 2020 · 1 comment
Open

documentation: add examples / getting started #127

tormath1 opened this issue Jul 13, 2020 · 1 comment
Labels
Type: Docs Documentation of any type (source, architecture, etc.) Type: Enhancement Provide a new feature or improve an existing one

Comments

@tormath1
Copy link
Contributor

tormath1 commented Jul 13, 2020 •
edited by talset
Loading

Abstract

the user should be able to gauge the usage of TC for its own need by reading the documentation

Proposal

Some feedback about Terracognita is the lack of examples / how-to / getting started. We should have a way to display use-case / examples. A wiki could be a good place in order to not have a huge README

Implementation

  • simple run with aws
  • simple run with azurerm
  • simple run with google
  • run with aws include filter
  • include + exclude
  • tags filter
  • import by target
  • ...

Open issues (if applicable)

N/A
@tormath1 tormath1 added Type: Docs Documentation of any type (source, architecture, etc.) Type: Enhancement Provide a new feature or improve an existing one labels Jul 13, 2020
@dannous
Copy link

dannous commented Aug 29, 2022

this would be ideal, the existing readme lacks context, definitely need more examples!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Docs Documentation of any type (source, architecture, etc.) Type: Enhancement Provide a new feature or improve an existing one
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tormath1 @dannous