DOC-4329: Ketch footer and Segment updates #179

eric-schneider · 2025-01-09T19:08:16Z

This PR is meant to update the footer with a "Do Not Sell My Info" link to the Ketch preference management interface hosted on www.datastax.com/preferences (not yet launched).

TO DO: Update Segment track calls with new consent categories.

mlr · 2025-01-09T19:09:00Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-09T19:10:25Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

colegoldsmith

Looks good!

mlr · 2025-01-09T22:38:19Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-09T22:39:41Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

mlr · 2025-01-09T22:40:23Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-09T22:43:47Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

mlr · 2025-01-09T23:23:17Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-09T23:24:48Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

mlr · 2025-01-09T23:26:29Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-09T23:28:22Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

EladioGaldamez · 2025-01-10T18:32:07Z

src/js/05-feedback-dialog.js

@@ -43,6 +43,16 @@
    if (message && window.analytics) {
      window.analytics.track('Feedback Form', {
        message,
+        consent: {
+          categoryPreferences: {


I noticed in the segment docs this consent object uses boolean values instead of strings. I think This values should be based on the ketch preferences

Thanks @EladioGaldamez! I copied some of your PR and created a global scope track event that includes the correct consent context gathered from what the user selects in the Ketch popup

src/partials/head-prelude.hbs

…ment if the user consents to analytics

mlr · 2025-01-16T16:32:08Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-16T16:33:37Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

EladioGaldamez

LGTM!

Just a heads up, we don't see the consent preferences in the Segment context. I'm checking if this is the correct way to send them (Based on the docs, yes but we need to review this)

mlr · 2025-01-16T17:20:40Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-16T17:22:14Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

plpesvc-ds · 2025-01-16T17:47:08Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

EladioGaldamez · 2025-01-16T18:39:07Z

src/partials/head-scripts.hbs

+    saveConsent(consent);
+    // Only load Segment analytics if the user has consented to analytics
+    if (consent?.purposes?.analytics && window.analytics) {
+      window.analytics.load("{{../site.keys.segment}}");


can we also add the following script:

window.analytics.addSourceMiddleware(({ payload, next }) => { if (window.ketchConsent) { payload.obj.context.consent = { categoryPreferences: window.ketchConsent?.purposes, }; } next(payload); });

This will enable the context on all the events and not only track events.

Oh nice! Will do

mlr · 2025-01-16T21:30:39Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-16T21:32:13Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

mlr · 2025-01-16T22:06:09Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-16T22:07:30Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

mlr · 2025-01-17T20:59:33Z

UI bundle preview build failure! ❌

[20:59:29] Using gulpfile ~/work/docs-ui/docs-ui/gulpfile.js [20:59:29] Starting 'preview:build'... [20:59:29] Starting 'build'... Browserslist: caniuse-lite is outdated. Please run: npx update-browserslist-db@latest Why you should do it regularly: https://github.com/browserslist/update-db#readme [20:59:32] Finished 'build' after 2.67 s [20:59:32] Starting 'preview:build-pages'... [20:59:32] Finished 'preview:build-pages' after 100 ms [20:59:32] Finished 'preview:build' after 2.77 s node:events:497 throw er; // Unhandled 'error' event ^ <ref *1> Error: #with requires exactly one argument in UI template src/partials/head-scripts.hbs at Object. (/home/runner/work/docs-ui/docs-ui/node_modules/handlebars/dist/cjs/handlebars/helpers/with.js:17:13) at Object.wrapper (/home/runner/work/docs-ui/docs-ui/node_modules/handlebars/dist/cjs/handlebars/internal/wrapHelper.js:15:19) at Object.eval [as main] (eval at createFunctionContext (/home/runner/work/docs-ui/docs-ui/node_modules/handlebars/dist/cjs/handlebars/compiler/javascript-compiler.js:262:23), :12:49) at main (/home/runner/work/docs-ui/docs-ui/node_modules/handlebars/dist/cjs/handlebars/runtime.js:208:32) at Object.ret (/home/runner/work/docs-ui/docs-ui/node_modules/handlebars/dist/cjs/handlebars/runtime.js:212:12) at Object.ret [as head-scripts] (/home/runner/work/docs-ui/docs-ui/node_modules/handlebars/dist/cjs/handlebars/compiler/compiler.js:519:21) at Object.invokePartialWrapper [as invokePartial] (/home/runner/work/docs-ui/docs-ui/node_modules/handlebars/dist/cjs/handlebars/runtime.js:88:46) at Object.eval [as main] (eval at createFunctionContext (/home/runner/work/docs-ui/docs-ui/node_modules/handlebars/dist/cjs/handlebars/compiler/javascript-compiler.js:262:23), :18:28) at main (/home/runner/work/docs-ui/docs-ui/node_modules/handlebars/dist/cjs/handlebars/runtime.js:208:32) at Object.ret (/home/runner/work/docs-ui/docs-ui/node_modules/handlebars/dist/cjs/handlebars/runtime.js:212:12) Emitted 'error' event on Domain instance at: at Transform.emit (node:domain:539:12) at Transform.onerror (/home/runner/work/docs-ui/docs-ui/node_modules/readable-stream/lib/_stream_readable.js:640:52) at Transform.emit (node:events:519:28) at Transform.emit (node:domain:488:12) at emitErrorNT (node:internal/streams/destroy:169:8) at emitErrorCloseNT (node:internal/streams/destroy:128:3) at process.processTicksAndRejections (node:internal/process/task_queues:82:21) { domainEmitter: Transform { _events: { close: undefined, error: undefined, prefinish: [Function: prefinish], finish: undefined, drain: undefined, data: [Function: ondata], end: [Function: bound onceWrapper] { listener: [Function: onend] }, readable: undefined, unpipe: undefined }, _readableState: ReadableState { highWaterMark: 16, buffer: [], bufferIndex: 0, length: 0, pipes: [ Pumpify { _readableState: ReadableState { objectMode: true, highWaterMark: 16, buffer: [BufferList], length: 0, pipes: [Transform], pipesCount: 1, flowing: true, ended: false, endEmitted: false, reading: true, sync: false, needReadable: true, emittedReadable: false, readableListening: false, resumeScheduled: false, destroyed: false, defaultEncoding: 'utf8', awaitDrain: 0, readingMore: false, decoder: null, encoding: null }, readable: true, _events: [Object: null prototype] { end: [Array], close: [Array], prefinish: [Function (anonymous)], newListener: [Function: removeSink], removeListener: [Array], unpipe: [Function: onunpipe], error: [Array], finish: [Function], data: [Function: ondata] }, _eventsCount: 9, _maxListeners: undefined, _writableState: WritableState { objectMode: true, highWaterMark: 16, finalCalled: false, needDrain: false, ending: false, ended: false, finished: false, destroyed: false, decodeStrings: true, defaultEncoding: 'utf8', length: 0, writing: false, corked: 0, sync: true, bufferProcessing: false, onwrite: [Function (anonymous)], writecb: null, writelen: 0, bufferedRequest: null, lastBufferedRequest: null, pendingcb: 0, prefinished: false, errorEmitted: false, bufferedRequestCount: 0, corkedRequestsFree: [CorkedRequest] }, writable: true, allowHalfOpen: true, _writable: DestroyableTransform { _readableState: [ReadableState], readable: true, _events: [Object: null prototype], _eventsCount: 7, _maxListeners: undefined, _writableState: [WritableState], writable: true, allowHalfOpen: true, _transformState: [Object], _destroyed: false, _transform: [Function: normalize], [Symbol(shapeMode)]: true, [Symbol(kCapture)]: false }, _readable: DestroyableTransform { _readableState: [ReadableState], readable: true, _events: [Object: null prototype], _eventsCount: 8, _maxListeners: undefined, _writableState: [WritableState], writable: true, allowHalfOpen: true, _transformState: [Object], _destroyed: false, _transform: [Function: writeFile], [Symbol(shapeMode)]: true, [Symbol(kCapture)]: false }, _readable2: DestroyableTransform { _readableState: [ReadableState], readable: true, _events: [Object: null prototype], _eventsCount: 8, _maxListeners: undefined, _writableState: [WritableState], writable: true, allowHalfOpen: true, _transformState: [Object], _destroyed: false, _transform: [Function: writeFile], [Symbol(shapeMode)]: true, [Symbol(kCapture)]: false }, _autoDestroy: false, _forwardDestroy: false, _forwardEnd: true, _corked: 0, _ondrain: null, _drained: true, _forwarding: false, _unwrite: [Function: clear], _unread: [Function: clear], _ended: false, [Symbol(shapeMode)]: true, [Symbol(kCapture)]: false } ], awaitDrainWriters: null, [Symbol(kState)]: 193997247, [Symbol(kErroredValue)]: [Circular *1] }, _writableState: WritableState { highWaterMark: 16, length: 0, corked: 0, onwrite: [Function: bound onwrite], writelen: 0, bufferedIndex: 0, pendingcb: 0, [Symbol(kState)]: 17580479, [Symbol(kBufferedValue)]: null, [Symbol(kErroredValue)]: [Circular *1] }, allowHalfOpen: true, _maxListeners: undefined, _transform: [Function (anonymous)], _eventsCount: 3, [Symbol(shapeMode)]: true, [Symbol(kCapture)]: false, [Symbol(kCallback)]: null }, domainThrown: false } Node.js v21.6.1

plpesvc-ds · 2025-01-17T21:00:53Z

Build failure! ❌

{"level":"fatal","time":1737147653159,"name":"antora","err":{"type":"Error","stack":"Error\n at Object. (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/handlebars/dist/cjs/handlebars/helpers/with.js:17:13)\n at Object.wrapper (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/handlebars/dist/cjs/handlebars/internal/wrapHelper.js:15:19)\n at Object.eval [as main] (eval at createFunctionContext (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/handlebars/dist/cjs/handlebars/compiler/javascript-compiler.js:262:23), :12:49)\n at main (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/handlebars/dist/cjs/handlebars/runtime.js:208:32)\n at Object.ret (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/handlebars/dist/cjs/handlebars/runtime.js:212:12)\n at Object.ret [as head-scripts] (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/handlebars/dist/cjs/handlebars/compiler/compiler.js:519:21)\n at Object.invokePartialWrapper [as invokePartial] (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/handlebars/dist/cjs/handlebars/runtime.js:88:46)\n at Object.eval [as main] (eval at createFunctionContext (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/handlebars/dist/cjs/handlebars/compiler/javascript-compiler.js:262:23), :18:28)\n at main (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/handlebars/dist/cjs/handlebars/runtime.js:208:32)\n at Object.ret (/home/runner/work/datastax-docs-site/datastax-docs-site/node_modules/handlebars/dist/cjs/handlebars/runtime.js:212:12)"},"msg":"#with requires exactly one argument in UI template partials/head-scripts.hbs"}

mlr · 2025-01-21T17:37:55Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-21T17:39:18Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

mlr · 2025-01-24T20:01:36Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-24T20:03:08Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

mlr · 2025-01-24T21:35:41Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-24T21:36:58Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

mlr · 2025-01-24T21:58:58Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-24T22:01:29Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

mlr · 2025-01-24T22:47:44Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-24T22:49:02Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

mlr · 2025-01-24T23:19:09Z

UI bundle preview build successful! ✅
Deploying preview to GitHub Pages.
Deployment successful! View preview

plpesvc-ds · 2025-01-24T23:20:25Z

Build successful! ✅
Deploying draft.
Deploy successful! View draft

Add consent management link to footer

9fee0e0

eric-schneider requested a review from colegoldsmith January 9, 2025 19:08

eric-schneider assigned colegoldsmith and eric-schneider Jan 9, 2025

colegoldsmith approved these changes Jan 9, 2025

View reviewed changes

dynamic footer text and consent context added to segment calls

35bacac

fix consent object

c0dd2bc

Make footer link conditional

e00c57d

Shorten data-track attribute

bbca953

eric-schneider requested a review from EladioGaldamez January 9, 2025 23:55

EladioGaldamez reviewed Jan 10, 2025

View reviewed changes

colegoldsmith added 3 commits January 15, 2025 14:59

Squash merge remove-gtm-scripts into DOC-4329-footer

55e9c9f

fix track events so they use consent context correctly. Only load seg…

b5697a9

…ment if the user consents to analytics

Merge branch 'main' into DOC-4329-footer

a2de33e

EladioGaldamez approved these changes Jan 16, 2025

View reviewed changes

manual ketch url for testing purposes, revert this soon

0cf2a0f

EladioGaldamez reviewed Jan 16, 2025

View reviewed changes

load segment initially, update ketch scripts

ecabb4f

hard code keys

9213d6a

undo hard coded site keys

a363a1c

add ketch logic to js file and let middleware handle context

3c2eea0

colegoldsmith added 2 commits January 24, 2025 13:49

update to latest changes from marketing without gtag scripts

ec60950

UNDO THIS - hard coding segment and ketch site keys

89d00a4

use segment prod source

0350d78

force a rebuild

459745d

use dev segment source

0663bb2

add gtag script and use staging www site footer link

2652537

DOC-4329: Ketch footer and Segment updates #179

Are you sure you want to change the base?

DOC-4329: Ketch footer and Segment updates #179

Conversation

eric-schneider commented Jan 9, 2025 • edited by jira bot Loading

mlr commented Jan 9, 2025 • edited Loading

plpesvc-ds commented Jan 9, 2025 • edited Loading

colegoldsmith left a comment

Choose a reason for hiding this comment

mlr commented Jan 9, 2025 • edited Loading

plpesvc-ds commented Jan 9, 2025 • edited Loading

mlr commented Jan 9, 2025 • edited Loading

plpesvc-ds commented Jan 9, 2025 • edited Loading

mlr commented Jan 9, 2025 • edited Loading

plpesvc-ds commented Jan 9, 2025 • edited Loading

mlr commented Jan 9, 2025 • edited Loading

plpesvc-ds commented Jan 9, 2025 • edited Loading

EladioGaldamez Jan 10, 2025

Choose a reason for hiding this comment

colegoldsmith Jan 16, 2025

Choose a reason for hiding this comment

mlr commented Jan 16, 2025 • edited Loading

plpesvc-ds commented Jan 16, 2025 • edited Loading

EladioGaldamez left a comment

Choose a reason for hiding this comment

mlr commented Jan 16, 2025 • edited Loading

plpesvc-ds commented Jan 16, 2025 • edited Loading

plpesvc-ds commented Jan 16, 2025 • edited Loading

EladioGaldamez Jan 16, 2025 • edited Loading

Choose a reason for hiding this comment

colegoldsmith Jan 16, 2025

Choose a reason for hiding this comment

mlr commented Jan 16, 2025 • edited Loading

plpesvc-ds commented Jan 16, 2025 • edited Loading

mlr commented Jan 16, 2025 • edited Loading

plpesvc-ds commented Jan 16, 2025 • edited Loading

mlr commented Jan 17, 2025

plpesvc-ds commented Jan 17, 2025

mlr commented Jan 21, 2025 • edited Loading

plpesvc-ds commented Jan 21, 2025 • edited Loading

mlr commented Jan 24, 2025 • edited Loading

plpesvc-ds commented Jan 24, 2025 • edited Loading

mlr commented Jan 24, 2025 • edited Loading

plpesvc-ds commented Jan 24, 2025 • edited Loading

mlr commented Jan 24, 2025 • edited Loading

plpesvc-ds commented Jan 24, 2025 • edited Loading

mlr commented Jan 24, 2025 • edited Loading

plpesvc-ds commented Jan 24, 2025 • edited Loading

mlr commented Jan 24, 2025 • edited Loading

plpesvc-ds commented Jan 24, 2025 • edited Loading

eric-schneider commented Jan 9, 2025 •

edited by jira bot

Loading

mlr commented Jan 9, 2025 •

edited

Loading

plpesvc-ds commented Jan 9, 2025 •

edited

Loading

mlr commented Jan 9, 2025 •

edited

Loading

plpesvc-ds commented Jan 9, 2025 •

edited

Loading

mlr commented Jan 9, 2025 •

edited

Loading

plpesvc-ds commented Jan 9, 2025 •

edited

Loading

mlr commented Jan 9, 2025 •

edited

Loading

plpesvc-ds commented Jan 9, 2025 •

edited

Loading

mlr commented Jan 9, 2025 •

edited

Loading

plpesvc-ds commented Jan 9, 2025 •

edited

Loading

mlr commented Jan 16, 2025 •

edited

Loading

plpesvc-ds commented Jan 16, 2025 •

edited

Loading

mlr commented Jan 16, 2025 •

edited

Loading

plpesvc-ds commented Jan 16, 2025 •

edited

Loading

plpesvc-ds commented Jan 16, 2025 •

edited

Loading

EladioGaldamez Jan 16, 2025 •

edited

Loading

mlr commented Jan 16, 2025 •

edited

Loading

plpesvc-ds commented Jan 16, 2025 •

edited

Loading

mlr commented Jan 16, 2025 •

edited

Loading

plpesvc-ds commented Jan 16, 2025 •

edited

Loading

mlr commented Jan 21, 2025 •

edited

Loading

plpesvc-ds commented Jan 21, 2025 •

edited

Loading

mlr commented Jan 24, 2025 •

edited

Loading

plpesvc-ds commented Jan 24, 2025 •

edited

Loading

mlr commented Jan 24, 2025 •

edited

Loading

plpesvc-ds commented Jan 24, 2025 •

edited

Loading

mlr commented Jan 24, 2025 •

edited

Loading

plpesvc-ds commented Jan 24, 2025 •

edited

Loading

mlr commented Jan 24, 2025 •

edited

Loading

plpesvc-ds commented Jan 24, 2025 •

edited

Loading

mlr commented Jan 24, 2025 •

edited

Loading

plpesvc-ds commented Jan 24, 2025 •

edited

Loading