mirror of
https://github.com/cachethq/cachet.git
synced 2026-03-03 02:27:01 +00:00
Add quick start guide for applying the fix
Co-authored-by: jbrooksuk <246103+jbrooksuk@users.noreply.github.com>
This commit is contained in:
61
QUICK_START.md
Normal file
61
QUICK_START.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Sticky Incidents Fix - Quick Start
|
||||
|
||||
## What This Fix Does
|
||||
|
||||
✅ Makes sticky incidents display prominently at the top of your Cachet status page
|
||||
✅ Adds distinctive amber visual styling to sticky incidents
|
||||
✅ Prevents sticky incidents from appearing in the date-based timeline
|
||||
✅ No database changes or migrations required
|
||||
|
||||
## Quick Apply (for testing)
|
||||
|
||||
If you want to test this fix immediately in your local development environment:
|
||||
|
||||
```bash
|
||||
# Navigate to your Cachet installation
|
||||
cd /path/to/cachet
|
||||
|
||||
# Apply the patch to the core package
|
||||
cd vendor/cachethq/core
|
||||
patch -p1 < ../../../sticky-incidents-fix.patch
|
||||
|
||||
# Clear caches
|
||||
php artisan config:clear
|
||||
php artisan view:clear
|
||||
```
|
||||
|
||||
## Production Deployment
|
||||
|
||||
For production, this fix should be merged into the `cachethq/core` repository:
|
||||
|
||||
1. The changes are in 4 files (see patch file)
|
||||
2. Once merged and tagged in core, update your `composer.json`
|
||||
3. Run `composer update cachethq/core`
|
||||
|
||||
## Files Changed
|
||||
|
||||
1. `src/View/Components/IncidentTimeline.php` - Logic changes
|
||||
2. `resources/views/components/incident-timeline.blade.php` - UI changes
|
||||
3. `resources/lang/en/incident.php` - Translation
|
||||
4. `tests/Feature/View/Components/IncidentTimelineTest.php` - Tests (new)
|
||||
|
||||
## Documentation
|
||||
|
||||
- **SUMMARY.md** - Quick overview with visuals
|
||||
- **STICKY_INCIDENTS_FIX.md** - Detailed user documentation
|
||||
- **IMPLEMENTATION_DETAILS.md** - Technical deep dive
|
||||
- **sticky-incidents-fix.patch** - The actual code changes
|
||||
|
||||
## Testing
|
||||
|
||||
After applying, test by:
|
||||
|
||||
1. Create an incident and mark it as "Sticky"
|
||||
2. Visit your status page
|
||||
3. Verify the incident appears in "Stickied Incidents" section at top
|
||||
4. Verify it has an amber border
|
||||
5. Verify it's NOT in the "Past Incidents" timeline
|
||||
|
||||
## Questions?
|
||||
|
||||
Refer to the documentation files in this directory for complete details.
|
||||
Reference in New Issue
Block a user