Add Phase 3 tutorials with audience targeting #94
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "feature/phase3-tutorials"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
Each tutorial explicitly identifies its target audiences and links to reference material rather than re-explaining concepts.
Deployment and Testing
🤖 Generated with Claude Code
@ -0,0 +76,4 @@2. Preview with `argocd app diff <service>`3. Deploy with `argocd app sync <service>`### Indri Service Changesinstead of these sections, make a "Mise Tasks" section and include a table detailing each mise task and when to use it. And by the way, skip the --check --diff pass on provision-indri, I want to skip that going forward, I'll remove it from CLAUDE.md soon
@ -0,0 +38,4 @@git clone ssh://git@forge.ops.eblu.me:2222/eblume/blumeops.gitcd blumeopsgit checkout -b feature/your-change-name```somewhere around here, include notes on installing homebrew, using Brewfile to install tools such as tea and mise (check that mise is in the brewfile please), and using mise to install language toolchains. Figure out how precommit is orchestrated here (I think it's in mise) and include that detail as well, with the result being that the dev should be able to run pre-commit now and have it pass on a fresh clone.
@ -0,0 +77,4 @@For Kubernetes changes:```bash# Preview what will changeargocd app diff <service>the dev will need to set target revisions for their app, and for the app-of-apps if it's a new app.
@ -0,0 +84,4 @@```bash# Dry runmise run provision-indri -- --check --diff --tags <role>```Include pulumi preview for DNS changes here. There's a mise task for it.
@ -0,0 +114,4 @@Erich will review your PR and may leave comments. Check for feedback:```bashmise run pr-comments <pr_number>this is intended for AI, skip it in this tutorial.
@ -0,0 +140,4 @@## Getting Help- Browse [[reference/index|Reference]] for technical details- Check `CLAUDE.md` in the repo for rules and conventionsnope, ai only
@ -0,0 +5,4 @@- getting-started---# Exploring the Documentationlet's update the root index.md to link directly to this tutorial, it's a great entry point for people fresh to the docs
@ -0,0 +19,4 @@|---------|---------|-------------|| **[[tutorials/index | Tutorials]]** | Learning-oriented | "I'm new and want to understand" || **[[reference/index | Reference]]** | Information-oriented | "I need specific technical details" || **How-to** (planned) | Task-oriented | "I need to do X" |please update docs/README.md phase plans to include a note to return to this tutorial with updates
@ -0,0 +50,4 @@Getting started with changes:- [[contributing]] walks through the workflow- [[reference/index|Reference]] tells you where things live- The `CLAUDE.md` in the repo root has contribution rulesnope, only for ai
@ -0,0 +52,4 @@- [[reference/index|Reference]] tells you where things live- The `CLAUDE.md` in the repo root has contribution rules### For ReplicatorsInclude like a sentence here explaining what a replicator is in this context
@ -0,0 +64,4 @@Documentation uses `[[wiki-links]]` for cross-references:- `[[service-name]]` links to a reference page- `[[folder/page]]` links to nested pages- `[[page|Display Text]]` customizes the link textInclude a note here that pre-commit will automatically check that links are correct and unambiguous.
@ -0,0 +26,4 @@| Component | BlumeOps Uses | Minimum Alternative ||-----------|---------------|---------------------|| **Server** | Mac Mini M1 | Any machine with 16GB RAM |honestly you dont even need that although I wouldn't recommend less. Maybe just "sufficient RAM (16GB recommended)"
@ -0,0 +45,4 @@This replaces: traditional VPNs, port forwarding, dynamic DNS### Phase 2: Kubernetes ClusterI think there needs to be a phase prior to this with its own tutorial, "core services", which should be where forgejo and zot are configured, although zot is technically optional. I mean forgejo is also optional but it's really a central idea: forgejo is the tool we use to bootstrap the gitops. I'm going to guess forgejo gets discussed later in this or other tutorials, so that'll need to be moved around.
@ -0,0 +80,4 @@Without observability, you're flying blind.### Phase 5: Your First ServicesWe should include quartz docs in this list. Do we have a service card for docs? We should add one if not.
@ -0,0 +46,4 @@For Tailscale access:```bashtailscale serve --bg --https 8443 https+insecure://localhost:$(kubectl -n argocd get svc argocd-server -o jsonpath='{.spec.ports[?(@.name=="https")].port}')mmm nope there is an ansible role for this. Oh wow come to think of it we might not have any reference material for ansible roles yet! Start a section for it and link to it here.
@ -0,0 +49,4 @@tailscale serve --bg --https 8443 https+insecure://localhost:$(kubectl -n argocd get svc argocd-server -o jsonpath='{.spec.ports[?(@.name=="https")].port}')```Or create a Tailscale Ingress in Kubernetes.ah, there needs to be a reference card for the tailscale k8s operator as well, and link to it from reference/kubernetes/apps (and here).
@ -0,0 +56,4 @@### Install the CLI```bashbrew install argocd # macOSactually maybe just refer to the fact that blumeops contains a Brewfile with argocd, or they can install it any other way
@ -0,0 +131,4 @@Expose via Tailscale:```bashkubectl -n monitoring port-forward svc/grafana 3000:80 &tailscale serve --bg --https 3000 http://localhost:3000ansible role
@ -0,0 +1,67 @@---title: what-is-blumeopsActually this entire tutorial should be a an Explanation instead. Remove it. Replace it with a tutorial on how to add an argocd-managed service, including all the important steps like setting up the ingress and the homepage annotations and grafana dashboards, etc.