From b9989f2ec8a0d17adfefff7fb50abc4558ead876 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Thu, 17 Sep 2026 19:43:05 +1000 Subject: [PATCH] docs: group landing page examples under an Example Queries heading Add an "Example Queries" H2 with an intro sentence to the `sumologic` provider landing page so the existing example sections nest under a single ToC entry (matching the clickhouse microsite), and regenerate the website landing page. `website/static/favicon.ico`, `favicon-16x16.png` and `favicon-32x32.png` are now also at the `static/` root, which is where the shared Docusaurus config links them from (the site previously served no favicon). Co-Authored-By: Claude Fable 5.1 --- .../docgen/provider-data/headerContent2.txt | 16 ++++++++++------ website/docs/index.md | 16 ++++++++++------ website/static/favicon-16x16.png | Bin 0 -> 872 bytes website/static/favicon-32x32.png | Bin 0 -> 1533 bytes website/static/favicon.ico | Bin 0 -> 15086 bytes 5 files changed, 20 insertions(+), 12 deletions(-) create mode 100644 website/static/favicon-16x16.png create mode 100644 website/static/favicon-32x32.png create mode 100644 website/static/favicon.ico diff --git a/provider-dev/docgen/provider-data/headerContent2.txt b/provider-dev/docgen/provider-data/headerContent2.txt index ff9e602..df0e4fc 100644 --- a/provider-dev/docgen/provider-data/headerContent2.txt +++ b/provider-dev/docgen/provider-data/headerContent2.txt @@ -90,7 +90,11 @@ SELECT id, name, category FROM sumologic.collectors.collectors WHERE filter = 'h SELECT json_extract(item, '$.name') AS name, path FROM sumologic.monitors.search WHERE query = 'type:monitor'; ``` -## Users and roles +## Example Queries + +Try the following queries using `stackql shell`, or run them from a script or CI pipeline with `stackql exec`. + +### Users and roles Users with their state and role assignment: @@ -108,7 +112,7 @@ SELECT id, name, description, system_defined, json_array_length(capabilities) AS FROM sumologic.roles.roles; ``` -## Collectors and sources +### Collectors and sources The collector estate - type, liveness and version: @@ -134,7 +138,7 @@ FROM sumologic.collectors.offline_collectors WHERE alive_before_days = 30; ``` -## Content library, monitors and dashboards +### Content library, monitors and dashboards The personal folder and its children: @@ -161,7 +165,7 @@ FROM sumologic.monitors.search WHERE query = 'type:monitor'; ``` -## Data tiers, partitions and budgets +### Data tiers, partitions and budgets Partitions with tier and retention: @@ -178,7 +182,7 @@ SELECT id, name, capacity_bytes, usage_bytes, usage_status, action, reset_time, FROM sumologic.ingest_budgets.ingest_budgets; ``` -## Provision, mutate and tear down +### Provision, mutate and tear down Mutations use the same SQL grammar - `INSERT` creates a resource, `UPDATE` replaces it (Sumo Logic updates are `PUT`s, so supply every required field), `EXEC` invokes lifecycle actions and `DELETE` removes it. Structured values (arrays, objects) are passed as JSON strings, and booleans are quoted (`is_active = 'false'`) - a bare `true` / `false` on the right-hand side of `SET` is not accepted. A hosted collector with an HTTP source end to end (the Collector Management API wraps its bodies in `collector` / `source` objects, passed as JSON values): @@ -222,7 +226,7 @@ SET first_name = 'Ada', last_name = 'Lovelace', is_active = 'false', role_ids = WHERE id = '000000000000ABCD'; ``` -## Lifecycle operations +### Lifecycle operations State transitions are `EXEC` methods on the resource they act on, addressed with the wire-cased parameter names: diff --git a/website/docs/index.md b/website/docs/index.md index c00de71..bcf37bc 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -120,7 +120,11 @@ SELECT id, name, category FROM sumologic.collectors.collectors WHERE filter = 'h SELECT json_extract(item, '$.name') AS name, path FROM sumologic.monitors.search WHERE query = 'type:monitor'; ``` -## Users and roles +## Example Queries + +Try the following queries using `stackql shell`, or run them from a script or CI pipeline with `stackql exec`. + +### Users and roles Users with their state and role assignment: @@ -138,7 +142,7 @@ SELECT id, name, description, system_defined, json_array_length(capabilities) AS FROM sumologic.roles.roles; ``` -## Collectors and sources +### Collectors and sources The collector estate - type, liveness and version: @@ -164,7 +168,7 @@ FROM sumologic.collectors.offline_collectors WHERE alive_before_days = 30; ``` -## Content library, monitors and dashboards +### Content library, monitors and dashboards The personal folder and its children: @@ -191,7 +195,7 @@ FROM sumologic.monitors.search WHERE query = 'type:monitor'; ``` -## Data tiers, partitions and budgets +### Data tiers, partitions and budgets Partitions with tier and retention: @@ -208,7 +212,7 @@ SELECT id, name, capacity_bytes, usage_bytes, usage_status, action, reset_time, FROM sumologic.ingest_budgets.ingest_budgets; ``` -## Provision, mutate and tear down +### Provision, mutate and tear down Mutations use the same SQL grammar - `INSERT` creates a resource, `UPDATE` replaces it (Sumo Logic updates are `PUT`s, so supply every required field), `EXEC` invokes lifecycle actions and `DELETE` removes it. Structured values (arrays, objects) are passed as JSON strings, and booleans are quoted (`is_active = 'false'`) - a bare `true` / `false` on the right-hand side of `SET` is not accepted. A hosted collector with an HTTP source end to end (the Collector Management API wraps its bodies in `collector` / `source` objects, passed as JSON values): @@ -252,7 +256,7 @@ SET first_name = 'Ada', last_name = 'Lovelace', is_active = 'false', role_ids = WHERE id = '000000000000ABCD'; ``` -## Lifecycle operations +### Lifecycle operations State transitions are `EXEC` methods on the resource they act on, addressed with the wire-cased parameter names: diff --git a/website/static/favicon-16x16.png b/website/static/favicon-16x16.png new file mode 100644 index 0000000000000000000000000000000000000000..178c10711387dbff479e5b5d2fa6966ee4c540b3 GIT binary patch literal 872 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!63?wyl`GbKJOS+@4BLl<6e(pbstU$g(vPY0F z14ES>14Ba#1H&(%P{RubhEf9thF1v;3|2E37{m+a>`T@Ck7(s%#9%Yz)b6 zEUj(~%4`hFZgfv+@}!4j(%Kk>69%8&fnd8=5}8HhV3VAOj~!%Id6uvf0LMZL({z7J5Jn4?O3fA z(dm@fq!`j>n9#2h+U}Uxq#V@r|NsBS>FYRvfhblIG z%v{JRkdTy?FmZ|#)1@^$MnRiSH1GyH_;`i+$(;xaVBy|i+;LJ{bM=YUr&g`Z&d54> zs)&JgOKHj1FHd<(c(3+6abyaLk~*fgYgyVev1wt~xD*&8U0tQ4t*hDH)zigYCp4^{ zy}Nz+^zHrY=kGW3=w4OnkPuMdkr7eRvWzJ}AxQgFOju}`nH5_KXMjSOR~X|H2G$N{ zOUb0I0WqhJ9?Cy&nOiTJ zTUc4xd$I_#u!2j2$>9`c<;@`qr*B+2apcSqnIr6{8$1?x=`p+#7cBYYWI7dS1%s!n KpUXO@geCwPM^2Og literal 0 HcmV?d00001 diff --git a/website/static/favicon-32x32.png b/website/static/favicon-32x32.png new file mode 100644 index 0000000000000000000000000000000000000000..f1efee03ab3cbef83577a5b041c102fb9d599fe9 GIT binary patch literal 1533 zcmZ`%dpwj`82(Uchjz8tNl{ZFmeHsPT{ap&cO%BNW*f$kA~Tv{#wFkR$X!?>*DfpD zg?2C%)-|lz&@Rm)^HUl>>qo6?|Gm1Jn#EF=Z|v|ogA&UV76l*2-;#} zO>{;PC*7On&`c~&`W=N0{^kzm5LBL~AokuUZPKir9Uv%N8-n0i2wFiYcnX5p1PGd@ zLXg>Y2*NT7YEB)6AlYOmd$Q#i4~|8^l^B2kX+%eZOW}YM2>|>rgVvFkKeu4u86+*( z5gm7sxY(fHE37zP*| z5W)qven8h1(R4wy$cQ!>*+)hQo`_o@u=4|Ij)=rn@&K(t&C z0}qr3ny&F?{#oiyF<5(8$1};qFB5AI3_X!;_Q1?PvwKi<`$>mAyKv{JSbJ7s@5r0$ zzqVNh=Ni#62F7RB*VpG4K9)6fyGQ-Jha88sgNebpuV)vg=NF5sI!R$Sb~#_M4#_X9 ze75*;xmwWY6L(MBJ<*ACqon5f%)7;Ri%aECgiP<%YWO+sWxUKhluVhu*=%eSZJ!$JZ8Fc+SJGi-PXmn~`*DEO?xvai( zU~y^L)GrfHNo8hKw04gyEw2iMqj*Zn{vT6WS(VRv##UCv5{V@FPQwmTOjKS~*MLYY zUK6iLghNxHsK(eg!t!z%CNayyv&}P>>Q$w}hZD;22tjbBVhU z3idc7=h@(Z7joz{qUVMjJBv660Cf_w`xN342uvsl-W|z#B(op=ulg)!M;8>KusccBM) zmW_j@{KTejs8nzI3-e7i;f%)TO@9a)Tg!r}35qEx-i0v)=4)^-PLF}vqL7x5l61A4{~;w+ zA&q2hA5uwlqt4_Ne2Xp0%Ptxfsify#(@6m!5eP-s$Cgxb$?x zt!nOgiSfR9dj69@N(HCu@!XK3^(c?#&slo-D&lBiVBOMNh2dywKlzDlRyxa+GsQdN z(J?3JqP3A)RB#pxnoi)(s;>WCk0#mm7lzpaCR3!J?me2Qbdsn_Y^tuT%8V(S6|gn6yDX7}v<=ZnWH_twmRL zH8OGPJpnl|@j-qNti4Yt64&$5C)Z+Gda!)GS#&d62pt9J0O0@uPcX(C8j%SH%?O5O zhQ@k?17-xmkrr^_KZ2lO-vB@E{|jt$O?y#+dpOyHM-?TM=rmJ#&?_JtOGn~E3o7ytz75d- literal 0 HcmV?d00001 diff --git a/website/static/favicon.ico b/website/static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..0145fbfbd5b887d60a9edca52036888a7d3cbd0d GIT binary patch literal 15086 zcmeHOX>?Ro5^l#CJ@aSAIdc>o(20nsFerM|;|!ysqXS})Eri8ELVyHF!X5}DguahO z!j6P}7eqlpQG~DvVMq2o5SAn?VF?KkLK3po)K{-xr#s#0yoLtCIrKS|`}*bGcfVV= zs&3t?YK!F&%cGWh^(@@_S-yS2VtLDAvH1DfzCU5HoaTE^aEt$U{k_F9f**K^pW!Z+ zAST?GPffjX_g7i1k1>6yl$xrPwvFka59kQLBb6!52Xuh3#WTh?n11It2mbz~vZ^uM zUQyAJr22)D>J{Vz>OiVTJ5muopgx^R#SAE6oT-d6l<6_df!javy;&+YrbKlQAT6*C zY0aJ`t!Z`N(5KZ%^940~hP1ZzNc9dT#(aY**oHqs4T;TFA^tkvCQtKtf2*9-q$+7G zo+pL1P%4S%P@CoQkm}c!wC2w-=1Pp+;3?+t*_)&WM;Ec&MDsj~RcI5^Dl^{=>_*GH zR{g_y4YXgBbqHx4-)H0poslFk=zgZ1o{6P&KJp8bc2L6r@@!wO~gZw<` z{CAZ92Tp#f>-(4?{|}u0GJg0szz_Qw{DDXNqx`Fqx&!;FcyCeuReWck*|#ahZzZks zf8FB8xZ^t1qo3pZ(WH=n@-x8U-99m_`Lp!H*l?N`)trX6_&ZrKk2~Ef&EjXQle_+# zZe(4e%=4#d)8g?oHLL**ZCcGVKY{u9Z)+$&=Q;@Y93eq~l+$_vgR)xi@$|t7*v>ohh!(i_#zK?3MjBi=W>+ z_VZWh#O`%eRB+3V0T(&fGHCy=i|MQA02&eST)F%l+N?SyE*e9**;k$V7v9RFl!IGn z`Gj6HrhQ$JOVc`L62HNdQSEBe_oKSnjCw*5li4(&iATfg9zpTk@D z(VWO8v}@%&%Fevt)W4{(fX*lHqg69vXhQHCVkaupF)#6BeIX|!18dSEtvwyt@-yY- zTyw%vkav?#?MZ>$6C25^jM=|}SiwWNJ(zoDF~mkkKgLe9=4?V?|%44`pAuQ3js zze>+T25;j->kC$3E@te;2Xo50kS24S-t$A&F+O)W^q1?~#qaPQ%wrgz>1Ou%n11_d zmgqGz)PNzF&K=uBlS2RH*5>Ma%F`k<2`oG3PwXeilH=z_=0#e{a_h1VKEQAA1n-7D zof7sQZTx1e$c2I7R&I{iDa_S)zHAGf#aza=e}#S=--A*QZKL9%LgN*@Mk8g-o%;C_ zKV<5YDs0nh&^N3bXOni@$2Nl>xMY6JgJ}^T(4N%`oowCu1z+41{Dw}CYWFfN9o>yi z?pe>a>82e!F0y(3p|39MFLJ2s6848V{hQG4Rr6hJQ*ludt(qR=Q~btykNf;p@hj4f z>~P{2aOYgR!h6FKn$LR!@Hwu%G4BxpHE6-$*0Lwx%+5kL`={_$zR1x}6MKs-bMZHB zLw*c>o7nj+T0PrJ=_e05$tiUAdd7L$xuWdetlJ&~cU+rVv}8mu9ovyW`8Tuem~nB7 z_vYlCYw5d@U1(I>mxS-==Qw}4_6EQ7uSS!*y(9Z*#@Q28Qe12wx1^+4e51`vCeqaK z_ucwNShF$z`-kY~>HV9iAV1gM9~ao04{iK`zP7fr`$leY8}`pEe#Q~O)%^q56f^#oBmT>2$7#dDIN=F!xwlKDd$n8an1fmVGhd;vdlDAX;^7_HKdV)~ zP8qx@(*i%v4Qp8EP5WnM-r+J2llakZDEkP&AZzT-7F0M^HSw>-?s||j7mS|X>ji$V z-dpaNZfsz=&-zY&e1qKt9&hKuHcjSFIR4PkZT#VZ zz^^pYLOJ*1E8X%|7H;c#2mT9w*H$OFTEqE4W1DCbX|&q?=JK0M%u4-;6M)S!NhU(J;qYV6=bB{|5-z6OjB zxudXF$iZhYHDs#Fb4ZZ7hoJZL+5yZF_Ovn)hSlq zTmw<0`g9@{@`>(KATQu63Te#yB=0j`lRqK9uEN`pis}izXEWAu-2MgFjSqjX#`lM_ zKBTZ*ah-=1&-#v(g1+4@m2lrorUb?m$n-}8_cdJn*9W zhkw1`fECX&|BN;f-Q zF4eeqV*>}q|BQ1&kcG(Z_hEeI^?e<`63o9H$LIzROm@Hiw!FLf!D5)0e#^m*g0q1XkpyE}uCr&mw+(a_nvB3+c4oS`q zxy1C72Pk1?tW&%YIkNb!^(Fq9aVA+}*~r(OIl7Zp#7AOg$e-Er zDR>{=i#Rc2{Tsd>E%8>p=0UGRK^!w-#$ZZ6ae#9eMVt@dSo-P1v}TTyc&RZrkrBK6 zIj_I{8Jnztf8e8$k2)dwC_PtxDK$xA^jHV<(=k`!b*f9q(WD;SD)D73PTJuedOja> zH!=URIDlbD<0oa#$F{GM^+tYTT7+vJ%=*bwEQ3!;9R2ix&GPJ3j;$MUUT?<7+`xlL zA#c;V`NQc_%28b&IG35i^RvGb^Jk2}J*E4*oHHFqSI(W}^(qz_PTIbbMsvM^$fJq* z%ez>%riM2l4N;5bYj;! z&O3#OO|kQ|g7J}inAxWh?c{ot>??X*19GOvcC4nwBZ4W;9&fKIwJLL?n$g}hi=_4g zs6 zpVu3?dE^0iulh=CYkBoJ;QQ=;{scYP{=+o$c^ePoBVGZ!4;x%z4v61_y#lg{wKe3= zzRrBl?X}18(TDdm_$cM|cf8Nmq8rVn9@AouL^>BP%e;fa!BXhOZY)8QpcWZSw?uq}8-x>@$ z%yp&-5|=@oQZN9=T_lW+SXV?_#4aW=)n`3SQi$WUdRg}c;g5Pl0jxh9gQ}Qb)PL&| z9>`~(nDsn%4ci&`T|SQ{szH4V)qo!4HL(suk4#ZaR3^uh=JD9IFm@tG4Xk=3=AK4l zFeb)EoC0A9KPG#ef`4mP_M-+x2C4AC<18yTn6jOz@eS4G<6NdZTWehBaa@688c|L8 zjGwMG_w!!H@w=XgcKh_-lH8t-s8Ihb=`V5(KhgC)`aReCqLU%$k6P@fCFhO$3fwpR zPF&;6V4Rm+bh%68EG-y*BF+}Cvmdic>MW*l4VA_|7JS9Eb2O>l!FdO@JWgjATYu;! zY9(j(ZX~sRs43gIVh+vXT0i*d@b^#cOO$gHYTn>83x0?G_zu4Tgt{EmAftvEK2Pk& zf0bHO`0zKcXG%R1p3@xrGY?QV03T=f%K386fPV;|40A)xAZmF~3yd?Q@YR?<>pn1{ zHU{Sj)b*i$2>bWcd z#4qdST4Ms7GFSe;@XWF8(kM&o^by}LM?M^%b$8vl;T`v9{kbT=AN1BXv(Bloz+-Hi idZ}*BG9ZWU=|ep>kDR{)sjz@F_7mD$@4z~t@Bab!?d6{U literal 0 HcmV?d00001