You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add user-focused documentation including quickstart guides,
installation instructions, configuration options, and troubleshooting.
- Add user documentation directory with comprehensive guides
- Add developer getting started guide with Docker Compose setup
- Restructure docs with consistent README.md naming
- Add detailed installation guide for multiple deployment methods
- Add quickstart guide with 4 different setup approaches
- Add comprehensive troubleshooting guide for common issues
- Add configuration guide covering all Kepler settings
The documentation provides clear paths for different user types from
beginners to advanced users, with practical examples and step-by-step
instructions for deploying and configuring Kepler.
Signed-off-by: Sunil Thaha <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+20-9Lines changed: 20 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,33 +54,44 @@ accurate energy consumption monitoring for cloud-native workloads.
54
54
55
55
## 🚀 Getting Started
56
56
57
-
> **📖 For comprehensive installation instructions, troubleshooting, and advanced deployment options, see our [Installation Guide](docs/user/installation.md)**
57
+
**New to Kepler?** Follow our [**📖 Getting Started Guide**](docs/user/getting-started.md) for quick Kubernetes cluster deployment, or see our [**🧑💻 Developer Getting Started Guide**](docs/developer/getting-started.md) for local development with dashboards.
58
58
59
59
### ⚡ Quick Start
60
60
61
61
Choose your preferred method:
62
62
63
63
```bash
64
-
#💻 Local Development
65
-
make build && sudo ./bin/kepler
64
+
#🎯 Deploy to Kubernetes Cluster (Recommended for users)
> **📖 For detailed installation instructions, troubleshooting, and advanced deployment options, see our [Installation Guide](docs/user/installation.md)**
79
+
74
80
## 📖 Documentation
75
81
76
82
### User Documentation
77
83
78
-
-**[Installation Guide](docs/user/installation.md)** - Detailed installation instructions for all deployment methods
79
-
-**[Configuration Guide](docs/user/configuration.md)** - Configuration options and examples
84
+
📋 **[User Guide Index](docs/user/README.md)** - Complete navigation hub for all user documentation
85
+
86
+
-**[Getting Started Guide](docs/user/getting-started.md)** - Quick Kubernetes cluster deployment
87
+
-**[Installation Guide](docs/user/installation.md)** - Production deployment methods and enterprise integration
88
+
-**[Configuration Guide](docs/user/configuration.md)** - Configuration options and customization examples
89
+
-**[Troubleshooting Guide](docs/user/troubleshooting.md)** - Comprehensive problem-solving and debugging guide
80
90
-**[Metrics Documentation](docs/user/metrics.md)** - Available metrics and their descriptions
81
91
82
92
### Developer Documentation
83
93
94
+
-**[Developer Getting Started Guide](docs/developer/getting-started.md)** - Local development setup with Docker Compose, dashboards, and building from source
84
95
-**[Architecture Documentation](docs/developer/design/architecture/)** - Complete architectural documentation including design principles, system components, data flow, concurrency model, and deployment patterns
85
96
-**[Power Attribution Guide](docs/developer/power-attribution-guide.md)** - How Kepler measures and attributes power consumption
86
97
-**[Developer Documentation](docs/developer/)** - Contributing guidelines and development workflow
0 commit comments