@digital-realty/ui-knowledgebase 0.1.6-IXUAT-11303.561981 → 0.1.7-docs-updat.562618

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +173 -45
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -14,21 +14,35 @@ client sanitizes them centrally (KB-2), so components just render the ready-made
14
14
 
15
15
  ## Page component maps
16
16
 
17
- Annotated UAT screenshots mapping every component per page (boxes named with their ticket).
18
-
19
- **Landing** (`/`)
17
+ Annotated screenshots mapping every component per page (boxes named with their ticket).
18
+ Re-audited against **production** (`globalportal.digitalrealty.com`), except the landing map,
19
+ which is still UAT.
20
+
21
+ **Categories vs topics (two different axes):** production has **four categories** — Media
22
+ Resources, Operational Documents, User Guides, What's New — all rendered by the one Category View
23
+ (KB-13). It also has **topics** (Service Ticket Management, Launchpad, News, …) — cross-category
24
+ tags that each have their own Topic View page (KB-14) and show up as filter chips on category
25
+ pages. (UAT's categories/topics differed, e.g. the "User Agreement" topic in older maps is UAT
26
+ only — it does not exist in production.)
27
+
28
+ **Landing** (`/`) — _still UAT._
20
29
  ![Landing page component map](docs/audit-landing-page.png)
21
30
 
22
- **Category** (`/category/:uid`) — note the chrome tickets: back button, category sidebar nav, breadcrumb.
23
- ![Category page component map](docs/audit-category-page.png)
24
-
25
- **Topic** (`/topic/:code`) — back button + breadcrumb, no sidebar.
31
+ **Category** (`/category/:uid`) — **one view (KB-13)** renders all four categories; a map for each
32
+ below (Operational Documents and User Guides share the `document_card` renderer — User Guides
33
+ adds a topic filter). Boxes tagged "sub-task" are its component sub-tasks, "reused" are shared
34
+ chrome.
35
+ ![Category — Media Resources (video_card)](docs/audit-category-media-resources.png)
36
+ ![Category — Operational Documents (document_card)](docs/audit-category-operational-documents.png)
37
+ ![Category — User Guides (document_card + topic filter)](docs/audit-category-user-guides.png)
38
+ ![Category — What's New (accordion + year filter)](docs/audit-category-whats-new.png)
39
+
40
+ **Topic** (`/topic/:code`) — the Topic View (KB-14); back button + breadcrumb + search, **no
41
+ sidebar**, posts rendered by each post's own `behavior`. Shown: production **News** topic.
26
42
  ![Topic page component map](docs/audit-topic-page.png)
27
43
 
28
- **What's New category** — adds the year filter.
29
- ![What's New page component map](docs/audit-whatsnew-page.png)
30
-
31
- _Details (`/details/:uid`) is just title + rich-text body in UAT — no back button or breadcrumb._
44
+ _Details (`/details/:uid`): title + topic chips + date + rich-text body (plus video / documents
45
+ when present). Has a back button (KB-17) but **no** breadcrumb and **no** sidebar._
32
46
 
33
47
  ## Tickets
34
48
 
@@ -279,8 +293,11 @@ The landing "What's New" side panel.
279
293
 
280
294
  ### KB-9 · `kb-post-text`
281
295
 
296
+ _Sub-task of KB-13 · Category View — a per-`behavior` post renderer (shared: reused by KB-14 / KB-15)._
297
+
282
298
  ![KB-9 post text](docs/KB-09-post-text.png)
283
- _UAT reference: the Terms, Policies & Disclaimers category (text-behavior posts)._
299
+ _Reference: no current **production** category uses `text`; UAT exercised it in the "Terms,
300
+ Policies & Disclaimers" category (preview items: title/abstract/date → details)._
284
301
 
285
302
  **Type:** Story
286
303
 
@@ -295,8 +312,11 @@ Post renderer for `behavior = text` (article-style body).
295
312
 
296
313
  ### KB-10 · `kb-post-accordion`
297
314
 
315
+ _Sub-task of KB-13 · Category View — a per-`behavior` post renderer (shared: reused by KB-14 / KB-15)._
316
+
298
317
  ![KB-10 post accordion](docs/KB-10-post-accordion.png)
299
- _UAT reference: What's New category (also accordion-behavior); V2 FAQs is empty in UAT._
318
+ _Production reference: the **What's New** category (`accordion` behavior) — ~9 monthly "… Release
319
+ Notes" accordion items (see the KB-13 What's New map)._
300
320
 
301
321
  **Type:** Story
302
322
 
@@ -311,8 +331,13 @@ Post renderer for `behavior = accordion` (used by FAQ categories).
311
331
 
312
332
  ### KB-11 · `kb-post-video-card`
313
333
 
334
+ _Sub-task of KB-13 · Category View — a per-`behavior` post renderer (shared: reused by KB-14 / KB-15)._
335
+
314
336
  ![KB-11 post video card](docs/KB-11-post-video-card.png)
315
- _UAT reference: the video player from the video post's detail page — UAT has no `video_card` category, so the card layout isn't shown (use Figma for that)._
337
+ _Production reference: the **Media Resources** category is `video_card` — a card with a video
338
+ thumbnail + play-button overlay, the topic label + duration (e.g. "News · 3:49"), title and
339
+ abstract (see the KB-13 category component map). The player opens from the card / details page.
340
+ (UAT had no `video_card` category, so this layout is only visible in production.)_
316
341
 
317
342
  **Type:** Story
318
343
 
@@ -327,8 +352,11 @@ Post renderer for `behavior = video_card`.
327
352
 
328
353
  ### KB-12 · `kb-post-document-card`
329
354
 
355
+ _Sub-task of KB-13 · Category View — a per-`behavior` post renderer (shared: reused by KB-14 / KB-15)._
356
+
330
357
  ![KB-12 post document card](docs/KB-12-post-document-card.png)
331
- _UAT reference: the User Guides category (document_card-behavior posts)._
358
+ _Production reference: the **User Guides** (15 posts) and **Operational Documents** (policies, LOA
359
+ template, T&Cs) categories — both `document_card` behavior._
332
360
 
333
361
  **Type:** Story
334
362
 
@@ -341,48 +369,87 @@ Post renderer for `behavior = document_card`.
341
369
 
342
370
  **Dependencies:** KB-1, KB-2.
343
371
 
344
- ### KB-13 · Build category listing page view
372
+ ### KB-13 · Category View _(parent story — the page layout; components below are its sub-tasks)_
345
373
 
346
- ![KB-13 category view](docs/KB-13-category-view.png)
347
- ![KB-13 sort + topic filter controls](docs/KB-13b-sort-filter-controls.png)
348
- _Second image: the flag-driven sort + topic-filter controls (shown only when `showSortBy` / `showFilterByTopic` are set)._
374
+ Component maps, re-audited against **production** — one per category (all the same layout; only
375
+ the post renderer and controls differ):
349
376
 
350
- **Type:** Story
351
-
352
- **Summary**
353
- The category route (`/category/:uid`). Fetches a category and its posts, and renders the
354
- posts using the category's `behavior`.
377
+ ![Media Resources — video_card](docs/audit-category-media-resources.png)
378
+ ![Operational Documents — document_card](docs/audit-category-operational-documents.png)
379
+ ![User Guides — document_card + topic filter](docs/audit-category-user-guides.png)
380
+ ![What's New — accordion + year filter](docs/audit-category-whats-new.png)
355
381
 
356
- **Background**
357
- Mirrors the legacy category page. A category's `behavior` (`text | accordion |
358
- video_card | document_card`) decides which post component renders its posts, and its
359
- `showSortBy` / `showFilterByTopic` flags decide whether the sort and topic-filter
360
- controls appear.
361
-
362
- **Scope**
382
+ _**Media Resources** (`video_card` + scrollable topic filter + sort), **Operational Documents**
383
+ (`document_card` + sort), **User Guides** (`document_card` + scrollable topic filter + sort, 15
384
+ posts), and **What's New** (`accordion` + year filter). Operational Documents and User Guides use
385
+ the same `document_card` renderer (User Guides just adds the topic filter). Boxes tagged
386
+ "sub-task" are the sub-tasks below; "reused" boxes are already-built shared components._
363
387
 
364
- - A Lit route view at `/category/:uid` calling `StrapiClient.getCategory(uid)` (KB-1).
365
- - Header from the category (title, subtitle, icon/image).
366
- - Render the posts by selecting the post component from the category `behavior`
367
- (KB-9 `text`, KB-10 `accordion`, KB-11 `video_card`, KB-12 `document_card`).
368
- - Show inline sort and filter-by-topic controls only when `showSortBy` / `showFilterByTopic` are set.
369
- - Post click → `/details/:uid`; loading, empty, and error states.
370
-
371
- **Out of scope**
388
+ **Type:** Story
372
389
 
373
- - The post components themselves (KB-9–12); search.
390
+ **Summary**
391
+ **One** view/route (`/category/:uid`) renders **every** category page — there is no per-category
392
+ view. In production the four categories — **Media Resources · Operational Documents · User
393
+ Guides · What's New** — are the same layout; the category's `behavior` and flags decide which
394
+ post component and controls appear. Fetches the category + its posts via `getCategory(uid)`
395
+ (KB-1).
396
+
397
+ **Layout** (see the maps): back button + breadcrumb + title across the top, then two columns — a
398
+ left **category sidebar nav** and a **main column** (search · optional subtitle · optional
399
+ controls · the posts list rendered by `behavior` · empty state).
400
+
401
+ **The categories are one view, differing only by data/flags (production):**
402
+
403
+ | Category | `behavior` → post sub-task | Controls |
404
+ | --- | --- | --- |
405
+ | Media Resources | `video_card` → kb-post-video-card (KB-11) | topic filter (scrollable) + sort |
406
+ | Operational Documents | `document_card` → kb-post-document-card (KB-12) | sort |
407
+ | User Guides | `document_card` → kb-post-document-card (KB-12) | topic filter (scrollable) + sort |
408
+ | What's New | `accordion` → kb-post-accordion (KB-10) | year filter |
409
+
410
+ _No production category currently uses `text` (kb-post-text, KB-9) or the empty state, but both
411
+ stay in scope — the data model supports `text`, and UAT exercised it (a "Terms, Policies &
412
+ Disclaimers" text category + empty "FAQs"/"Operations")._
413
+
414
+ **Sub-tasks** (each a component of this view):
415
+
416
+ - **kb-category-nav** (KB-18) — left sidebar listing all categories, current one highlighted.
417
+ - Post renderers, selected by `behavior`: **kb-post-text** (KB-9), **kb-post-accordion** (KB-10),
418
+ **kb-post-video-card** (KB-11), **kb-post-document-card** (KB-12). _Shared — the topic (KB-14)
419
+ and details (KB-15) views reuse these._
420
+ - **kb-sort-control** (KB-21) — result count + Sort-by dropdown (`showSortBy`).
421
+ - **kb-topic-filter** (KB-22) — a horizontally **scrollable** row of topic chips that filter the
422
+ post list (`showFilterByTopic`); Media Resources and User Guides show many.
423
+ - **kb-whats-new-year-filter** (KB-20) — year pills; What's New only.
424
+ - **Empty state** — the "No posts." message (FAQs / Operations in UAT).
425
+
426
+ **Reuses (already built):** kb-back-btn (KB-17), kb-breadcrumb (KB-19), kb-search-bar scoped to
427
+ the category (KB-16).
428
+
429
+ **Scope (the view/story itself — not the sub-task components)**
430
+
431
+ - The Lit route view at `/category/:uid` calling `getCategory(uid)` (KB-1), with loading / empty
432
+ ("No posts.") / error states.
433
+ - The two-column layout, header (title + optional subtitle), and sidebar placement.
434
+ - Selecting the post component from `behavior`; showing the sort / topic-filter controls only
435
+ when `showSortBy` / `showFilterByTopic` are set; showing the year filter on What's New.
436
+ - Post click → `/details/:uid`.
374
437
 
375
438
  **Acceptance criteria**
376
439
 
377
- - Posts render with the component matching the category `behavior`.
378
- - Sort / topic-filter controls appear only when their flags are set, and filter/sort the list.
379
- - Loading, empty, and error states render.
440
+ - Every category renders through this one view; posts use the component matching `behavior`.
441
+ - Sort / topic-filter controls appear only when their flags are set and actually sort/filter.
442
+ - The year filter appears on What's New and filters by year; empty and error states render.
380
443
 
381
- **Dependencies:** KB-1, KB-9, KB-10, KB-11, KB-12, KB-17 (back button), KB-18 (sidebar nav), KB-19 (breadcrumb); KB-20 (year filter) on the What's New category.
444
+ **Dependencies:** KB-1 + the sub-tasks above (KB-18, KB-9–12, KB-20, KB-21, KB-22); reuses KB-16,
445
+ KB-17, KB-19.
382
446
 
383
447
  ### KB-14 · Build topic listing page view
384
448
 
385
- ![KB-14 topic view](docs/KB-14-topic-view.png)
449
+ ![KB-14 topic view — production News topic](docs/audit-topic-page.png)
450
+ _Re-audited against production (the **News** topic). A topic is a cross-category tag, not a
451
+ category: no sidebar, and each post renders by its own `behavior`. (The old UAT map showed the
452
+ "User Agreement" topic, which doesn't exist in production.)_
386
453
 
387
454
  **Type:** Story
388
455
 
@@ -522,6 +589,8 @@ installed in this package).
522
589
 
523
590
  ### KB-18 · `kb-category-nav`
524
591
 
592
+ _Sub-task of KB-13 · Category View — the left category sidebar nav._
593
+
525
594
  **Type:** Story
526
595
 
527
596
  ![KB-18 category sidebar nav](docs/KB-18-category-nav.png)
@@ -566,6 +635,8 @@ empty-label case. _Current label is the uid/code until the real category/topic v
566
635
 
567
636
  ### KB-20 · `kb-whats-new-year-filter`
568
637
 
638
+ _Sub-task of KB-13 · Category View — the year pills, What's New only._
639
+
569
640
  **Type:** Story
570
641
 
571
642
  ![KB-20 What's New year filter](docs/KB-20-year-filter.png)
@@ -578,3 +649,60 @@ The year pills (e.g. `2025` / `2026`) on the What's New category that filter rel
578
649
  **Renders:** a row of selectable year pills; selecting one filters the accordion list to that year. (What's New category only.)
579
650
 
580
651
  **Dependencies:** KB-1, KB-13.
652
+
653
+ ### KB-21 · `kb-sort-control`
654
+
655
+ _Sub-task of KB-13 · Category View — the result count + Sort-by dropdown (shown when `showSortBy`)._
656
+
657
+ **Type:** Story
658
+
659
+ _Shown in the KB-13 category maps (the "Sort + count" box — e.g. Media Resources, User Guides,
660
+ Operational Documents)._
661
+
662
+ **Summary**
663
+ The posts-list header: a result count ("N Tutorials/items") on the left and a **Sort by** dropdown
664
+ on the right that reorders the list. Appears only when the category's `showSortBy` flag is set.
665
+
666
+ **Data:** the category's posts (for the count) + its `showSortBy` flag — from KB-1 (`getCategory`).
667
+
668
+ **Renders:** a header row with the count and a Sort-by dropdown (e.g. Newest First / Oldest
669
+ First); changing it re-sorts the posts list in place (client-side). Category view only. Wraps the
670
+ shared `ix-*` dropdown/select if one fits, like the other KB components wrap `ix-*`.
671
+
672
+ **Acceptance criteria**
673
+
674
+ - The count matches the number of posts shown; it updates when the topic filter (KB-22) narrows the list.
675
+ - The dropdown reorders the list (at least Newest/Oldest by `dateAdded`); default is Newest First.
676
+ - Hidden entirely when `showSortBy` is false.
677
+
678
+ **Dependencies:** KB-1, KB-13.
679
+
680
+ ### KB-22 · `kb-topic-filter`
681
+
682
+ _Sub-task of KB-13 · Category View — the scrollable topic chips (shown when `showFilterByTopic`)._
683
+
684
+ **Type:** Story
685
+
686
+ _Shown in the KB-13 category maps (the "Topic filter" box — e.g. Media Resources, User Guides)._
687
+
688
+ **Summary**
689
+ A horizontally **scrollable** row of topic chips above the posts list; selecting chips filters the
690
+ list to posts carrying those topics. Appears only when the category's `showFilterByTopic` flag is
691
+ set.
692
+
693
+ **Data:** the topics present on the category's posts (`topics`: `code`, `name`, `icon`) + the
694
+ `showFilterByTopic` flag — from KB-1 (`getCategory`).
695
+
696
+ **Renders:** a scrollable chip row (each chip: topic icon + name) with a **scroll control** when
697
+ the chips overflow; chips toggle selected and filter the posts list in place (client-side).
698
+ Category view only — topic pages (KB-14) are already scoped to a single topic, so they don't show
699
+ this filter.
700
+
701
+ **Acceptance criteria**
702
+
703
+ - Chips reflect the topics actually present on the category's posts; selecting one filters the list.
704
+ - Multiple chips can be active (union/intersection TBD — mirror legacy); clearing all shows every post.
705
+ - The row scrolls horizontally with a control when chips overflow; hidden entirely when `showFilterByTopic` is false.
706
+ - Plays nicely with the sort control (KB-21) and the result count (which reflects the filtered set).
707
+
708
+ **Dependencies:** KB-1, KB-13.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@digital-realty/ui-knowledgebase",
3
- "version": "0.1.6-IXUAT-11303.561981",
3
+ "version": "0.1.7-docs-updat.562618",
4
4
  "type": "module",
5
5
  "publishConfig": {
6
6
  "access": "public"