Skip to content

Commit 162cdd5

Browse files
authored
Merge pull request #528 from ConductionNL/chore/spec-ids-out-of-user-text
docs(schemas): keep spec ids and em-dashes out of text a user reads
2 parents 3188458 + f269c0a commit 162cdd5

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

lib/Settings/launchpad_mock_register.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"x-openregister": {
99
"type": "mock",
1010
"app": "launchpad",
11-
"description": "Demo data for launchpad. NOT installed automatically a mock register is imported on demand, from the setup walkthrough or `occ openregister:descriptors:list --app=launchpad --import=<slug>`."
11+
"description": "Demo data for launchpad. It is not installed automatically: a mock register is imported on demand, from the setup walkthrough or `occ openregister:descriptors:list --app=launchpad --import=<slug>`."
1212
},
1313
"paths": {},
1414
"components": {
@@ -17,7 +17,7 @@
1717
"slug": "launchpad",
1818
"title": "LaunchPad Register (demo)",
1919
"version": "1.0.1",
20-
"description": "Demo data for LaunchPad Register. Generated from the register's own schemas — see hydra-gates/scripts/lib/generate_mock_register.py."
20+
"description": "Demo data for LaunchPad Register, generated from the register's own schemas. See hydra-gates/scripts/lib/generate_mock_register.py."
2121
}
2222
},
2323
"schemas": {
@@ -105,7 +105,7 @@
105105
"groupId": {
106106
"title": "Group ID",
107107
"type": "string",
108-
"description": "Nextcloud group ID for group_shared dashboards. Reserved value 'default' means visible to every user (REQ-DASH-012). Absent for user and admin_template dashboardsthe property is not in `required`, which is how OpenRegister models optionality. A union type such as [\"string\", \"null\"] is REJECTED by the schema importer (only scalar types are accepted), and that rejection is what silently prevented this whole schema — and therefore the register's reference to it — from ever being created.",
108+
"description": "Nextcloud group ID for group_shared dashboards. The reserved value 'default' means visible to every user. It is absent for user and admin_template dashboards: the property is not in `required`, which is how OpenRegister models optionality.",
109109
"example": "marketing"
110110
}
111111
},
@@ -188,7 +188,7 @@
188188
},
189189
"slug": "welcome-to-launchpad",
190190
"title": "Welcome to LaunchPad",
191-
"description": "Default landing dashboard visible to every userpowered by the 'default' synthetic group (REQ-DASH-012)",
191+
"description": "Default landing dashboard visible to every user, powered by the 'default' synthetic group",
192192
"version": "1.0.0",
193193
"type": "group_shared",
194194
"groupId": "default",
@@ -221,7 +221,7 @@
221221
},
222222
"slug": "active-campaigns",
223223
"title": "Active Campaigns",
224-
"description": "Marketing team shared dashboardscoped to the 'marketing' group (REQ-DASH-011)",
224+
"description": "Marketing team shared dashboard, scoped to the 'marketing' group",
225225
"version": "1.0.0",
226226
"type": "group_shared",
227227
"groupId": "marketing",
@@ -262,7 +262,7 @@
262262
},
263263
"slug": "sprint-overview",
264264
"title": "Sprint Overview",
265-
"description": "Engineering team shared dashboardscoped to the 'engineering' group (REQ-DASH-011)",
265+
"description": "Engineering team shared dashboard, scoped to the 'engineering' group",
266266
"version": "1.0.0",
267267
"type": "group_shared",
268268
"groupId": "engineering",

lib/Settings/launchpad_register.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"slug": "launchpad",
1919
"title": "LaunchPad Register",
2020
"version": "1.0.1",
21-
"description": "LaunchPad dashboards stored as OpenRegister objectsthe source of the v2 runtime manifest (ADR-036 Decision 8).",
21+
"description": "LaunchPad dashboards stored as OpenRegister objects. They are the source of the v2 runtime manifest.",
2222
"published": true,
2323
"schemas": ["dashboard"],
2424
"folder": "LaunchPad"
@@ -106,7 +106,7 @@
106106
"groupId": {
107107
"title": "Group ID",
108108
"type": "string",
109-
"description": "Nextcloud group ID for group_shared dashboards. Reserved value 'default' means visible to every user (REQ-DASH-012). Absent for user and admin_template dashboardsthe property is not in `required`, which is how OpenRegister models optionality. A union type such as [\"string\", \"null\"] is REJECTED by the schema importer (only scalar types are accepted), and that rejection is what silently prevented this whole schema — and therefore the register's reference to it — from ever being created.",
109+
"description": "Nextcloud group ID for group_shared dashboards. The reserved value 'default' means visible to every user. It is absent for user and admin_template dashboards: the property is not in `required`, which is how OpenRegister models optionality.",
110110
"example": "marketing"
111111
}
112112
},
@@ -189,7 +189,7 @@
189189
},
190190
"slug": "welcome-to-launchpad",
191191
"title": "Welcome to LaunchPad",
192-
"description": "Default landing dashboard visible to every userpowered by the 'default' synthetic group (REQ-DASH-012)",
192+
"description": "Default landing dashboard visible to every user, powered by the 'default' synthetic group",
193193
"version": "1.0.0",
194194
"type": "group_shared",
195195
"groupId": "default",
@@ -222,7 +222,7 @@
222222
},
223223
"slug": "active-campaigns",
224224
"title": "Active Campaigns",
225-
"description": "Marketing team shared dashboardscoped to the 'marketing' group (REQ-DASH-011)",
225+
"description": "Marketing team shared dashboard, scoped to the 'marketing' group",
226226
"version": "1.0.0",
227227
"type": "group_shared",
228228
"groupId": "marketing",
@@ -263,7 +263,7 @@
263263
},
264264
"slug": "sprint-overview",
265265
"title": "Sprint Overview",
266-
"description": "Engineering team shared dashboardscoped to the 'engineering' group (REQ-DASH-011)",
266+
"description": "Engineering team shared dashboard, scoped to the 'engineering' group",
267267
"version": "1.0.0",
268268
"type": "group_shared",
269269
"groupId": "engineering",

0 commit comments

Comments
 (0)