Address PR review feedback for Phase 3 tutorials
Tutorial changes: - Replace what-is-blumeops with adding-a-service tutorial - Update ai-assistance-guide with Mise Tasks table - Update contributing with tooling setup, target revisions, DNS preview - Remove AI-only sections from contributing and exploring-the-docs - Add replicator explanation to exploring-the-docs - Add pre-commit link validation note - Add Core Services phase to replication roadmap - Add docs service to services list in replicating-blumeops New reference cards: - docs.md - Quartz documentation service - tailscale-operator.md - Kubernetes ingress operator - ansible/roles.md - Available ansible roles Other updates: - Add mise to Brewfile - Update docs/index.md to link to exploring-the-docs - Add notes to update exploring-the-docs in future phases - Link tailscale-operator from apps.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
parent
50046f42f8
commit
1e4e72b923
18 changed files with 620 additions and 120 deletions
|
|
@ -16,7 +16,40 @@ This tutorial walks through making your first contribution to BluemeOps - from u
|
|||
Before contributing, you'll need:
|
||||
- Access to the [[tailscale|Tailscale]] network (request from Erich)
|
||||
- SSH key added to [[forgejo|Forgejo]] (https://forge.ops.eblu.me)
|
||||
- `tea` CLI installed for PR creation
|
||||
- Development tools installed (see below)
|
||||
|
||||
## Tooling Setup
|
||||
|
||||
The repo includes a `Brewfile` and `mise.toml` for easy setup, but these are optional - install the tools however you prefer.
|
||||
|
||||
### Required Tools
|
||||
|
||||
- `tea` - Gitea/Forgejo CLI for creating PRs
|
||||
- `argocd` - ArgoCD CLI for deployments
|
||||
- `pre-commit` - Git hooks for validation
|
||||
|
||||
### Using Brewfile (Optional)
|
||||
|
||||
```bash
|
||||
brew bundle # installs tea, argocd, mise, etc.
|
||||
```
|
||||
|
||||
### Using Mise (Optional)
|
||||
|
||||
Mise manages language toolchains and runs tasks:
|
||||
```bash
|
||||
mise install # installs Python, Node.js, etc. from mise.toml
|
||||
```
|
||||
|
||||
### Pre-commit Hooks
|
||||
|
||||
Pre-commit hooks validate changes on `git commit`:
|
||||
```bash
|
||||
pre-commit install
|
||||
pre-commit run --all-files # verify setup
|
||||
```
|
||||
|
||||
All hooks should pass on a fresh clone.
|
||||
|
||||
## Understanding the Codebase
|
||||
|
||||
|
|
@ -47,6 +80,8 @@ Depending on what you're changing:
|
|||
**For Kubernetes services:**
|
||||
- Edit manifests in `argocd/manifests/<service>/`
|
||||
- Or create new Application in `argocd/apps/`
|
||||
- For new apps, set `targetRevision` to your feature branch for testing
|
||||
- For existing apps, you'll need to temporarily change the revision via `argocd app set`
|
||||
|
||||
**For Indri services:**
|
||||
- Edit or create roles in `ansible/roles/`
|
||||
|
|
@ -80,10 +115,9 @@ For Kubernetes changes:
|
|||
argocd app diff <service>
|
||||
```
|
||||
|
||||
For Ansible changes:
|
||||
For DNS changes:
|
||||
```bash
|
||||
# Dry run
|
||||
mise run provision-indri -- --check --diff --tags <role>
|
||||
mise run dns-preview
|
||||
```
|
||||
|
||||
### 5. Commit and Push
|
||||
|
|
@ -137,13 +171,7 @@ annotations:
|
|||
```
|
||||
3. Create PR and wait for sync
|
||||
|
||||
## Getting Help
|
||||
|
||||
- Browse [[reference/index|Reference]] for technical details
|
||||
- Check `CLAUDE.md` in the repo for rules and conventions
|
||||
- Ask Erich directly (he's friendly)
|
||||
|
||||
## Related
|
||||
|
||||
- [[ai-assistance-guide]] - If using AI assistance for contributions
|
||||
- [[adding-a-service]] - Full tutorial on deploying a new service
|
||||
- [[replicating-blumeops]] - If you want to build your own instead
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue