From a9c2da5a1abda96224235fa8c65514205de2c442 Mon Sep 17 00:00:00 2001 From: ayush-billore Date: Wed, 13 Dec 2023 16:08:36 +0530 Subject: [PATCH 1/5] add docs changes for feature flag and gtm_id Signed-off-by: ayush-billore --- .../supermarket/config_rb_supermarket.md | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/docs-chef-io/content/supermarket/config_rb_supermarket.md b/docs-chef-io/content/supermarket/config_rb_supermarket.md index 15224784d7..d2ba4b446f 100644 --- a/docs-chef-io/content/supermarket/config_rb_supermarket.md +++ b/docs-chef-io/content/supermarket/config_rb_supermarket.md @@ -252,12 +252,37 @@ Use these settings to integrate Supermarket with GitHub Enterprise. ### Google Analytics -Use this setting to set up [Google Analytics](https://analytics.google.com) tracking for Supermarket: +Use this setting to set up [Google Analytics with GTag](https://analytics.google.com) tracking for Supermarket: + +`default['supermarket']['enable_gtag']` + +: The Google tag feature flag's default value: "false". Set to `"true"` to enable google tag tracking. `default['supermarket']['google_analytics_id']` : The Google Analytics [tracking ID](https://support.google.com/analytics/answer/7372977?hl=en) for Supermarket. Default value: `nil`. + +### Onetrust + +Use this setting to enable [Onetrust](www.onetrust.com) cookie consent verification for Supermarket: + +`default['supermarket']['enable_onetrust']` + +: The Onetrust consent flag's default value: "false". Set to `"true"` to enable onetrust consent verification. + +### Google Tag Manager + +Use this setting to enable [Google Tag Manager](https://tagmanager.google.com/) for Supermarket: + +`default['supermarket']['enable_gtm']` + +: The Google tag manager feature flag's default value: "false". Set to `"true"` to enable google tag manager. + +`default['supermarket']['gtm_id']` + +: The Google Tag Manager [container ID](https://support.google.com/tagmanager/answer/6103696?hl=en) for Supermarket. Default value: nil. + ### Nginx This configuration file has the following settings for nginx: From 6e10de498e0c7dafa7c04944ba554e24a35f2a38 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Wed, 13 Dec 2023 16:07:06 -0500 Subject: [PATCH 2/5] Docs edits Signed-off-by: Ian Maddaus --- .../supermarket/config_rb_supermarket.md | 33 +++++++++++++------ 1 file changed, 23 insertions(+), 10 deletions(-) diff --git a/docs-chef-io/content/supermarket/config_rb_supermarket.md b/docs-chef-io/content/supermarket/config_rb_supermarket.md index d2ba4b446f..2460b2f706 100644 --- a/docs-chef-io/content/supermarket/config_rb_supermarket.md +++ b/docs-chef-io/content/supermarket/config_rb_supermarket.md @@ -252,36 +252,49 @@ Use these settings to integrate Supermarket with GitHub Enterprise. ### Google Analytics -Use this setting to set up [Google Analytics with GTag](https://analytics.google.com) tracking for Supermarket: +Use these settings to set up [Google Analytics](https://analytics.google.com) tracking for Supermarket. `default['supermarket']['enable_gtag']` -: The Google tag feature flag's default value: "false". Set to `"true"` to enable google tag tracking. +: Whether to enable Google Analytics tracking. -`default['supermarket']['google_analytics_id']` + Allowed values: `true`, `false`. + + Default value: `false`. -: The Google Analytics [tracking ID](https://support.google.com/analytics/answer/7372977?hl=en) for Supermarket. Default value: `nil`. +`default['supermarket']['google_analytics_id']` +: The Google Analytics [tracking ID](https://support.google.com/analytics/answer/7372977?hl=en) for Supermarket. -### Onetrust + Default value: `nil`. -Use this setting to enable [Onetrust](www.onetrust.com) cookie consent verification for Supermarket: +### OneTrust `default['supermarket']['enable_onetrust']` -: The Onetrust consent flag's default value: "false". Set to `"true"` to enable onetrust consent verification. +: Whether to enable [OneTrust](https://www.onetrust.com) cookie consent verification for Supermarket. + + Allowed values: `true`, `false`. + + Default value: `false`. ### Google Tag Manager -Use this setting to enable [Google Tag Manager](https://tagmanager.google.com/) for Supermarket: +Use these settings to set up [Google Tag Manager](https://tagmanager.google.com/) for Supermarket: `default['supermarket']['enable_gtm']` -: The Google tag manager feature flag's default value: "false". Set to `"true"` to enable google tag manager. +: Whether to enable google tag manager. + + Allowed values: `true`, `false`. + + Default value: `false`. `default['supermarket']['gtm_id']` -: The Google Tag Manager [container ID](https://support.google.com/tagmanager/answer/6103696?hl=en) for Supermarket. Default value: nil. +: The Google Tag Manager [container ID](https://support.google.com/tagmanager/answer/6103696?hl=en) for Supermarket. + + Default value: `nil`. ### Nginx From 7b9f064962533f7c855342ab6177f3f33706f918 Mon Sep 17 00:00:00 2001 From: ayush-billore Date: Thu, 14 Dec 2023 19:02:29 +0530 Subject: [PATCH 3/5] change values from boolean to string as the implementation expects the values in string format Signed-off-by: ayush-billore --- .../content/supermarket/config_rb_supermarket.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs-chef-io/content/supermarket/config_rb_supermarket.md b/docs-chef-io/content/supermarket/config_rb_supermarket.md index 2460b2f706..7d350998c0 100644 --- a/docs-chef-io/content/supermarket/config_rb_supermarket.md +++ b/docs-chef-io/content/supermarket/config_rb_supermarket.md @@ -258,9 +258,9 @@ Use these settings to set up [Google Analytics](https://analytics.google.com) tr : Whether to enable Google Analytics tracking. - Allowed values: `true`, `false`. + Allowed values: `"true"`, `"false"`. - Default value: `false`. + Default value: `"false"`. `default['supermarket']['google_analytics_id']` @@ -274,9 +274,9 @@ Use these settings to set up [Google Analytics](https://analytics.google.com) tr : Whether to enable [OneTrust](https://www.onetrust.com) cookie consent verification for Supermarket. - Allowed values: `true`, `false`. + Allowed values: `"true"`, `"false"`. - Default value: `false`. + Default value: `"false"`. ### Google Tag Manager @@ -286,9 +286,9 @@ Use these settings to set up [Google Tag Manager](https://tagmanager.google.com/ : Whether to enable google tag manager. - Allowed values: `true`, `false`. + Allowed values: `"true"`, `"false"`. - Default value: `false`. + Default value: `"false"`. `default['supermarket']['gtm_id']` From be452de999cc7b769075798b2e18d7281f415621 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Thu, 14 Dec 2023 10:12:01 -0500 Subject: [PATCH 4/5] Update Google ID link Signed-off-by: Ian Maddaus --- docs-chef-io/content/supermarket/config_rb_supermarket.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-chef-io/content/supermarket/config_rb_supermarket.md b/docs-chef-io/content/supermarket/config_rb_supermarket.md index 7d350998c0..7aab10f6e5 100644 --- a/docs-chef-io/content/supermarket/config_rb_supermarket.md +++ b/docs-chef-io/content/supermarket/config_rb_supermarket.md @@ -264,7 +264,7 @@ Use these settings to set up [Google Analytics](https://analytics.google.com) tr `default['supermarket']['google_analytics_id']` -: The Google Analytics [tracking ID](https://support.google.com/analytics/answer/7372977?hl=en) for Supermarket. +: The Google Analytics [tracking ID](https://support.google.com/analytics/answer/9539598?hl=en) for Supermarket. Default value: `nil`. From e873865f26d94027231f390db93c47ee97830ba2 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Thu, 14 Dec 2023 15:29:17 -0500 Subject: [PATCH 5/5] Capitalization Signed-off-by: Ian Maddaus --- docs-chef-io/content/supermarket/config_rb_supermarket.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs-chef-io/content/supermarket/config_rb_supermarket.md b/docs-chef-io/content/supermarket/config_rb_supermarket.md index 7aab10f6e5..51607b9476 100644 --- a/docs-chef-io/content/supermarket/config_rb_supermarket.md +++ b/docs-chef-io/content/supermarket/config_rb_supermarket.md @@ -284,7 +284,7 @@ Use these settings to set up [Google Tag Manager](https://tagmanager.google.com/ `default['supermarket']['enable_gtm']` -: Whether to enable google tag manager. +: Whether to enable Google Tag Manager. Allowed values: `"true"`, `"false"`. @@ -292,7 +292,7 @@ Use these settings to set up [Google Tag Manager](https://tagmanager.google.com/ `default['supermarket']['gtm_id']` -: The Google Tag Manager [container ID](https://support.google.com/tagmanager/answer/6103696?hl=en) for Supermarket. +: The Google Tag Manager [container ID](https://support.google.com/tagmanager/answer/6103696?hl=en) for Supermarket. Default value: `nil`.