Skip to content

[Amber] Fix: update docs to reference kind targets instead of local-up #1102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −18
Open

[Amber] Fix: update docs to reference kind targets instead of local-up #1102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/internal/architecture/diagrams/component-structure.mmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ graph LR
end

subgraph "Development Commands"
LocalUp[make local-up<br/>🚀 Complete Stack]
LocalRebuild[make local-rebuild<br/>♻️ Rebuild & Reload]
KindUp[make kind-up<br/>🚀 Complete Stack]
KindRebuild[make kind-rebuild<br/>♻️ Rebuild & Reload]
Deploy[make deploy<br/>📦 Production]
BuildPush[make build-all push-all<br/>🏗️ Container Images]
end
Expand All @@ -36,11 +36,11 @@ graph LR
end

%% Development flow
LocalUp --> Local
KindUp --> Local
Local --> FrontendURL
Local --> BackendAPI
Local --> Console
LocalRebuild -.->|Rebuild & Reload| Local
KindRebuild -.->|Rebuild & Reload| Local

%% Production flow
BuildPush --> Prod
Expand All @@ -64,6 +64,6 @@ graph LR

class Frontend,Backend,Operator,Manifests component
class ClaudeRunner runner
class LocalUp,LocalRebuild,Deploy,BuildPush command
class KindUp,KindRebuild,Deploy,BuildPush command
class Local,Prod env
class FrontendURL,BackendAPI,Console access
12 changes: 6 additions & 6 deletions docs/internal/architecture/diagrams/deployment-stack.mmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ graph TD
subgraph "Local Development"
KIND[Kind]
CRC[OpenShift Local/CRC]
LocalUp[make local-up]
LocalRebuild[make local-rebuild<br/>♻️ Rebuild & Reload]
KindUp[make kind-up]
KindRebuild[make kind-rebuild<br/>♻️ Rebuild & Reload]
end

subgraph "Production"
Expand Down Expand Up @@ -83,9 +83,9 @@ graph TD
end

%% Relationships
LocalUp --> KIND
LocalUp --> CRC
LocalRebuild --> CRC
KindUp --> KIND
KindUp --> CRC
KindRebuild --> KIND
Copy link
Copy Markdown
Contributor

@ktdreyer ktdreyer Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some mix-ups here with CRC, because that's a totally different thing (different make target)

Copy link
Copy Markdown
Contributor

@ktdreyer ktdreyer Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sbauza clued me in today that we need to take a closer look at the make targets for CRC. We probably need dedicated make crc-* targets.

Copy link
Copy Markdown
Contributor

@ktdreyer ktdreyer Mar 31, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Filed #1116 for that.

ProdCmd --> OCP
ProdCmd --> K8sCluster

Expand Down Expand Up @@ -118,7 +118,7 @@ graph TD
classDef infra fill:#e9d5ff,stroke:#a855f7,stroke-width:2px,color:#581c87
classDef prereq fill:#fee2e2,stroke:#ef4444,stroke-width:2px,color:#7f1d1d

class KIND,CRC,LocalUp,LocalRebuild dev
class KIND,CRC,KindUp,KindRebuild dev
class OCP,K8sCluster,Registry,ProdCmd prod
class Next,Shadcn,TS1,React,TW,Go1,Gin,K8sClient,OIDC,Go2,OperatorSDK,Controller,Python,Claude,MCP,Playwright tech
class CRD,Jobs,Pods,Services,Routes,CR2,ConfigMaps,Secrets,PVC,OAuth,RBAC,SA,NetPol infra
Expand Down
9 changes: 4 additions & 5 deletions docs/internal/developer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ make lint
make test

# Test locally
make local-up
make kind-up
```

### 4. Submit PR
Expand All @@ -119,10 +119,9 @@ make build-backend # Build backend only

### Local Development
```bash
make local-up # Start local environment
make local-status # Check status
make local-logs # View logs
make local-down # Stop environment
make kind-up # Start local environment
make kind-status # Check status
make kind-down # Stop environment
```

### Testing
Expand Down
4 changes: 2 additions & 2 deletions docs/internal/developer/local-development/kind.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,8 +374,8 @@ lsof -i:8080 # Find what's using the port
**Fix:**
```bash
# Auto-detect and use native architecture
make local-clean
make local-up
make kind-down
make kind-up
```

**Diagnosis:** Run `make check-architecture` to verify native builds are enabled.
Expand Down
Loading