Skip to content

Commit 1ec95eb

Browse files
mprpicclaude
andcommitted
fix: update CLAUDE.md to replace stale dev-* Makefile targets with local-*
The CRC-based dev-* targets (dev-logs, dev-start, dev-stop, etc.) were replaced with local-* equivalents in 5553056 but CLAUDE.md was never updated to reflect this. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: Martin Prpič <mprpic@redhat.com>
1 parent 056d8de commit 1ec95eb

6 files changed

Lines changed: 50 additions & 54 deletions

File tree

.github/workflows/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,13 +72,13 @@ This directory contains automated workflows for the Ambient Code Platform.
7272
**Purpose**: Validates local development setup works correctly.
7373

7474
**Triggers**:
75-
- Changes to dev scripts (`Makefile`, `dev-start.sh`, etc.)
75+
- Changes to dev scripts (`Makefile`, local-dev scripts, etc.)
7676
- Manual workflow dispatch
7777

7878
**What It Does**:
7979
1. Simulates local development environment
80-
2. Tests `make dev-start`, `make dev-stop`
81-
3. Verifies CRC integration
80+
2. Tests `make local-up`, `make local-down`
81+
3. Verifies local cluster integration
8282

8383
---
8484

components/README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,19 +39,20 @@ components/
3939

4040
### Local Development (Recommended)
4141
```bash
42-
# Single command to start everything
43-
make dev-start
42+
# Single command to start everything (minikube)
43+
make local-up
44+
45+
# Or use Kind (recommended for most development)
46+
make kind-up
4447
```
4548

4649
**Prerequisites:**
47-
- Minikube: `brew install minikube`
48-
- Red Hat pull secret: Get free from [console.redhat.com](https://console.redhat.com/openshift/create/local)
50+
- Minikube (`brew install minikube`) or Kind (`brew install kind`) + Docker
4951

5052
**What you get:**
51-
- ✅ Complete OpenShift development environment
52-
- ✅ Frontend: `https://vteam-frontend-vteam-dev.apps-crc.testing`
53+
- ✅ Complete local development environment
54+
- ✅ Frontend and backend accessible via localhost
5355
- ✅ Backend API working with authentication
54-
- ✅ OpenShift console access
5556
- ✅ Ready for project creation and agentic sessions
5657

5758
### Production Deployment
@@ -65,13 +66,12 @@ cd components/manifests
6566
CONTAINER_REGISTRY=$REGISTRY ./deploy.sh
6667
```
6768

68-
### Hot Reloading Development
69+
### Rebuild Components
6970
```bash
70-
# Terminal 1: Start with development mode
71-
DEV_MODE=true make dev-start
72-
73-
# Terminal 2: Enable file sync for hot-reloading
74-
make dev-sync
71+
make local-rebuild # Rebuild and reload all components
72+
make local-reload-backend # Rebuild and reload backend only
73+
make local-reload-frontend # Rebuild and reload frontend only
74+
make local-reload-operator # Rebuild and reload operator only
7575
```
7676

7777
## Quick Deploy

components/frontend/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,12 @@ go run .
3434

3535
### Frontend (local) quick start
3636

37-
**Recommended: Use integrated CRC development environment:**
37+
**Recommended: Use integrated local development environment:**
3838
```bash
3939
# From repository root - single command setup
40-
make dev-start
41-
# Access: https://vteam-frontend-vteam-dev.apps-crc.testing
40+
make local-up # minikube
41+
# Or: make kind-up # kind (recommended)
42+
# Access: http://localhost:8080
4243
```
4344

4445
**Alternative: Standalone frontend development:**

components/manifests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ cd e2e
8484

8585
**Deploy**:
8686
```bash
87-
make dev-start
87+
make local-up
8888
```
8989

9090
## How It Works

docs/internal/developer/local-development/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,7 @@ make kind-down
109109

110110
**Quick Start:**
111111
```bash
112-
make dev-start
113-
# Access at https://vteam-frontend-vteam-dev.apps-crc.testing
112+
make local-up # Note: CRC dev-* targets have been replaced with local-* equivalents
114113
```
115114

116115
**Full Guide:** [crc.md](crc.md)
@@ -228,7 +227,7 @@ make test-e2e
228227
### Need OpenShift-Specific Features?
229228
Use **CRC** only if you need Routes, BuildConfigs, etc:
230229
```bash
231-
make dev-start # CRC-based
230+
make local-up # Local dev (minikube-based)
232231
```
233232

234233
### Need to Debug with Breakpoints?

docs/internal/developer/local-development/crc.md

Lines changed: 27 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ brew install crc
2727

2828
### 2. Start Development Environment
2929
```bash
30-
make dev-start
30+
make local-up
3131
```
3232
*First run: ~5-10 minutes. Subsequent runs: ~2-3 minutes.*
3333

@@ -38,37 +38,37 @@ make dev-start
3838

3939
### 4. Verify Everything Works
4040
```bash
41-
make dev-test # Should show 11/12 tests passing
41+
make local-test
4242
```
4343

4444
## Hot-Reloading Development
4545

4646
```bash
47-
# Terminal 1: Start with development mode
48-
DEV_MODE=true make dev-start
47+
# Start local environment
48+
make local-up
4949

50-
# Terminal 2: Enable file sync
51-
make dev-sync
50+
# Rebuild components after changes
51+
make local-rebuild
5252
```
5353

5454
## Essential Commands
5555

5656
```bash
5757
# Day-to-day workflow
58-
make dev-start # Start environment
59-
make dev-test # Run tests
60-
make dev-stop # Stop (keep CRC running)
61-
make dev-clean # Full cleanup
58+
make local-up # Start environment
59+
make local-test # Run tests
60+
make local-down # Stop (keep cluster running)
61+
make local-clean # Full cleanup
6262

6363
# Logs
64-
make dev-logs # All logs
65-
make dev-logs-backend # Backend only
66-
make dev-logs-frontend # Frontend only
67-
make dev-logs-operator # Operator only
68-
69-
# Operator management
70-
make dev-restart-operator # Restart operator
71-
make dev-operator-status # Check operator status
64+
make local-logs # All logs
65+
make local-logs-backend # Backend only
66+
make local-logs-frontend # Frontend only
67+
make local-logs-operator # Operator only
68+
69+
# Status and troubleshooting
70+
make local-status # Show status of local deployment
71+
make local-troubleshoot # Show troubleshooting information
7272
```
7373

7474
## Installation Details
@@ -115,7 +115,7 @@ sudo chmod +x /usr/local/bin/crc
115115
3. Download pull secret
116116
4. Save to `~/.crc/pull-secret.json`
117117

118-
The `make dev-start` script will automatically use this pull secret.
118+
The `make local-up` script will automatically use this pull secret.
119119

120120
## Features
121121

@@ -128,7 +128,7 @@ The `make dev-start` script will automatically use this pull secret.
128128

129129
### ✅ Development Workflow
130130
- Hot-reloading with `DEV_MODE=true`
131-
- File sync with `make dev-sync`
131+
- Rebuild with `make local-rebuild`
132132
- Quick operator restarts
133133
- Component-specific log viewing
134134

@@ -165,7 +165,7 @@ crc logs
165165

166166
# Reset if needed
167167
crc delete
168-
make dev-start
168+
make local-up
169169
```
170170

171171
### Pods Not Starting
@@ -216,29 +216,25 @@ crc config set memory 16384 # 16GB
216216
crc config set disk-size 100 # 100GB
217217

218218
# Then start
219-
make dev-start
219+
make local-up
220220
```
221221

222222
### Custom Registry
223223

224224
```bash
225225
# Use external registry instead of internal
226226
export CONTAINER_REGISTRY=quay.io/your-username
227-
make dev-start
227+
make local-up
228228
```
229229

230230
## Cleanup
231231

232232
```bash
233-
# Stop but keep CRC running
234-
make dev-stop
233+
# Stop but keep cluster running
234+
make local-down
235235

236-
# Stop and shutdown CRC
237-
make dev-stop-cluster
238-
239-
# Full cleanup (deletes CRC cluster)
240-
make dev-clean
241-
crc delete
236+
# Full cleanup (deletes cluster)
237+
make local-clean
242238
```
243239

244240
## See Also

0 commit comments

Comments
 (0)