Skip to content

Commit 8db1506

Browse files
Copilotchefgs
Copilot
and
chefgs
committed
docs: add process-first command to Hugo GitHub Pages documentation
- New page: hugo-docs/content/docs/getting-started/process-first.md Full Process-First guide: command usage, --section options table, 5 core principles, principle→scaffold mapping table, when-to-use scenarios, AI prompts, and further reading links. - CLI Reference (_index.md): added process-first to command overview table and expanded devopsos section with full process-first command documentation including --section option table. - Getting Started (_index.md): added step 2 "Learn the Process-First philosophy" with all four invocation examples; renumbered steps 3–7; added Process-First to Next Steps table. - Quick Start Reference (quickstart.md): added Process-First Philosophy section before GitHub Actions; added process-first --help to Troubleshooting section. - Home page (_index.md): added Process-First to features table; added step 2 in Quick Start code block; added Process-First to docs table. Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
1 parent 88d7ccc commit 8db1506

5 files changed

Lines changed: 216 additions & 9 deletions

File tree

‎hugo-docs/content/_index.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ DevOps-OS is an open-source DevOps automation platform that scaffolds production
2626
| 📊 | **SRE Config Generator** | Prometheus alert rules, Grafana dashboards, and SLO manifests — [→ SRE Configuration]({{< relref "/docs/sre" >}}) |
2727
| 🤖 | **MCP Server** | Plug DevOps-OS tools into Claude or ChatGPT as native AI skills — [→ AI Integration]({{< relref "/docs/ai-integration" >}}) |
2828
| 🛠️ | **Dev Container** | Pre-configured multi-language environment: Python · Java · Go · JavaScript — [→ Dev Container]({{< relref "/docs/dev-container" >}}) |
29+
| 🔄 | **Process-First** | Built-in education on the Process-First SDLC philosophy and how every tool maps to an SDLC principle — [→ Process-First guide]({{< relref "/docs/getting-started/process-first" >}}) |
2930
| 📖 | **CLI Reference** | Complete option tables, input files, and exact output paths for every command — [→ CLI Reference]({{< relref "/docs/reference" >}}) |
3031

3132
---
@@ -38,15 +39,18 @@ git clone https://github.com/cloudengine-labs/devops_os.git
3839
cd devops_os
3940
pip install -r cli/requirements.txt
4041

41-
# 2. Generate a GitHub Actions workflow
42+
# 2. Learn the Process-First philosophy (recommended first step)
43+
python -m cli.devopsos process-first
44+
45+
# 3. Generate a GitHub Actions workflow
4246
python -m cli.scaffold_gha --name my-app --languages python,javascript --type complete
4347
# Output: .github/workflows/my-app-complete.yml
4448

45-
# 3. Generate a GitLab CI pipeline
49+
# 4. Generate a GitLab CI pipeline
4650
python -m cli.scaffold_gitlab --name my-app --languages python --type complete
4751
# Output: .gitlab-ci.yml
4852

49-
# 4. Generate SRE configs (Prometheus + Grafana + SLO)
53+
# 5. Generate SRE configs (Prometheus + Grafana + SLO)
5054
python -m cli.scaffold_sre --name my-app --team platform
5155
# Output: sre/ directory
5256
```
@@ -74,6 +78,7 @@ python -m cli.scaffold_sre --name my-app --team platform
7478
| Guide | Description |
7579
|-------|-------------|
7680
| [Getting Started]({{< relref "/docs/getting-started" >}}) | Zero to first pipeline in 5 minutes |
81+
| [Process-First Philosophy]({{< relref "/docs/getting-started/process-first" >}}) | What Process-First means, how it maps to DevOps-OS, and AI learning tips |
7782
| [Quick Start Reference]({{< relref "/docs/getting-started/quickstart" >}}) | All CLI commands at a glance |
7883
| [GitHub Actions]({{< relref "/docs/ci-cd/github-actions" >}}) | Generate GHA workflows |
7984
| [GitLab CI]({{< relref "/docs/ci-cd/gitlab-ci" >}}) | Generate GitLab pipelines |

‎hugo-docs/content/docs/getting-started/_index.md‎

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,22 @@ pip install -r cli/requirements.txt
6565
6666
---
6767

68-
## 2 — Generate your first CI/CD pipeline
68+
## 2 — Learn the Process-First philosophy *(recommended)*
69+
70+
Before running any generator, understand *why* each tool exists:
71+
72+
```bash
73+
python -m cli.devopsos process-first # full overview
74+
python -m cli.devopsos process-first --section what # 5 core principles
75+
python -m cli.devopsos process-first --section mapping # which scaffold encodes which principle
76+
python -m cli.devopsos process-first --section tips # AI prompts for deeper learning
77+
```
78+
79+
See the [Process-First guide]({{< relref "/docs/getting-started/process-first" >}}) for the full reference.
80+
81+
---
82+
83+
## 3 — Generate your first CI/CD pipeline
6984

7085
### GitHub Actions
7186

@@ -93,7 +108,7 @@ python -m cli.scaffold_jenkins --name my-app --languages java --type complete
93108

94109
---
95110

96-
## 3 — Generate Kubernetes / GitOps configs
111+
## 4 — Generate Kubernetes / GitOps configs
97112

98113
```bash
99114
# ArgoCD Application CR + AppProject
@@ -110,7 +125,7 @@ python -m cli.scaffold_argocd --name my-app --method flux \
110125

111126
---
112127

113-
## 4 — Generate SRE configs
128+
## 5 — Generate SRE configs
114129

115130
```bash
116131
python -m cli.scaffold_sre --name my-app --team platform
@@ -124,7 +139,7 @@ python -m cli.scaffold_sre --name my-app --team platform
124139

125140
---
126141

127-
## 5 — Interactive wizard (all-in-one)
142+
## 6 — Interactive wizard (all-in-one)
128143

129144
```bash
130145
python -m cli.devopsos init # interactive project configurator
@@ -137,7 +152,7 @@ python -m cli.devopsos scaffold sre # scaffold SRE configs
137152

138153
---
139154

140-
## 6 — Use with an AI assistant
155+
## 7 — Use with an AI assistant
141156

142157
```bash
143158
pip install -r mcp_server/requirements.txt
@@ -166,6 +181,7 @@ Then ask Claude: *"Generate a complete GitLab CI pipeline for a Python Flask API
166181

167182
| I want to… | Read |
168183
|-----------|------|
184+
| Understand the Process-First philosophy | [Process-First guide]({{< relref "/docs/getting-started/process-first" >}}) |
169185
| See every CLI option and output path | [CLI Reference]({{< relref "/docs/reference" >}}) |
170186
| Deep-dive GitHub Actions | [GitHub Actions]({{< relref "/docs/ci-cd/github-actions" >}}) |
171187
| Deep-dive GitLab CI | [GitLab CI]({{< relref "/docs/ci-cd/gitlab-ci" >}}) |

‎hugo-docs/content/docs/getting-started/process-first.md‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
---
2+
title: "Process-First Philosophy"
3+
weight: 12
4+
---
5+
6+
# Process-First Philosophy
7+
8+
> *"Tools are only as good as the processes that govern them."*
9+
> — Saravanan Gnanagur, Founder, CloudEngineLabs
10+
11+
[cloudenginelabs.io](https://cloudenginelabs.io) is a **Process-First SDLC automation company**.
12+
DevOps-OS embeds this philosophy as a first-class CLI command so every engineer on your team can understand *why* before they run *how*.
13+
14+
---
15+
16+
## The `process-first` command
17+
18+
```bash
19+
# Full overview — what Process-First is, how it maps to DevOps-OS, and learning tips
20+
python -m cli.devopsos process-first
21+
22+
# Section: what Process-First is and the 5 core principles
23+
python -m cli.devopsos process-first --section what
24+
25+
# Section: how each principle maps to a specific devopsos scaffold command
26+
python -m cli.devopsos process-first --section mapping
27+
28+
# Section: AI prompts and book recommendations for DevOps beginners
29+
python -m cli.devopsos process-first --section tips
30+
31+
# Show help
32+
python -m cli.devopsos process-first --help
33+
```
34+
35+
You can also invoke the standalone module directly (same output):
36+
37+
```bash
38+
python -m cli.process_first
39+
python -m cli.process_first --section mapping
40+
```
41+
42+
---
43+
44+
## Options
45+
46+
| Option | Default | Description |
47+
|--------|---------|-------------|
48+
| `--section SECTION` | `all` | `what` · `mapping` · `tips` · `all` |
49+
| `--help` | — | Show command help and exit |
50+
51+
---
52+
53+
## What is Process-First?
54+
55+
Process-First is an engineering philosophy that places well-defined, repeatable SDLC (Software Development Life Cycle) processes at the centre of every engineering decision — **before** selecting tools, platforms, or frameworks.
56+
57+
The guiding question is always: **"Do we have the right process before we pick the tool?"**
58+
59+
---
60+
61+
## The 5 Core Principles
62+
63+
| # | Principle | What it means in practice |
64+
|---|-----------|--------------------------|
65+
| 1 | **Define before you Build** | Document the "why" and "what" of every workflow before writing a single line of pipeline code. |
66+
| 2 | **Standardise before you Scale** | Create golden-path templates (CI/CD, GitOps, SRE) that every team can adopt without reinventing the wheel. |
67+
| 3 | **Automate what is Repeatable** | If a process is done more than twice, automate it. Automation should *encode* the process, not bypass it. |
68+
| 4 | **Observe and Iterate** | Every automated process must produce measurable outcomes (SLOs, SLAs, error budgets) so teams can improve continuously. |
69+
| 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. |
70+
71+
---
72+
73+
## How Process-First Maps to DevOps-OS
74+
75+
Each `devopsos scaffold` command encodes one or more Process-First principles into an immediately usable configuration artefact:
76+
77+
| Process-First Principle | DevOps-OS Command | What it generates |
78+
|-------------------------|-------------------|-------------------|
79+
| **Define before you Build** | `devopsos scaffold cicd` / `gha` / `gitlab` | Interactive wizards capture intent before generating any config file |
80+
| **Standardise before Scale** | `devopsos scaffold gha`, `gitlab`, `jenkins` | Golden-path templates for GitHub Actions, GitLab CI, and Jenkins |
81+
| **Automate the Repeatable** | `devopsos scaffold argocd` | GitOps sync process encoded as an ArgoCD `Application` + `AppProject` CR |
82+
| **Automate the Repeatable** | `devopsos scaffold devcontainer` | Developer environment setup encoded as `devcontainer.json` |
83+
| **Observe and Iterate** | `devopsos scaffold sre` | Prometheus rules, Grafana dashboards, and SLO manifests |
84+
| **Culture over Tooling** | MCP server skills | AI assistants (Claude, ChatGPT) coach engineers on DevOps best practices |
85+
86+
Run `python -m cli.devopsos process-first --section mapping` to view this table in your terminal.
87+
88+
---
89+
90+
## When to Use This Command
91+
92+
| Situation | Recommended section |
93+
|-----------|---------------------|
94+
| New team member onboarding | `all` — read the full overview first |
95+
| Pre-sprint process alignment | `mapping` — show how each scaffold encodes a principle |
96+
| Self-study / learning DevOps | `tips` — AI prompts let you go deep on any topic |
97+
| Quick philosophy refresh | `what` — re-read the 5 core principles |
98+
99+
---
100+
101+
## Tips for DevOps Beginners — AI Prompts
102+
103+
Use AI tools like **Claude**, **ChatGPT**, or **Gemini** with these prompts:
104+
105+
**Understanding the ideology**
106+
107+
> "Explain the process-first approach to SDLC automation and why defining processes before choosing tools leads to better outcomes."
108+
109+
**CI/CD pipelines**
110+
111+
> "What are the key stages of a production-grade CI/CD pipeline? Give me a process checklist before I start writing any pipeline code."
112+
113+
**GitOps and ArgoCD**
114+
115+
> "Walk me through the GitOps process: from code commit to production deployment using ArgoCD. What processes must exist before ArgoCD adds value?"
116+
117+
**SRE fundamentals**
118+
119+
> "What is the SRE process for setting SLOs and error budgets? How do I translate business requirements into Prometheus alert rules?"
120+
121+
**Using DevOps-OS with AI**
122+
123+
> "Using the DevOps-OS tools, scaffold a process-first CI/CD setup for a Python microservice with GitOps delivery and SRE observability."
124+
125+
See [AI Integration]({{< relref "/docs/ai-integration" >}}) for full MCP server setup.
126+
127+
---
128+
129+
## Further Reading
130+
131+
| Resource | Where |
132+
|----------|-------|
133+
| *The DevOps Handbook* — Gene Kim et al. | Your preferred book retailer |
134+
| *Site Reliability Engineering* — Google | [sre.google/books](https://sre.google/books) |
135+
| *Accelerate* — Nicole Forsgren et al. | Your preferred book retailer |
136+
| Saravanan Gnanagur on LinkedIn | Search **"Saravanan Gnanagur process first"** on LinkedIn |

‎hugo-docs/content/docs/getting-started/quickstart.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,28 @@ pip install -r cli/requirements.txt
2323

2424
---
2525

26+
## Process-First Philosophy
27+
28+
Before running any generator, learn *why* each tool exists:
29+
30+
```bash
31+
# Full overview (Process-First ideology + tooling map + beginner tips)
32+
python -m cli.devopsos process-first
33+
34+
# Core principles only
35+
python -m cli.devopsos process-first --section what
36+
37+
# Principle → devopsos scaffold command mapping
38+
python -m cli.devopsos process-first --section mapping
39+
40+
# AI prompts for deeper learning
41+
python -m cli.devopsos process-first --section tips
42+
```
43+
44+
See the [Process-First guide]({{< relref "/docs/getting-started/process-first" >}}) for the full reference.
45+
46+
---
47+
2648
## GitHub Actions Workflows
2749

2850
```bash
@@ -189,6 +211,7 @@ python -m cli.scaffold_jenkins --help
189211
python -m cli.scaffold_argocd --help
190212
python -m cli.scaffold_sre --help
191213
python -m cli.scaffold_devcontainer --help
214+
python -m cli.devopsos process-first --help
192215

193216
# Verify generated output
194217
ls -la .github/workflows/ # GitHub Actions

‎hugo-docs/content/docs/reference/_index.md‎

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ Complete reference for every DevOps-OS CLI command: options, default values, env
2121
| Flux CD | `python -m cli.scaffold_argocd --method flux` | `flux/` directory |
2222
| SRE configs | `python -m cli.scaffold_sre` | `sre/` directory |
2323
| Dev Container | `python -m cli.scaffold_devcontainer` | `.devcontainer/` directory |
24-
| Interactive wizard | `python -m cli.devopsos` | varies |
24+
| Interactive wizard | `python -m cli.devopsos init` | varies |
25+
| Process-First guide | `python -m cli.devopsos process-first` | stdout (educational content) |
2526

2627
---
2728

@@ -181,6 +182,7 @@ python -m cli.devopsos COMMAND [options]
181182
|---------|-------------|
182183
| `init` | Interactive wizard (select languages, tools, generate dev container) |
183184
| `scaffold TARGET` | Non-interactive generator (delegates to `scaffold_*` modules) |
185+
| `process-first` | Learn the Process-First SDLC philosophy and how it maps to DevOps-OS tooling |
184186

185187
### Scaffold targets
186188

@@ -193,6 +195,31 @@ python -m cli.devopsos scaffold sre # SRE configs
193195
python -m cli.devopsos scaffold devcontainer # Dev container
194196
```
195197

198+
### process-first command
199+
200+
Prints the Process-First SDLC philosophy to stdout. Accepts an optional `--section` flag to display a focused sub-section.
201+
202+
```bash
203+
# Full overview (all sections, default)
204+
python -m cli.devopsos process-first
205+
206+
# Core principles only
207+
python -m cli.devopsos process-first --section what
208+
209+
# Principle → DevOps-OS tooling mapping table
210+
python -m cli.devopsos process-first --section mapping
211+
212+
# AI prompts and book recommendations for beginners
213+
python -m cli.devopsos process-first --section tips
214+
215+
# Run the standalone module (same output)
216+
python -m cli.process_first --section mapping
217+
```
218+
219+
| Option | Default | Description |
220+
|--------|---------|-------------|
221+
| `--section SECTION` | `all` | Section to display: `what` \| `mapping` \| `tips` \| `all` |
222+
196223
---
197224

198225
## Input File Formats

0 commit comments

Comments
 (0)