From 1528cc57ffce8960719f75ce9722aa4d8a9af39b Mon Sep 17 00:00:00 2001 From: mik-tf Date: Tue, 4 Nov 2025 10:49:49 -0500 Subject: [PATCH] docs: Update documentation to reflect new example file naming convention --- README.md | 2 +- examples/hello-world/hello-world.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6753fd3..c6c587d 100644 --- a/README.md +++ b/README.md @@ -299,7 +299,7 @@ kubectl apply -f *.yaml --namespace=prod Want to add an example? Here's the pattern: 1. Create `examples/your-example/` -2. Add `README.md` with complete guide +2. Add `example-name.md` with complete guide 3. Add deployment and service YAML files 4. Test end-to-end functionality 5. Include troubleshooting section diff --git a/examples/hello-world/hello-world.md b/examples/hello-world/hello-world.md index f423987..b7938ac 100644 --- a/examples/hello-world/hello-world.md +++ b/examples/hello-world/hello-world.md @@ -6,7 +6,7 @@ A complete, standalone example for deploying a Hello World web application on My This directory contains everything you need to deploy a simple web application: -- **README.md** - This guide +- **hello-world.md** - This guide - **hello-world-deployment.yaml** - Application deployment - **hello-world-service.yaml** - Service configuration - **src/** - Source files (optional, for customization)