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

Documentation and best practices feedback #189

Open
pulporange opened this issue Aug 30, 2024 · 2 comments
Open

Documentation and best practices feedback #189

pulporange opened this issue Aug 30, 2024 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@pulporange
Copy link

Based on my experience deploying the solution

  • Lack of Comprehensive Checklist and Diagrams:

Need:
A centralized checklist or diagram outlining the pre-requisites for setting up the project.
-> Don't forget to recommend GCP regions that has been tested out
A clear installation flow, guiding users through the steps involved.
A visual representation of the production flow, highlighting the data pipeline and key components.
Suggestions for potential next steps (Day 2), helping users explore further functionalities and use cases.

  • Emphasis on Terraform Variable main role:

Need:
Clearly highlight that the Terraform variable can be edited in case of typos or modifications.
Consider incorporating this Terraform variable within the checklist to ensure users have all necessary configurations before starting the wizard in the GCP Console.

  • Explanation of Best Practices for Separate BQ Export Project:

Need:
Provide a clear explanation of the best practices for using a separate project for BigQuery (BQ) export.
Highlight the benefits of this approach, such as:
Improved organization and resource management.
Enhanced data security and access control.
Streamlined cost tracking and optimization.

@chmstimoteo chmstimoteo self-assigned this Oct 7, 2024
@chmstimoteo
Copy link
Collaborator

chmstimoteo commented Oct 10, 2024

  1. Clearly highlight that the Terraform variable can be edited in case of typos or modifications.

Stated clearly in the documentation, the user can change the variables at any time.

  1. Consider incorporating this Terraform variable within the checklist to ensure users have all necessary configurations before starting the wizard in the GCP Console.

Made sure, the user runs terraform validate before apply to inspect if all configurations are valid.

@chmstimoteo chmstimoteo added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 26, 2024
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

No branches or pull requests

2 participants