Skip to content

Commit e23076e

Browse files
committed
fix: nav_order conflict, profile count, Docker Compose prereq, inert wording
1 parent c501256 commit e23076e

3 files changed

Lines changed: 6 additions & 5 deletions

File tree

Index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ A Kubernetes-native Go microservice framework for building production-grade gRPC
4040
| **Container-aware Runtime** | Auto-tunes GOMAXPROCS to match container CPU limits via [automaxprocs] |
4141
| **Request Validation** | [Protovalidate] annotations enforced automatically on both gRPC and HTTP requests — define validation rules in your proto, get `InvalidArgument` errors for free |
4242
| **CI/CD Pipelines** | Ready-to-use [GitHub Actions] and [GitLab CI] workflows for build, test, lint, coverage, and benchmarks |
43-
| **Local Dev Stack** | Docker Compose with 20+ per-service profiles (databases, caches, brokers, AWS/GCP emulators) — `make local-stack` starts your selection, `make local-stack-obs` adds [Prometheus], [Grafana], [Jaeger] |
43+
| **Local Dev Stack** | Docker Compose with 19 services across 18 profiles + `obs` group (databases, caches, brokers, AWS/GCP emulators) — `make local-stack` starts your selection, `make local-stack-obs` adds [Prometheus], [Grafana], [Jaeger] |
4444
| **Application Metrics** | Interface-based metrics package with [promauto] registration — counter and histogram examples wired into handlers |
4545
| **Load Testing** | [ghz] gRPC load test config with `make loadtest` — results visible in Grafana dashboard when running with `make local-stack-obs` |
4646

howto/local-dev.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: "Local Development"
44
parent: "How To"
5-
nav_order: 16
5+
nav_order: 17
66
description: "Docker Compose local dev stack with per-service profiles for databases, caches, message brokers, AWS/GCP emulators, and observability"
77
---
88
## Table of contents
@@ -13,7 +13,7 @@ description: "Docker Compose local dev stack with per-service profiles for datab
1313

1414
## Overview
1515

16-
Projects generated from the [ColdBrew cookiecutter] include a `docker-compose.local.yml` with 20 infrastructure services, each behind its own [Docker Compose profile](https://docs.docker.com/compose/how-tos/profiles/). You select which services to start — only those containers run.
16+
Projects generated from the [ColdBrew cookiecutter] include a `docker-compose.local.yml` with 19 infrastructure services across 18 individual profiles plus one group profile (`obs` for Prometheus + Grafana + Jaeger). You select which profiles to start — only those containers run.
1717

1818
Your app runs natively via `make run` (fast builds, no Docker overhead). The compose stack provides only infrastructure dependencies.
1919

@@ -154,7 +154,7 @@ make local-stack PROFILES="postgres mongodb nats"
154154

155155
### Disabling docker-compose entirely
156156

157-
During project generation, set `include_docker_compose` to `n`. The post-gen hook removes `docker-compose.local.yml` and `deploy/`. Makefile targets remain but are inert (docker-compose errors clearly when the file is missing).
157+
During project generation, set `include_docker_compose` to `n`. The post-gen hook removes `docker-compose.local.yml` and `deploy/`. Makefile targets remain but will error with "no configuration file provided" if invoked — this is expected and serves as a clear signal to remove or ignore them.
158158

159159
## Grafana Dashboard
160160

quickstart.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Before you begin, install:
2323
- **[Go 1.25+](https://go.dev/dl/)**`go version` should show 1.25 or later
2424
- **[cookiecutter](https://cookiecutter.readthedocs.io/)**`brew install cookiecutter` or `pip install cookiecutter`
2525
- **[buf](https://buf.build/docs/installation)** — for protobuf code generation
26+
- **[Docker Compose](https://docs.docker.com/compose/install/)** — for the local dev stack (Step 7). Works with Docker Desktop, Colima, or any OCI runtime
2627

2728
## Step 1: Generate Your Project
2829

@@ -314,7 +315,7 @@ make local-exec SVC=postgres CMD="psql -U postgres" # Exec into any service
314315
Open [http://localhost:3000](http://localhost:3000) (Grafana, admin/admin) and [http://localhost:16686](http://localhost:16686) (Jaeger) to see metrics and traces in real-time.
315316

316317
{: .note }
317-
The local stack is infra-only — your app runs natively via `make run` for fast iteration. Use `make local-stack-down` to stop everything. See the [Local Development How-To](/howto/local-dev/) for all 20 profiles, connection strings, Grafana dashboard customization, and troubleshooting.
318+
The local stack is infra-only — your app runs natively via `make run` for fast iteration. Use `make local-stack-down` to stop everything. See the [Local Development How-To](/howto/local-dev/) for all available profiles, connection strings, Grafana dashboard customization, and troubleshooting.
318319

319320
## Step 8: Run in Docker
320321

0 commit comments

Comments
 (0)