tfgrid/myceliumcloud-examples
11
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update documentation to reflect new example file naming convention

Browse Source
This commit is contained in:
mik-tf
2025-11-04 10:49:49 -05:00
parent d5a378a2dc
commit 1528cc57ff
2 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -299,7 +299,7 @@ kubectl apply -f *.yaml --namespace=prod
Want to add an example? Here's the pattern: Want to add an example? Here's the pattern:
1. Create `examples/your-example/` 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 3. Add deployment and service YAML files
4. Test end-to-end functionality 4. Test end-to-end functionality
5. Include troubleshooting section 5. Include troubleshooting section

2
examples/hello-world/hello-world.md
View File

@@ -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: 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-deployment.yaml** - Application deployment
- **hello-world-service.yaml** - Service configuration - **hello-world-service.yaml** - Service configuration
- **src/** - Source files (optional, for customization) - **src/** - Source files (optional, for customization)