Skip to content

Commit 90c61c3

Browse files
Copilotchefgs
Copilot
and
chefgs
committed
docs: document process-first CLI option across all guides and add PROCESS-FIRST.md
Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
1 parent 222cca3 commit 90c61c3

6 files changed

Lines changed: 287 additions & 0 deletions

File tree

‎README-INDEX.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Welcome to the DevOps-OS documentation! This set of guides will help you use and
99
| [**CLI Commands Reference**](docs/CLI-COMMANDS-REFERENCE.md) | **Complete reference** — every option, input file, and output location for all CLI commands |
1010
| [Getting Started](docs/GETTING-STARTED.md) | First pipeline in 5 minutes |
1111
| [Quick Start Guide](docs/DEVOPS-OS-QUICKSTART.md) | Essential CLI commands for all functionality |
12+
| [Process-First Philosophy](docs/PROCESS-FIRST.md) | What Process-First means, how it maps to DevOps-OS, and AI learning tips for beginners |
1213
| [GitHub Actions Generator](docs/GITHUB-ACTIONS-README.md) | Generate and customize GitHub Actions workflows |
1314
| [GitLab CI Generator](docs/GITLAB-CI-README.md) | Generate and customize GitLab CI pipelines |
1415
| [Jenkins Pipeline Generator](docs/JENKINS-PIPELINE-README.md) | Generate and customize Jenkins pipelines |

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ DevOps-OS is an open-source DevOps automation platform that scaffolds production
2929
| 📊 **SRE Config Generator** | Prometheus alert rules, Grafana dashboards, and SLO manifests |
3030
| 🤖 **MCP Server** | Plug DevOps-OS tools into Claude or ChatGPT as native AI skills |
3131
| 🛠️ **Dev Container** | Pre-configured multi-language environment (Python · Java · Go · JavaScript) |
32+
| 🔄 **Process-First** | Built-in education on the Process-First SDLC philosophy and how it maps to every DevOps-OS tool |
3233

3334
---
3435

@@ -137,6 +138,12 @@ python -m cli.devopsos scaffold jenkins # scaffold Jenkins
137138
python -m cli.devopsos scaffold argocd # scaffold ArgoCD / Flux
138139
python -m cli.devopsos scaffold sre # scaffold SRE configs
139140
python -m cli.devopsos scaffold devcontainer # scaffold dev container config
141+
142+
# Learn the Process-First philosophy and how it maps to DevOps-OS tooling
143+
python -m cli.devopsos process-first # full overview
144+
python -m cli.devopsos process-first --section what # ideology & core principles
145+
python -m cli.devopsos process-first --section mapping # principle → tool mapping
146+
python -m cli.devopsos process-first --section tips # AI prompts for beginners
140147
```
141148

142149
### 5 — Use with AI (MCP Server)
@@ -239,6 +246,7 @@ You can also customize `.devcontainer/devcontainer.env.json` directly to enable
239246
|-------|-------------|
240247
| [🚀 Getting Started](docs/GETTING-STARTED.md) | Easy step-by-step guide — **start here** |
241248
| [📖 CLI Commands Reference](docs/CLI-COMMANDS-REFERENCE.md) | **Complete reference** — every option, input file, and output location |
249+
| [🔄 Process-First Philosophy](docs/PROCESS-FIRST.md) | What Process-First means, how it maps to DevOps-OS, and AI learning tips |
242250
| [📦 Dev Container Setup](docs/DEVOPS-OS-README.md) | Set up and customize the dev container |
243251
| [⚡ Quick Start Reference](docs/DEVOPS-OS-QUICKSTART.md) | Essential CLI commands for all features |
244252
| [⚙️ GitHub Actions Generator](docs/GITHUB-ACTIONS-README.md) | Generate and customize GitHub Actions workflows |

‎docs/CLI-COMMANDS-REFERENCE.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ For each command you will find the **complete option table**, the **input files*
1616
- [scaffold_sre — SRE Config Generator](#scaffold_sre--sre-config-generator)
1717
- [scaffold_devcontainer — Dev Container Generator](#scaffold_devcontainer--dev-container-generator)
1818
- [devopsos — Unified CLI](#devopsos--unified-cli)
19+
- [process-first — Process-First Philosophy](#process-first--process-first-philosophy)
1920
- [Environment Variable Reference](#environment-variable-reference)
2021
- [Input File Formats](#input-file-formats)
2122

@@ -45,6 +46,7 @@ pip install -r cli/requirements.txt
4546
| SRE configs | `python -m cli.scaffold_sre` | `sre/` directory |
4647
| Dev Container | `python -m cli.scaffold_devcontainer` | `.devcontainer/` directory |
4748
| Interactive wizard | `python -m cli.devopsos` | varies (see below) |
49+
| Process-First | `python -m cli.devopsos process-first` | stdout (educational content) |
4850

4951
All generators also accept environment variables as an alternative to flags —
5052
see [Environment Variable Reference](#environment-variable-reference).
@@ -527,6 +529,7 @@ python -m cli.devopsos COMMAND [options]
527529
|---------|-------------|
528530
| `init` | Interactive wizard to select tools/languages and optionally generate dev container files |
529531
| `scaffold TARGET` | Non-interactive generator (delegates to the corresponding `scaffold_*` module) |
532+
| `process-first` | Display the Process-First SDLC philosophy, tooling map, and beginner learning tips |
530533

531534
### `devopsos init`
532535

@@ -561,6 +564,74 @@ python -m cli.devopsos scaffold sre # uses DEVOPS_OS_SRE_* env vars
561564
python -m cli.devopsos scaffold devcontainer
562565
```
563566

567+
### `devopsos process-first`
568+
569+
Prints educational content about the **Process-First** SDLC philosophy used by [cloudenginelabs.io](https://cloudenginelabs.io) and shows exactly how each principle maps to DevOps-OS tooling.
570+
571+
| Option | Default | Description |
572+
|--------|---------|-------------|
573+
| `--section SECTION` | `all` | Section to display: `what` \| `mapping` \| `tips` \| `all` |
574+
575+
| Section | Content |
576+
|---------|---------|
577+
| `what` | What Process-First is and its 5 core principles |
578+
| `mapping` | Table mapping each principle to a specific `devopsos scaffold` command |
579+
| `tips` | AI prompts and book recommendations for DevOps beginners |
580+
| `all` *(default)* | All sections in order |
581+
582+
```bash
583+
# Full overview (all sections)
584+
python -m cli.devopsos process-first
585+
586+
# Ideology & core principles only
587+
python -m cli.devopsos process-first --section what
588+
589+
# Principle → DevOps-OS tooling map
590+
python -m cli.devopsos process-first --section mapping
591+
592+
# AI learning tips for beginners
593+
python -m cli.devopsos process-first --section tips
594+
595+
# Run the module directly (same output)
596+
python -m cli.process_first
597+
python -m cli.process_first --section mapping
598+
```
599+
600+
**When to use this command:**
601+
602+
- **Onboarding new engineers** — run `process-first` before introducing any other `scaffold` command so they understand *why* before *how*.
603+
- **Team workshops** — show the `--section mapping` table to demonstrate which DevOps-OS tool encodes which SDLC process.
604+
- **Self-study** — the `--section tips` output contains copy-paste AI prompts that let any beginner explore CI/CD, GitOps, and SRE concepts in depth.
605+
606+
---
607+
608+
## process-first — Process-First Philosophy
609+
610+
The `process-first` command is also available as a standalone module.
611+
612+
### Invocation
613+
614+
```bash
615+
python -m cli.process_first [--section SECTION]
616+
```
617+
618+
### Options
619+
620+
| Option | Default | Description |
621+
|--------|---------|-------------|
622+
| `--section SECTION` | `all` | Which section to display: `what` \| `mapping` \| `tips` \| `all` |
623+
624+
### Output
625+
626+
Prints formatted text to **stdout** — no files are created.
627+
628+
| Section | What it covers |
629+
|---------|---------------|
630+
| `what` | The Process-First philosophy: define before build, standardise before scale, automate the repeatable, observe and iterate, culture over tooling |
631+
| `mapping` | A table mapping each of the 5 principles to the corresponding `devopsos scaffold` sub-command |
632+
| `tips` | Ready-to-paste AI prompts (Claude / ChatGPT / Gemini) for deepening DevOps knowledge, plus book recommendations |
633+
| `all` | All three sections combined (default) |
634+
564635
---
565636

566637
## Environment Variable Reference
@@ -679,6 +750,7 @@ Accepted by `scaffold_gha`, `scaffold_jenkins`, and `scaffold_gitlab` via `--cus
679750
| Topic | Document |
680751
|-------|---------|
681752
| Getting started (first pipeline in 5 min) | [GETTING-STARTED.md](GETTING-STARTED.md) |
753+
| Process-First philosophy & tooling map | [PROCESS-FIRST.md](PROCESS-FIRST.md) |
682754
| GitHub Actions deep dive | [GITHUB-ACTIONS-README.md](GITHUB-ACTIONS-README.md) |
683755
| GitLab CI deep dive | [GITLAB-CI-README.md](GITLAB-CI-README.md) |
684756
| Jenkins deep dive | [JENKINS-PIPELINE-README.md](JENKINS-PIPELINE-README.md) |

‎docs/DEVOPS-OS-QUICKSTART.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This guide provides the essential CLI commands for using all functionalities of
66
77
## Table of Contents
88
- [Setting Up DevOps-OS](#setting-up-devops-os)
9+
- [Process-First Philosophy](#process-first-philosophy)
910
- [GitHub Actions Workflows](#github-actions-workflows)
1011
- [GitLab CI Pipelines](#gitlab-ci-pipelines)
1112
- [Jenkins Pipelines](#jenkins-pipelines)
@@ -64,6 +65,38 @@ code .
6465
# Then use Command Palette (Cmd+Shift+P): "Remote-Containers: Reopen in Container"
6566
```
6667

68+
## Process-First Philosophy
69+
70+
**CloudEngineLabs** ([cloudenginelabs.io](https://cloudenginelabs.io)) is a **Process-First** SDLC automation company. Before running any scaffold command,
71+
use the `process-first` CLI option to understand the philosophy behind DevOps-OS and how it drives
72+
every tool in this project.
73+
74+
```bash
75+
# Full overview — ideology, tooling map, and beginner tips
76+
python -m cli.devopsos process-first
77+
78+
# What is Process-First? (core principles)
79+
python -m cli.devopsos process-first --section what
80+
81+
# How each principle maps to a DevOps-OS scaffold command
82+
python -m cli.devopsos process-first --section mapping
83+
84+
# AI prompts and book recommendations for DevOps beginners
85+
python -m cli.devopsos process-first --section tips
86+
```
87+
88+
### Where does process-first help?
89+
90+
| When you are… | Run |
91+
|---------------|-----|
92+
| New to DevOps-OS | `process-first` — understand *why* before *how* |
93+
| Onboarding a team | `process-first --section mapping` — show how each scaffold encodes a process |
94+
| Learning DevOps from scratch | `process-first --section tips` — get AI prompts to study CI/CD, GitOps, and SRE |
95+
| Choosing which scaffold to run first | `process-first --section what` — align on the 5 core principles first |
96+
97+
> **Tip:** Run `process-first --section mapping` alongside `scaffold` commands to see exactly which
98+
> Process-First principle each generated artefact satisfies.
99+
67100
## GitHub Actions Workflows
68101

69102
### Generate GitHub Actions Workflows

‎docs/GETTING-STARTED.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,23 @@ python -m cli.devopsos scaffold argocd
176176
python -m cli.devopsos scaffold sre
177177
```
178178

179+
### Learn the Process-First philosophy
180+
181+
Before running any scaffold command, it helps to understand *why* you are building the process that way.
182+
Run the `process-first` command to read the Process-First SDLC philosophy from cloudenginelabs.io,
183+
see how each principle maps directly to a DevOps-OS tool, and get AI prompts for going deeper:
184+
185+
```bash
186+
# Full overview — what Process-First is, the tooling map, and beginner tips
187+
python -m cli.devopsos process-first
188+
189+
# Focus on the principle → tool mapping
190+
python -m cli.devopsos process-first --section mapping
191+
192+
# AI prompts and book recommendations for beginners
193+
python -m cli.devopsos process-first --section tips
194+
```
195+
179196
---
180197

181198
## 6 — Use with an AI assistant
@@ -254,6 +271,7 @@ A: Copy the generated file(s) to your project repository, commit, and push. No f
254271

255272
| I want to… | Read |
256273
|-----------|------|
274+
| Understand why DevOps-OS is Process-First | [PROCESS-FIRST.md](PROCESS-FIRST.md) |
257275
| See every option and output path | [CLI-COMMANDS-REFERENCE.md](CLI-COMMANDS-REFERENCE.md) |
258276
| Deep-dive GitHub Actions options | [GITHUB-ACTIONS-README.md](GITHUB-ACTIONS-README.md) |
259277
| Deep-dive GitLab CI options | [GITLAB-CI-README.md](GITLAB-CI-README.md) |

‎docs/PROCESS-FIRST.md‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
# Process-First Philosophy — DevOps-OS
2+
3+
> *"Tools are only as good as the processes that govern them."*
4+
> — Saravanan Gnanagur, Founder, CloudEngineLabs
5+
6+
---
7+
8+
## What is Process-First?
9+
10+
[cloudenginelabs.io](https://cloudenginelabs.io) is a **Process-First SDLC automation company**.
11+
Process-First is an engineering philosophy that places well-defined, repeatable
12+
Software Development Life Cycle (SDLC) processes at the centre of every engineering
13+
decision — before selecting tools, platforms, or frameworks.
14+
15+
The guiding question is always: **"Do we have the right process before we pick the tool?"**
16+
17+
---
18+
19+
## The 5 Core Principles
20+
21+
| # | Principle | What it means in practice |
22+
|---|-----------|--------------------------|
23+
| 1 | **Define before you Build** | Document the "why" and "what" of every workflow before writing a single line of pipeline code. |
24+
| 2 | **Standardise before you Scale** | Create golden-path templates (CI/CD, GitOps, SRE) that every team can adopt without reinventing the wheel. |
25+
| 3 | **Automate what is Repeatable** | If a process is done more than twice, automate it. Automation should *encode* the process, not bypass it. |
26+
| 4 | **Observe and Iterate** | Every automated process must produce measurable outcomes (SLOs, SLAs, error budgets) so teams can improve continuously. |
27+
| 5 | **Culture over Tooling** | Processes create shared understanding and accountability. The right culture makes any toolchain succeed; the wrong culture makes the best toolchain fail. |
28+
29+
---
30+
31+
## How Process-First Maps to DevOps-OS Tooling
32+
33+
Each `devopsos scaffold` command encodes one or more Process-First principles into an
34+
immediately usable configuration artefact:
35+
36+
| Process-First Principle | DevOps-OS Command | What it generates |
37+
|-------------------------|-------------------|-------------------|
38+
| **Define before you Build** | `devopsos scaffold cicd` / `gha` / `gitlab` | Interactive wizards capture intent before generating any config file |
39+
| **Standardise before Scale** | `devopsos scaffold gha`, `gitlab`, `jenkins` | Golden-path templates for GitHub Actions, GitLab CI, and Jenkins — reviewed baselines every team can adopt |
40+
| **Automate the Repeatable** | `devopsos scaffold argocd` | GitOps sync process encoded as an ArgoCD `Application` + `AppProject` CR |
41+
| **Automate the Repeatable** | `devopsos scaffold devcontainer` | Developer environment setup encoded as `devcontainer.json` — reproducible for every team member |
42+
| **Observe and Iterate** | `devopsos scaffold sre` | Prometheus alert rules, Grafana dashboards, and SLO manifests — close the measure-improve feedback loop |
43+
| **Culture over Tooling** | `devopsos` MCP server skills | AI assistants (Claude, ChatGPT) coach engineers on DevOps best practices, not just generate config files |
44+
45+
---
46+
47+
## The `process-first` CLI Command
48+
49+
DevOps-OS ships a built-in `process-first` command to surface this philosophy
50+
interactively in your terminal.
51+
52+
### Usage
53+
54+
```bash
55+
# Full overview (default)
56+
python -m cli.devopsos process-first
57+
58+
# Section: what Process-First is and the 5 core principles
59+
python -m cli.devopsos process-first --section what
60+
61+
# Section: how each principle maps to a DevOps-OS scaffold command
62+
python -m cli.devopsos process-first --section mapping
63+
64+
# Section: AI prompts and reading recommendations for beginners
65+
python -m cli.devopsos process-first --section tips
66+
```
67+
68+
You can also invoke the module directly:
69+
70+
```bash
71+
python -m cli.process_first
72+
python -m cli.process_first --section mapping
73+
```
74+
75+
### Options
76+
77+
| Option | Default | Description |
78+
|--------|---------|-------------|
79+
| `--section` | `all` | `what` · `mapping` · `tips` · `all` |
80+
81+
### Where does this command help?
82+
83+
| Situation | Recommended section |
84+
|-----------|---------------------|
85+
| New team member onboarding | `all` — read the full overview first |
86+
| Pre-sprint process alignment meeting | `mapping` — show how each scaffold encodes a principle |
87+
| Self-study / learning DevOps from scratch | `tips` — use the AI prompts to go deep |
88+
| Quick philosophy refresh | `what` — re-read the 5 core principles |
89+
90+
---
91+
92+
## Tips for DevOps Beginners — Learn More with AI Tools
93+
94+
Use AI tools like **Claude**, **ChatGPT**, or **Gemini** to deepen your understanding of
95+
Process-First DevOps. Here are prompts you can try right now:
96+
97+
### Understanding the ideology
98+
99+
> "Explain the process-first approach to SDLC automation and why defining processes before
100+
> choosing tools leads to better outcomes."
101+
102+
### CI/CD pipelines
103+
104+
> "What are the key stages of a production-grade CI/CD pipeline? Give me a process checklist
105+
> before I start writing any pipeline code."
106+
107+
### GitOps and ArgoCD
108+
109+
> "Walk me through the GitOps process: from code commit to production deployment using ArgoCD.
110+
> What processes must exist before ArgoCD adds value?"
111+
112+
### SRE fundamentals
113+
114+
> "What is the SRE process for setting SLOs and error budgets? How do I translate business
115+
> requirements into Prometheus alert rules?"
116+
117+
### Dev Containers
118+
119+
> "What developer-environment standardisation process should a team follow before adopting
120+
> Dev Containers?"
121+
122+
### Using DevOps-OS with AI
123+
124+
Install the DevOps-OS MCP server, connect it to Claude or ChatGPT, and ask:
125+
126+
> "Using the DevOps-OS tools, scaffold a process-first CI/CD setup for a Python microservice
127+
> with GitOps delivery and SRE observability."
128+
129+
See [mcp_server/README.md](../mcp_server/README.md) for setup instructions.
130+
131+
---
132+
133+
## Further Reading
134+
135+
| Resource | Where |
136+
|----------|-------|
137+
| *The DevOps Handbook* — Gene Kim et al. | Your preferred book retailer |
138+
| *Site Reliability Engineering* — Google SRE book | [sre.google/books](https://sre.google/books) |
139+
| *Accelerate* — Nicole Forsgren et al. | Your preferred book retailer |
140+
| Saravanan Gnanagur on LinkedIn | Search **"Saravanan Gnanagur process first"** on [LinkedIn](https://www.linkedin.com) |
141+
142+
---
143+
144+
## Related Documentation
145+
146+
| Topic | Document |
147+
|-------|---------|
148+
| Full CLI reference | [CLI-COMMANDS-REFERENCE.md](CLI-COMMANDS-REFERENCE.md) |
149+
| Getting started (first pipeline in 5 min) | [GETTING-STARTED.md](GETTING-STARTED.md) |
150+
| GitHub Actions deep dive | [GITHUB-ACTIONS-README.md](GITHUB-ACTIONS-README.md) |
151+
| GitLab CI deep dive | [GITLAB-CI-README.md](GITLAB-CI-README.md) |
152+
| Jenkins deep dive | [JENKINS-PIPELINE-README.md](JENKINS-PIPELINE-README.md) |
153+
| ArgoCD / Flux deep dive | [ARGOCD-README.md](ARGOCD-README.md) |
154+
| SRE configuration deep dive | [SRE-CONFIGURATION-README.md](SRE-CONFIGURATION-README.md) |
155+
| MCP server (AI integration) | [../mcp_server/README.md](../mcp_server/README.md) |

0 commit comments

Comments
 (0)