@checkstack/announcement-frontend 0.2.15 → 0.3.0
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.
- package/CHANGELOG.md +89 -0
- package/package.json +12 -10
- package/src/index.tsx +1 -0
- package/src/pages/AnnouncementManagePage.tsx +28 -5
- package/tsconfig.json +23 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,94 @@
|
|
|
1
1
|
# @checkstack/announcement-frontend
|
|
2
2
|
|
|
3
|
+
## 0.3.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 3547670: Wire the new tips infrastructure across the frontends:
|
|
8
|
+
|
|
9
|
+
**Empty-state coaching.** Replace generic "no items" copy with onboarding
|
|
10
|
+
guidance — short description, three numbered steps and a primary CTA — on
|
|
11
|
+
every EmptyState that has a meaningful next action. Affects: catalog
|
|
12
|
+
(systems + groups), dashboard, health-check page, integrations (subscriptions
|
|
13
|
+
|
|
14
|
+
- provider connections), GitOps providers + secrets, GitOps provenance,
|
|
15
|
+
SLO config + overview, maintenance config, satellites, plugin manager,
|
|
16
|
+
incident config, announcements. Read-only EmptyStates (incident history,
|
|
17
|
+
maintenance history, plugin events) get clearer descriptions explaining
|
|
18
|
+
what would populate them.
|
|
19
|
+
|
|
20
|
+
**First-run anchored tips.** Add `<Tip>` popovers to the most important
|
|
21
|
+
"Create" affordances so first-time users see a one-line explanation of
|
|
22
|
+
what they're about to make and why it matters: catalog “Add System” /
|
|
23
|
+
“Add Group”, healthcheck “Create Check”, integrations “New Subscription”,
|
|
24
|
+
GitOps “Add Provider”, SLO “Create SLO”, maintenance “Create Maintenance”,
|
|
25
|
+
satellite “Create Satellite”, plugin-manager “Install plugin”, incident
|
|
26
|
+
“Report Incident”, announcement “New Announcement”. Each tip is dismissed
|
|
27
|
+
per user (server-backed when signed in, localStorage otherwise) and
|
|
28
|
+
namespaced through `qualifyTipId(plugin, …)` so it cannot escape the
|
|
29
|
+
plugin's own namespace.
|
|
30
|
+
|
|
31
|
+
**Welcome banner on the dashboard.** A `<TipBanner>` at the top of the
|
|
32
|
+
dashboard introduces Checkstack's main flow ("add a system, then a health
|
|
33
|
+
check") with a one-click jump into the catalog.
|
|
34
|
+
|
|
35
|
+
### Patch Changes
|
|
36
|
+
|
|
37
|
+
- 950d6ec: Fix mobile UserMenu items rendering at zero height, group menu items by
|
|
38
|
+
section, and unstack cramped card headers on small viewports.
|
|
39
|
+
|
|
40
|
+
- **UserMenu mobile bug**: On mobile, the user-menu Sheet rendered every
|
|
41
|
+
menu item as a grid row, which combined with `flex-shrink: 1` on each
|
|
42
|
+
item collapsed the buttons whose internal layout uses `display: flex`
|
|
43
|
+
(the items registered with `useNavigate` rather than `<Link>`) to zero
|
|
44
|
+
content height. Switched the mobile container to a flex column with
|
|
45
|
+
`[&>*]:shrink-0` and added `min-h-0` so the sheet scrolls correctly
|
|
46
|
+
when the list overflows.
|
|
47
|
+
|
|
48
|
+
- **UserMenu grouping**: Slot extensions now accept an optional `group`
|
|
49
|
+
field. The user menu buckets `UserMenuItemsSlot` extensions by `group`
|
|
50
|
+
and renders each group under a labeled header (`Workspace`,
|
|
51
|
+
`Reliability`, `Configuration`, `Documentation`, `Account`). Existing
|
|
52
|
+
core plugins are tagged with the appropriate group; third-party plugins
|
|
53
|
+
can pick any of these or supply their own label. Untagged extensions
|
|
54
|
+
render last with no header. `UserMenuItemsBottomSlot` is unaffected.
|
|
55
|
+
|
|
56
|
+
- **Card header responsiveness**: `CardHeaderRow` (the primitive shared by
|
|
57
|
+
Incident, Maintenance, Auth, Catalog, GitOps and other config cards) now
|
|
58
|
+
stacks vertically on narrow viewports and only switches to a single row
|
|
59
|
+
at the `sm` breakpoint, so titles and adjacent filter controls (e.g.
|
|
60
|
+
status `Select`, "Show resolved" checkbox) no longer cram together on
|
|
61
|
+
mobile. Refactored the Incident and Maintenance config pages to use the
|
|
62
|
+
primitive instead of a hand-rolled `flex items-center justify-between`
|
|
63
|
+
row, and made their `Select` triggers full-width on mobile.
|
|
64
|
+
|
|
65
|
+
- Updated dependencies [42abfff]
|
|
66
|
+
- Updated dependencies [3547670]
|
|
67
|
+
- Updated dependencies [1ef2e79]
|
|
68
|
+
- Updated dependencies [aa89bc5]
|
|
69
|
+
- Updated dependencies [3547670]
|
|
70
|
+
- Updated dependencies [950d6ec]
|
|
71
|
+
- Updated dependencies [3547670]
|
|
72
|
+
- @checkstack/common@0.9.0
|
|
73
|
+
- @checkstack/ui@1.8.0
|
|
74
|
+
- @checkstack/frontend-api@0.5.0
|
|
75
|
+
- @checkstack/tips-frontend@0.2.0
|
|
76
|
+
- @checkstack/auth-frontend@0.6.0
|
|
77
|
+
- @checkstack/announcement-common@0.3.2
|
|
78
|
+
- @checkstack/signal-frontend@0.1.2
|
|
79
|
+
|
|
80
|
+
## 0.2.16
|
|
81
|
+
|
|
82
|
+
### Patch Changes
|
|
83
|
+
|
|
84
|
+
- Updated dependencies [50e5f5f]
|
|
85
|
+
- @checkstack/announcement-common@0.3.1
|
|
86
|
+
- @checkstack/common@0.8.0
|
|
87
|
+
- @checkstack/signal-frontend@0.1.1
|
|
88
|
+
- @checkstack/ui@1.7.1
|
|
89
|
+
- @checkstack/auth-frontend@0.5.33
|
|
90
|
+
- @checkstack/frontend-api@0.4.2
|
|
91
|
+
|
|
3
92
|
## 0.2.15
|
|
4
93
|
|
|
5
94
|
### Patch Changes
|
package/package.json
CHANGED
|
@@ -1,23 +1,25 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@checkstack/announcement-frontend",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.3.0",
|
|
4
|
+
"license": "Elastic-2.0",
|
|
4
5
|
"type": "module",
|
|
5
6
|
"main": "src/index.tsx",
|
|
6
7
|
"checkstack": {
|
|
7
8
|
"type": "frontend"
|
|
8
9
|
},
|
|
9
10
|
"scripts": {
|
|
10
|
-
"typecheck": "
|
|
11
|
+
"typecheck": "tsgo -b",
|
|
11
12
|
"lint": "bun run lint:code",
|
|
12
13
|
"lint:code": "eslint . --max-warnings 0"
|
|
13
14
|
},
|
|
14
15
|
"dependencies": {
|
|
15
|
-
"@checkstack/announcement-common": "0.3.
|
|
16
|
-
"@checkstack/auth-frontend": "0.5.
|
|
17
|
-
"@checkstack/common": "0.
|
|
18
|
-
"@checkstack/frontend-api": "0.4.
|
|
19
|
-
"@checkstack/signal-frontend": "0.1.
|
|
20
|
-
"@checkstack/
|
|
16
|
+
"@checkstack/announcement-common": "0.3.1",
|
|
17
|
+
"@checkstack/auth-frontend": "0.5.33",
|
|
18
|
+
"@checkstack/common": "0.8.0",
|
|
19
|
+
"@checkstack/frontend-api": "0.4.2",
|
|
20
|
+
"@checkstack/signal-frontend": "0.1.1",
|
|
21
|
+
"@checkstack/tips-frontend": "0.1.0",
|
|
22
|
+
"@checkstack/ui": "1.7.1",
|
|
21
23
|
"date-fns": "^4.1.0",
|
|
22
24
|
"lucide-react": "^0.344.0",
|
|
23
25
|
"react": "^18.2.0",
|
|
@@ -26,7 +28,7 @@
|
|
|
26
28
|
"devDependencies": {
|
|
27
29
|
"typescript": "^5.0.0",
|
|
28
30
|
"@types/react": "^18.2.0",
|
|
29
|
-
"@checkstack/tsconfig": "0.0.
|
|
30
|
-
"@checkstack/scripts": "0.
|
|
31
|
+
"@checkstack/tsconfig": "0.0.7",
|
|
32
|
+
"@checkstack/scripts": "0.3.0"
|
|
31
33
|
}
|
|
32
34
|
}
|
package/src/index.tsx
CHANGED
|
@@ -8,11 +8,13 @@ import {
|
|
|
8
8
|
import {
|
|
9
9
|
AnnouncementApi,
|
|
10
10
|
announcementAccess,
|
|
11
|
+
pluginMetadata as announcementPluginMetadata,
|
|
11
12
|
type Announcement,
|
|
12
13
|
type AnnouncementSeverity,
|
|
13
14
|
type AnnouncementVisibility,
|
|
14
15
|
type AnnouncementDisplayMode,
|
|
15
16
|
} from "@checkstack/announcement-common";
|
|
17
|
+
import { Tip } from "@checkstack/tips-frontend";
|
|
16
18
|
import {
|
|
17
19
|
PageLayout,
|
|
18
20
|
Card,
|
|
@@ -501,10 +503,19 @@ const AnnouncementManageContent: React.FC = () => {
|
|
|
501
503
|
loading={accessLoading}
|
|
502
504
|
allowed={canManage}
|
|
503
505
|
actions={
|
|
504
|
-
<
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
506
|
+
<Tip
|
|
507
|
+
plugin={announcementPluginMetadata}
|
|
508
|
+
id="create"
|
|
509
|
+
title="Broadcast portal-wide"
|
|
510
|
+
description="An announcement is a top-of-portal banner — different from incidents (which are about specific systems) and notifications (which target subscribers). Use them for planned maintenance windows users should know about, new feature rollouts, or important policy changes."
|
|
511
|
+
side="bottom"
|
|
512
|
+
align="end"
|
|
513
|
+
>
|
|
514
|
+
<Button onClick={handleCreate}>
|
|
515
|
+
<Plus className="h-4 w-4 mr-2" />
|
|
516
|
+
New Announcement
|
|
517
|
+
</Button>
|
|
518
|
+
</Tip>
|
|
508
519
|
}
|
|
509
520
|
>
|
|
510
521
|
<Card>
|
|
@@ -521,8 +532,20 @@ const AnnouncementManageContent: React.FC = () => {
|
|
|
521
532
|
</div>
|
|
522
533
|
) : announcements.length === 0 ? (
|
|
523
534
|
<EmptyState
|
|
535
|
+
icon={<Megaphone className="size-10" />}
|
|
524
536
|
title="No announcements yet"
|
|
525
|
-
description="
|
|
537
|
+
description="Announcements appear at the top of the portal and let you broadcast information to anyone using Checkstack — planned downtime, new features, or status updates that don't fit the incident model."
|
|
538
|
+
steps={[
|
|
539
|
+
"Click “New Announcement” and write a short, clear title.",
|
|
540
|
+
"Pick a severity (info, warning, critical) — this controls colour and prominence.",
|
|
541
|
+
"Choose visibility: public, signed-in users only, or specific roles.",
|
|
542
|
+
]}
|
|
543
|
+
actions={
|
|
544
|
+
<Button onClick={handleCreate}>
|
|
545
|
+
<Plus className="h-4 w-4 mr-2" />
|
|
546
|
+
Create your first announcement
|
|
547
|
+
</Button>
|
|
548
|
+
}
|
|
526
549
|
/>
|
|
527
550
|
) : (
|
|
528
551
|
<Table>
|
package/tsconfig.json
CHANGED
|
@@ -2,5 +2,28 @@
|
|
|
2
2
|
"extends": "@checkstack/tsconfig/frontend.json",
|
|
3
3
|
"include": [
|
|
4
4
|
"src"
|
|
5
|
+
],
|
|
6
|
+
"references": [
|
|
7
|
+
{
|
|
8
|
+
"path": "../announcement-common"
|
|
9
|
+
},
|
|
10
|
+
{
|
|
11
|
+
"path": "../auth-frontend"
|
|
12
|
+
},
|
|
13
|
+
{
|
|
14
|
+
"path": "../common"
|
|
15
|
+
},
|
|
16
|
+
{
|
|
17
|
+
"path": "../frontend-api"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"path": "../signal-frontend"
|
|
21
|
+
},
|
|
22
|
+
{
|
|
23
|
+
"path": "../tips-frontend"
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"path": "../ui"
|
|
27
|
+
}
|
|
5
28
|
]
|
|
6
29
|
}
|