Skip to content

Commit bb17533

Browse files
sanscontextmarkzegarelli
sanscontext
and
markzegarelli
authored
[DRAFT] Dossiers (#1489)
* clean up home and search pages to remove unused logic * straggler * starting the dossier layout * orphan checkin * create a summary page for troubleshooting * add question * checkin for collab tomorrow. * reorder output of destinations catalog file, add cmodes summary * almost there. checking in for validation pass * whoops broke it * comment out autobeta, improve dossier * checkin, more small changes * handle dests with no method info * fix broken bolding * styled quick info box * hide some utils [netlify-ignore] * hide dossier from personas dests * remove hide-dossier, tweaks to devguide table * back out auto-betas. Co-authored-by: markzegarelli <[email protected]>
1 parent 8479778 commit bb17533

File tree

24 files changed

+7651
-5856
lines changed

24 files changed

+7651
-5856
lines changed

‎devguide.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,25 @@ The script also “calculates” the values for the `connection-modes` table for
4747

4848
It also does some slugification and destination-name normalization, since our handling of dots and dashes hasn't been consistent over time. Finally, it checks to see if there’s a folder for each destination. If it finds a new one, the script makes a folder with a “stub” markdown file for that destination, and then adds a line for it to an "incompleteDocs.txt" file. (It doesn't check to see if it's already listed, just appends to the file.)
4949

50+
### Connection Modes in the Catalog script
51+
52+
As part of the Dossiers project we worked on making the Connection Modes table more readable. Originally we were going to have per-page liquid run, but these modes don't change often so it would've added a lot of build time for very little benefit. Instead we pushed it into `catalog.js`.
53+
Once the connection modes device and cloud arrays are set, we do a bunch of calculations, and add a text summary, a number which corresponds to that summary for easier programmatic writing, and a rough category.
54+
55+
| Case | Summary | Type | Message |
56+
| ---- | -------------------------------------- | ----------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
57+
| 0 | No data available | none | No connection mode information available. |
58+
| 1 | Both device, no cloud | device-only | accepts device-mode data from both Analytics.js and mobile sources. It does not accept data in cloud-mode. |
59+
| 2 | AJS (web device) only | device-only | accepts device-mode data only from Analytics.js. |
60+
| 3 | Mobile device mode only | device-only | accepts device-mode data only from a mobile source. |
61+
| 4 | Accepts from all | all | accepts cloud-mode data from all Segment source types. It can accept device-mode data from both web and mobile sources. |
62+
| 5 | All cloud types | cloud-only | accepts cloud-mode data from all Segment source types. It does not offer device-mode connections. |
63+
| 6 | Mobile and Server cloud only | cloud-only | accepts data from any Segment mobile or server source in cloud mode. It does not accept data from a web source, and does not offer device-mode connections. |
64+
| 7 | Web and mobile cloud only | cloud-only | accepts only cloud-mode data from web and mobile sources. |
65+
| 8 | Mobile cloud only | cloud-only | accepts only cloud-mode data from mobile sources. |
66+
| 9 | All cloud types, 1 device mode | mixed | accepts data in cloud-mode from all source types, and can accept data in device-mode from [Analytics.js or mobile] sources. |
67+
| 10 | Web and mobile cloud, 1 device | mixed | accepts data in cloud-mode from web and mobile sources, and can accept data in device-mode from [Analytics.js or mobile] sources. |
68+
| 11 | Mobile and server cloud, mobile device | mixed | accepts data in cloud-mode from mobile and server sources, and can accept data in device-mode from mobile sources. |
5069

5170
## Developer information
5271

@@ -63,9 +82,10 @@ default.html
6382
|- destination.html
6483
|- source.html
6584
|- main.html
66-
|- catalog.html
67-
|- home.html
68-
|- page.html
85+
|- catalog.html - used for connections catalog pages only
86+
|- home.html - for main landing page only
87+
|- page.html - used for all pages outside Connections catalogs, without an explicit override
88+
|- search.html - search results page only
6989
```
7090

7191
### Platform Config API + Catalog

‎scripts/catalog.js

Lines changed: 100 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ const getConnectionModes = (destination) => {
5454
web: false,
5555
mobile: false,
5656
server: false
57-
}
57+
},
58+
summary: "testing",
59+
cmode_type: ""
5860
}
5961
destination.components.forEach(component => {
6062
switch (component.type) {
@@ -90,11 +92,103 @@ const getConnectionModes = (destination) => {
9092
break
9193
}
9294
})
95+
96+
// summarize connection modes in plain english.
97+
// start with no-cloud
98+
if (connectionModes.cloud.web == false && connectionModes.cloud.mobile == false && connectionModes.cloud.server == false){
99+
// first check if no info at all available - these need backfill
100+
if (connectionModes.device.web == false && connectionModes.device.mobile == false) {
101+
connectionModes.summary = "No connection mode information available."
102+
connectionModes.case = "0"
103+
connectionModes.cmode_type = "none"
104+
}
105+
// handle has-device-modes: three cases
106+
else if (connectionModes.device.web == true || connectionModes.device.mobile == true){
107+
connectionModes.cmode_type = "device-only"
108+
if (connectionModes.device.web == true && connectionModes.device.mobile == true) {
109+
connectionModes.summary = "accepts device-mode data from both Analytics.js and mobile sources. It does not accept data in cloud-mode."
110+
connectionModes.case = "1"
111+
}
112+
if (connectionModes.device.web == true && connectionModes.device.mobile == false) {
113+
connectionModes.summary = "accepts device-mode data only from Analytics.js."
114+
connectionModes.case = "2"
115+
}
116+
if (connectionModes.device.web == false && connectionModes.device.mobile == true) {
117+
connectionModes.summary = "accepts device-mode data only from a mobile source."
118+
connectionModes.case = "3"
119+
}
120+
}
121+
122+
}
123+
//next check if all are true.
124+
else if (connectionModes.cloud.web == true && connectionModes.cloud.mobile == true && connectionModes.cloud.server == true && connectionModes.device.web == true && connectionModes.device.mobile == true) {
125+
connectionModes.cmode_type = "all"
126+
connectionModes.summary = "accepts cloud-mode data from all Segment source types. It can accept device-mode data from both web and mobile sources."
127+
connectionModes.case = "4"
128+
}
129+
130+
//next handle all cloud-only (no-device-mode) cases
131+
else if ((connectionModes.device.web == false && connectionModes.device.mobile == false) && (connectionModes.cloud.web == true || connectionModes.cloud.mobile == true || connectionModes.cloud.server == true)) {
132+
connectionModes.cmode_type = "cloud-only"
133+
// accepts all cloud-mode
134+
if (connectionModes.cloud.web == true && connectionModes.cloud.mobile == true && connectionModes.cloud.server == true){
135+
connectionModes.summary = "accepts cloud-mode data from all Segment source types. It does not offer device-mode connections."
136+
connectionModes.case = "5"
137+
}
138+
//edge-case-y: only mobile and server cloud
139+
else if (connectionModes.cloud.web == false && connectionModes.cloud.mobile == true && connectionModes.cloud.server == true){
140+
connectionModes.summary = "accepts data from any Segment mobile or server source in cloud mode. It does not accept data from a web source, and does not offer device-mode connections."
141+
connectionModes.case = "6"
142+
}
143+
//edge-case-y: web and mobile cloud, no server.
144+
else if (connectionModes.cloud.web == true && connectionModes.cloud.mobile == true && connectionModes.cloud.server == false){
145+
connectionModes.summary = "accepts only cloud-mode data from web and mobile sources."
146+
connectionModes.case = "7"
147+
}
148+
//edge-case-y: mobile cloud only.
149+
else if (connectionModes.cloud.web == false && connectionModes.cloud.mobile == true && connectionModes.cloud.server == false){
150+
connectionModes.summary = "accepts only cloud-mode data from mobile sources."
151+
connectionModes.case = "8"
152+
}
153+
}
154+
155+
//handle mixed-case - in the dossier, use the case, or type: "mixed" to invoke a check for what type of device mode
156+
else if ((connectionModes.cloud.web == true || connectionModes.cloud.mobile == true || connectionModes.cloud.server == true) && (connectionModes.device.mobile == true || connectionModes.device.web == true)){
157+
// remove "both" as that would be covered under ALL
158+
if (!(connectionModes.device.mobile == true && connectionModes.device.web == true)){
159+
connectionModes.cmode_type = "mixed"
160+
// all cloud-mode plus one device
161+
if ((connectionModes.cloud.web == true && connectionModes.cloud.mobile == true && connectionModes.cloud.server == true) && (connectionModes.device.mobile == true || connectionModes.device.web == true)){
162+
if (connectionModes.device.mobile == true || connectionModes.device.web == false){
163+
connectionModes.summary = "accepts data in cloud-mode from all source types, and can accept data in device-mode from mobile sources."
164+
}
165+
else if (connectionModes.device.mobile == false || connectionModes.device.web == true){
166+
connectionModes.summary = "accepts data in cloud-mode from all source types, and can accept data in device-mode from Analytics.js sources."
167+
}
168+
connectionModes.case = "9"
169+
}
170+
// edge-case-y: cloud web and mobile, no server, one device
171+
else if ((connectionModes.cloud.web == true && connectionModes.cloud.mobile == true && connectionModes.cloud.server == false) && (connectionModes.device.mobile == true || connectionModes.device.web == true)){
172+
if (connectionModes.device.mobile == true || connectionModes.device.web == false){
173+
connectionModes.summary = "accepts data in cloud-mode from web and mobile sources, and can accept data in device-mode from mobile sources."
174+
}
175+
else if (connectionModes.device.mobile == false || connectionModes.device.web == true){
176+
connectionModes.summary = "accepts data in cloud-mode from web and mobile sources, and can accept data in device-mode from Analytics.js sources."
177+
}
178+
connectionModes.case = "10"
179+
}
180+
// edge-case-y: cloud mobile and server, device mobile, no web
181+
else if (connectionModes.cloud.web == false && connectionModes.cloud.mobile == true && connectionModes.cloud.server == true && connectionModes.device.mobile == true && connectionModes.device.web == false){
182+
connectionModes.summary = "accepts data in cloud-mode from mobile and server sources, and can accept data in device-mode from mobile sources."
183+
connectionModes.case = "11"
184+
}
185+
}
186+
}
187+
93188
return connectionModes
94189
}
95190

96191
/**
97-
*
98192
* If catalog item does not exist, create folder and index.md file for it, and record it as incomplete for later fill in
99193
*/
100194
const doesCatalogItemExist = (item) => {
@@ -266,25 +360,25 @@ const updateDestinations = async () => {
266360
display_name: destination.display_name,
267361
slug,
268362
name: destination.name,
363+
url,
269364
description: destination.description,
270365
hidden: isCatalogItemHidden(url),
271-
url,
272366
status: destination.status,
367+
previous_names: destination.previous_names,
273368
logo: {
274369
url: destination.logos.logo
275370
},
276371
mark: {
277372
url: destination.logos.mark
278373
},
279374
categories: tempCategories,
375+
methods: destination.methods,
280376
components: destination.components,
281377
platforms: destination.platforms,
282378
browserUnbundlingSupported: destination.browserUnbundlingSupported,
283379
browserUnbundlingPublic: destination.browserUnbundlingPublic,
284-
methods: destination.methods,
285-
settings,
286380
connection_modes,
287-
previous_names: destination.previous_names
381+
settings
288382
}
289383

290384
destinationsUpdated.push(updatedDestination)

0 commit comments

Comments
 (0)