diff --git a/hugo-docs/content/_index.md b/hugo-docs/content/_index.md index 8facd0b..67ebe21 100644 --- a/hugo-docs/content/_index.md +++ b/hugo-docs/content/_index.md @@ -80,6 +80,7 @@ python -m cli.devopsos scaffold sre --name my-app --team platform | Guide | Description | |-------|-------------| | [Getting Started]({{< relref "/docs/getting-started" >}}) | Zero to first pipeline in 5 minutes | +| [Platform Engineering IDP]({{< relref "/docs/platform-engineering" >}}) | Conceptual self-service IDP flow from templates to generated automation | | [Process-First Philosophy]({{< relref "/docs/getting-started/process-first" >}}) | What Process-First means, how it maps to DevOps-OS, and AI learning tips | | [Quick Start Reference]({{< relref "/docs/getting-started/quickstart" >}}) | All CLI commands at a glance | | [GitHub Actions]({{< relref "/docs/ci-cd/github-actions" >}}) | Generate GHA workflows | diff --git a/hugo-docs/content/docs/_index.md b/hugo-docs/content/docs/_index.md index d388284..39b24c2 100644 --- a/hugo-docs/content/docs/_index.md +++ b/hugo-docs/content/docs/_index.md @@ -18,6 +18,7 @@ Welcome to the DevOps-OS documentation. Use the sidebar to navigate between sect | Section | What you'll find | |---------|-----------------| | [Getting Started]({{< relref "/docs/getting-started" >}}) | Prerequisites, installation, first pipeline | +| [Platform Engineering IDP]({{< relref "/docs/platform-engineering" >}}) | Conceptual self-service flow from templates to generated automation | | [Quick Start]({{< relref "/docs/getting-started/quickstart" >}}) | All CLI commands with output paths | | [CI/CD Generators]({{< relref "/docs/ci-cd" >}}) | GitHub Actions, GitLab CI, Jenkins | | [GitOps & ArgoCD]({{< relref "/docs/gitops" >}}) | ArgoCD and Flux CD configs | diff --git a/hugo-docs/content/docs/platform-engineering/_index.md b/hugo-docs/content/docs/platform-engineering/_index.md new file mode 100644 index 0000000..75b81fb --- /dev/null +++ b/hugo-docs/content/docs/platform-engineering/_index.md @@ -0,0 +1,101 @@ +--- +title: "Platform Engineering IDP" +description: "Conceptual platform engineering IDP flow from templates through the UI to generated automation." +weight: 15 +--- + +# Platform Engineering IDP Concept + +DevOps-OS can be used as a lightweight **internal developer platform (IDP)** experience: platform teams publish golden-path templates, and developers consume them through a guided self-service flow. + +--- + +## Conceptual flow + +
+ + Platform Engineering IDP conceptual flow + Platform team templates flow into an IDP UI. A developer works from git code commit context, selects templates, chooses automation stages, submits, and receives generated delivery artifacts. + + + Templates + Golden-path CI/CD + GitOps • SRE • DevEnv + + + IDP UI + Self-service catalog + Guardrails + standards + + + Git repo / commit + Repository context + App or service intent + + + 1. Select templates + pipeline, GitOps, SRE, devcontainer + + + 2. Select automation stages + build • test • deploy • monitor + + + 3. Click submit + approve and generate automation + + + Outputs + Generated repo changes + Workflow / YAML / config + Standard delivery stages + PR or commit-ready artifacts + + Platform team publishes + Developer context + Guided self-service steps + + + + + + + + + + + + + + + + + + + + Templates → IDP UI → Git repo / commit → Select templates → Select automation stages → Submit → Outputs + +
+ +--- + +## What the diagram shows + +1. **Platform teams** publish reusable templates into the IDP catalog. +2. The **IDP UI** gives developers a guided entry point with platform guardrails. +3. The flow starts from a **Git repository / code commit context** for the service being onboarded or updated. +4. The developer **selects the required templates** and **chooses automation stages** such as build, test, deploy, GitOps, or observability. +5. On **submit**, DevOps-OS generates the standardized delivery artifacts that can be committed or reviewed in Git. + +--- + +## Example automation stages + +| Stage | Typical DevOps-OS output | +|-------|---------------------------| +| Build & Test | [GitHub Actions / GitLab CI / Jenkins workflows]({{< relref "/docs/ci-cd" >}}) | +| Deploy | [ArgoCD or Flux GitOps configuration]({{< relref "/docs/gitops" >}}) | +| Observe | [Prometheus, Grafana, and SLO configuration]({{< relref "/docs/sre" >}}) | +| Developer Environment | [Dev Container configuration]({{< relref "/docs/dev-container" >}}) | + +This makes DevOps-OS a practical way to present **platform engineering standards as a self-service IDP experience**.