docs ready
This commit is contained in:
28
specs/009-backup-scheduler/quickstart.md
Normal file
28
specs/009-backup-scheduler/quickstart.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# Quickstart: Backup Scheduler & Unified Task UI
|
||||
|
||||
## Prerequisites
|
||||
- Backend running: `cd backend && uvicorn src.app:app --reload`
|
||||
- Frontend running: `cd frontend && npm run dev`
|
||||
|
||||
## Usage Guide
|
||||
|
||||
### 1. View Tasks
|
||||
1. Navigate to the new **Tasks** tab in the main navigation bar.
|
||||
2. Observe the list of recent tasks (Backups, Migrations).
|
||||
3. Click on any task row to view detailed logs.
|
||||
|
||||
### 2. Configure Scheduled Backups
|
||||
1. Go to **Settings**.
|
||||
2. Edit an existing Environment (or create a new one).
|
||||
3. Scroll to the **Backup Schedule** section.
|
||||
4. Enable the "Automatic Backups" toggle.
|
||||
5. Enter a valid Cron expression (e.g., `*/5 * * * *` for every 5 minutes).
|
||||
6. Save the environment.
|
||||
7. Wait for the scheduled time and verify a new Backup task appears in the **Tasks** tab.
|
||||
|
||||
### 3. Manual Backup Trigger
|
||||
1. Go to the **Tasks** tab.
|
||||
2. Click the **Run Backup** button (top right).
|
||||
3. Select the target environment from the dropdown.
|
||||
4. Click **Start**.
|
||||
5. Watch the new task appear with "Running" status.
|
||||
Reference in New Issue
Block a user