Skip to content

Commit fd284fc

Browse files
committed
chore: Restructure documentation
1 parent 2309402 commit fd284fc

19 files changed

+3838
-138
lines changed

docs/css/extra.css

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@
77
}
88

99
.md-header__inner {
10-
margin-top: 10px;
10+
padding: 5px 0;
1111
}
File renamed without changes.
File renamed without changes.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ Several key features:
3636

3737
- **Customizable**
3838

39-
Define job labels and customize virtual machine resources to fit Your needs. See [Configuration](./user-guide/configuration.md) for more information.
39+
Define job labels and customize virtual machine resources to fit Your needs. See [Configuration](./reference/configuration.md) for more information.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/user-guide/first-build.md

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# Running Your First Build
2+
3+
After installing and configuring Fireactions, verify your setup by running a test workflow.
4+
5+
## Verify Runners Are Registered
6+
7+
Check your GitHub organization's Actions settings to confirm runners are registered:
8+
9+
1. Navigate to your GitHub organization settings
10+
2. Go to **Actions****Runners**
11+
3. Verify that runners are listed as **Idle** and ready to receive jobs
12+
13+
If runners aren't appearing, check the Fireactions logs:
14+
15+
```bash
16+
sudo journalctl -u fireactions -f
17+
```
18+
19+
## Create a Test Workflow
20+
21+
Create a simple workflow to test your Fireactions setup. In your repository, create `.github/workflows/test-fireactions.yml`:
22+
23+
```yaml
24+
name: Test Fireactions
25+
26+
on:
27+
workflow_dispatch:
28+
push:
29+
branches:
30+
- main
31+
pull_request:
32+
33+
jobs:
34+
test:
35+
name: Test Runner
36+
runs-on: fireactions-example # Replace with your pool label
37+
steps:
38+
- name: Check runner environment
39+
run: |
40+
echo "Runner is working!"
41+
uname -a
42+
docker --version
43+
```
44+
45+
**Important:** Replace `fireactions-example` with the label from your [pool configuration](../reference/configuration.md).
46+
47+
## Run the Workflow
48+
49+
Trigger the workflow using one of these methods:
50+
51+
- **Manual trigger:** Go to Actions tab → Select workflow → Click "Run workflow"
52+
- **Push to main:** Commit and push changes to the main branch
53+
- **Pull request:** Open a pull request
54+
55+
## Verify Execution
56+
57+
Watch the workflow run in GitHub Actions:
58+
59+
1. Go to the **Actions** tab in your repository
60+
2. Click on the workflow run
61+
3. Verify the job completes successfully
62+
4. Check that it ran on a Fireactions runner
63+
64+
## Expected Behavior
65+
66+
When the workflow runs:
67+
68+
1. Fireactions creates a new Firecracker microVM
69+
2. The GitHub runner inside the VM picks up the job
70+
3. Job executes in the isolated environment
71+
4. VM is destroyed after job completion
72+
73+
You should see the workflow complete in ~20-30 seconds from trigger to finish.
74+
75+
## Troubleshooting
76+
77+
If the workflow doesn't run or fails:
78+
79+
- Verify pool labels match between configuration and workflow
80+
- Check Fireactions logs for errors
81+
- Ensure sufficient system resources (CPU, memory, disk)
82+
- See the [Troubleshooting Guide](../help/troubleshooting.md) for common issues

0 commit comments

Comments
 (0)