update test arena
This commit is contained in:
33
doc/user_guide.md
Normal file
33
doc/user_guide.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# TestArena User Guide
|
||||
|
||||
## Getting Started
|
||||
|
||||
### Login
|
||||
Access the TestArena dashboard and log in with your credentials. Default admin credentials are `admin` / `admin123`.
|
||||
|
||||
### Submitting a New Job
|
||||
1. Click the **+ New Job** button on the dashboard.
|
||||
2. Enter the **Branch Name** you want to test and click **Validate Branch**.
|
||||
3. Select the test scenarios you want to include in the job.
|
||||
4. Review your selection and click **Submit Job**.
|
||||
|
||||
## Monitoring Jobs
|
||||
|
||||
### Dashboard
|
||||
The dashboard shows a list of all test jobs. You can see the status (Waiting, In Progress, Passed, Failed, Aborted) and who submitted the job.
|
||||
|
||||
### Job Details
|
||||
Click on a job to view its details:
|
||||
- **Scenario Summary**: Shows the status of each individual scenario in the job.
|
||||
- **Queue Logging**: Real-time logs from the execution queue.
|
||||
|
||||
### Searching
|
||||
Use the search boxes in the sidebar to find jobs by **Job ID** or **Username**. Admins can see all jobs, while regular users see their own by default.
|
||||
|
||||
## Managing Jobs
|
||||
|
||||
### Aborting a Job
|
||||
If a job is running, you can abort it by clicking the **Abort** button in the job details or via the right-click context menu in the job list.
|
||||
|
||||
### Deleting a Job
|
||||
To remove a job from the history and the remote server, click the **Delete** button in the job details or via the right-click context menu.
|
||||
Reference in New Issue
Block a user