Skip to content

docs: comprehensive documentation overhaul #42

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

Merged
ian-flores merged 1 commit into from
Jan 15, 2026
Merged

docs: comprehensive documentation overhaul #42

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
8 changes: 6 additions & 2 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@ on:
branches:
- main
paths-ignore:
- '*.md'
- '**/*.md'
- 'docs/**'
- '.claude/**'
- 'LICENSE'
pull_request:
paths-ignore:
- '*.md'
- '**/*.md'
- 'docs/**'
- '.claude/**'
- 'LICENSE'

permissions:
actions: write
Expand Down
28 changes: 18 additions & 10 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,34 @@ Kubernetes operator for managing Posit Team deployments.

## Project Structure

- **`api/`**: Kubernetes API/CRD definitions
- **`api/`**: Kubernetes API/CRD definitions (core, product, keycloak, templates)
- **`cmd/`**: Main operator entry point
- **`internal/`**: Core operator logic and controllers
- **`config/`**: Kubernetes manifests and Kustomize configurations
- **`dist/chart/`**: Helm chart for deployment
- **`flightdeck/`**: Landing page dashboard component
- **`flightdeck/`**: Landing page dashboard component (separate Go module)
- **`client-go/`**: Generated Kubernetes client code
- **`pkg/`**: Shared packages
- **`docs/`**: User and contributor documentation

## Build and Development

```bash
just build # Build operator binary
just test # Run tests
just run # Run operator locally
just format # Format code
just build # Build operator binary to ./bin/team-operator
just test # Run go tests
just run # Run operator locally from source
just deps # Install dependencies
just mgenerate # Regenerate manifests after API changes
just helm-lint # Lint Helm chart
just helm-template # Render Helm templates
just helm-template # Render Helm templates locally
just helm-install # Install operator via Helm
just helm-uninstall # Uninstall operator via Helm
```

## Namespaces

- **`posit-team-system`**: Where the operator runs
- **`posit-team`**: Where Site CRs and products are deployed

## Helm Installation

```bash
Expand All @@ -35,8 +43,8 @@ helm install team-operator ./dist/chart \
## Contributing

- Use conventional commits (`feat:`, `fix:`, `docs:`, etc.)
- Run `just format` before committing
- Ensure tests pass with `just test`
- Run `just test` before committing
- See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines

## License

Expand Down
Loading