You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: components/konflux-info/README.md
+26-11Lines changed: 26 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -61,8 +61,8 @@ The file must contain a **YAML list** where each item represents a banner config
61
61
62
62
### **Important Behavior**
63
63
64
-
- The **UI displays only the first valid active banner** from the list, based on current date, time, and optional recurrence settings.
65
-
- If multiple banners are configured, **order matters**. Place the highest-priority banner **at the top of the list**.
64
+
- The <strongstyle="color: red;">UI displays only the first valid active banner</strong> from the list, based on current date, time, and optional recurrence settings.
65
+
- If multiple banners are configured, <strongstyle="color: red;">order matters</strong>.
66
66
67
67
---
68
68
@@ -76,7 +76,7 @@ The file must contain a **YAML list** where each item represents a banner config
|`timeZone`| string | ❌ | Optional IANA time zone (e.g., Asia/Shanghai). Omit for UTC (default). |
80
80
|`year`| number | ❌ | Year (1970–9999) for one-time banners. |
81
81
|`month`| number | ❌ | Month (1–12). |
82
82
|`dayOfWeek`| number | ❌ | Day of week (0=Sunday, 6=Saturday) for weekly recurrence. |
@@ -100,14 +100,14 @@ Example of a `banner-content.yaml` with multiple banners (first active one is sh
100
100
dayOfMonth: 25
101
101
startTime: "10:00"
102
102
endTime: "14:00"
103
-
timeZone: "UTC"
103
+
timeZone: "America/Los_Angeles"
104
104
105
105
- summary: "Maintenance every Sunday"
106
106
type: "info"
107
107
dayOfWeek: 0
108
108
startTime: "02:00"
109
109
endTime: "04:00"
110
-
timeZone: "UTC"
110
+
# No timezone is needed when you expect it's UTC.
111
111
```
112
112
113
113
#### ✅ **2. One-Time Banner**
@@ -122,7 +122,6 @@ For a single event on a specific date:
122
122
dayOfMonth: 25
123
123
startTime: "10:00"
124
124
endTime: "14:00"
125
-
timeZone: "UTC"
126
125
```
127
126
128
127
For a single event in today
@@ -132,7 +131,6 @@ For a single event in today
132
131
type: "warning"
133
132
startTime: "10:00"
134
133
endTime: "14:00"
135
-
timeZone: "UTC"
136
134
```
137
135
138
136
#### ✅ **2. Weekly Recurring Banner**
@@ -145,7 +143,6 @@ For an event that repeats every week:
145
143
dayOfWeek: 0
146
144
startTime: "02:00"
147
145
endTime: "04:00"
148
-
timeZone: "UTC"
149
146
```
150
147
151
148
#### ✅ **3. Monthly Recurring Banner**
@@ -189,7 +186,7 @@ When there are no events to announce:
189
186
190
187
2. Edit banner-content.yaml:
191
188
192
-
- Insert the new banner at the top of the list (highest priority).
189
+
-<strongstyle="color: red;">Insert the new banner at the top of the list</strong>.
193
190
- Remove obsolete banners to keep the list clean.
194
191
195
192
Example:
@@ -203,15 +200,13 @@ When there are no events to announce:
203
200
dayOfMonth: 30
204
201
startTime: "09:00"
205
202
endTime: "17:00"
206
-
timeZone: "UTC"
207
203
208
204
# Keep other active banners below
209
205
- summary: "Maintenance every Sunday"
210
206
type: "info"
211
207
dayOfWeek: 0
212
208
startTime: "02:00"
213
209
endTime: "04:00"
214
-
timeZone: "UTC"
215
210
```
216
211
217
212
3. Submit a Pull Request:
@@ -230,6 +225,26 @@ When there are no events to announce:
230
225
Purpose: Release announcement for Konflux 1.2
231
226
```
232
227
228
+
## ❓ Frequently Asked Questions
229
+
230
+
- Why is only one banner shown even when multiple are configured?
231
+
232
+
<strong style="color: red;">We follow the [PatternFly design guidelines](https://www.patternfly.org/components/banner/design-guidelines) for banners</strong>, which emphasize simplicity and clarity. Showing just one banner line at a time helps avoid overwhelming users and ensures that important messages aren't lost in clutter.
233
+
234
+
- What does “first active” actually mean?
235
+
236
+
<strong style="color: red;">The term 'first' doesn’t imply priority or severity</strong> — it simply refers to the first banner that is currently active based on time and repeat configuration.
237
+
238
+
If a banner was scheduled in the past, it should already have been displayed.
239
+
240
+
If it's scheduled in the future, it will show when its time comes.
241
+
242
+
At any given moment, the system checks which banner is active right now, and picks the first one that matches the criteria.
243
+
244
+
🕒 Banners use fields like `startTime`, `endTime`, `dayOfWeek`, etc., to precisely define when they should appear.
245
+
246
+
<strong style="color: red;">📝 If multiple messages need to be shared at the same time, consider combining them into a well-written summary inside a single banner.</strong>
247
+
233
248
## 📢 Auto Alerts(WIP)
234
249
235
250
We enables the infrastructure team to automatically surface specific operational issues or warnings in the Konflux UI.
0 commit comments