Skip to content
Open
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions src/content/docs/local-development-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,32 @@ The Make targets create local infrastructure, build and load images, push module
]}
/>

## Dev containers

The repository ships one dev container profile per area, so a container installs only what your change needs. Pick it in VS Code with "Dev Containers: Reopen in Container", or under "Dev container configuration" in Codespaces; the full profile is the default.

<DocsSectionList
items={[
{
icon: "box",
label: "Component profiles",
text: "web, api, operator, agent, go-services, website, and modules: one area each.",
},
{
icon: "boxes",
label: "Part profiles",
text: "dashboard-api, control-plane, and modules-gp: a few areas plus kind for a live cluster.",
},
{
icon: "layers",
label: "Full profile",
text: "Everything, for cross-cutting changes.",
},
]}
/>

The [profile table in docs/contributing.md](https://github.com/GameplanePanel/Gameplane/blob/master/docs/contributing.md#dev-container-profiles) lists what each profile installs, its setup time, and when to use it. A Make target that needs a missing tool stops with a `need:` message naming the profile to reopen in.

## Debug the environment

Keep host and cluster registry addresses, kube context, namespaces, image tags, and Helm values aligned.
Expand Down
Loading