search

GoogleCloudPlatform / marketing-analytics-jumpstart

Marketing Analytics Jumpstart consists of an easy, extensible and automated implementation of an end-to-end solution that enables Marketing Technology teams to store, transform, enrich with 1PD and analyze marketing data, and programmatically send predictive events to Google Analytics 4 to support conversion optimization and remarketing campaigns.
Apache License 2.0
128 stars 47 forks source link

Documentation and best practices feedback #189

Open pulporange opened 2 months ago

pulporange commented 2 months ago

Based on my experience deploying the solution

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.

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.

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 commented 1 month ago

@pulporange thanks for the feedback, incorporating your suggestions:

1) Checklists: https://github.com/GoogleCloudPlatform/marketing-analytics-jumpstart/blob/main/README.md#installation-pre-requisites, https://github.com/GoogleCloudPlatform/marketing-analytics-jumpstart/blob/main/README.md#installation-permissions-and-privileges, and https://github.com/GoogleCloudPlatform/marketing-analytics-jumpstart/blob/main/README.md#installation (including installation recording).

2) Recommend GCP regions: https://github.com/GoogleCloudPlatform/marketing-analytics-jumpstart/blob/main/README.md#compute-regions-and-data-locations-compatibility

3) Installation flow: Detailed installation flow, step-by-step: https://github.com/GoogleCloudPlatform/marketing-analytics-jumpstart/blob/main/infrastructure/README.md, without to mention the installation recording.

4) Production flow: From data source to activation on Google Ads - https://github.com/GoogleCloudPlatform/marketing-analytics-jumpstart/blob/main/README.md#use-cases

5) Suggestions for potential next steps (Day 2): https://github.com/GoogleCloudPlatform/marketing-analytics-jumpstart/tree/main/infrastructure/terraform#post-installation-instructions

chmstimoteo commented 1 month ago

  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.

  2. 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.