Skip to content

Commit ba18b95

Browse files
committed
docs: add comprehensive user quickstart guides
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]>
1 parent ca1c3f6 commit ba18b95

File tree

11 files changed

+1694
-103
lines changed

11 files changed

+1694
-103
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,33 +54,44 @@ accurate energy consumption monitoring for cloud-native workloads.
5454

5555
## 🚀 Getting Started
5656

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.
5858

5959
### ⚡ Quick Start
6060

6161
Choose your preferred method:
6262

6363
```bash
64-
# 💻 Local Development
65-
make build && sudo ./bin/kepler
64+
# 🎯 Deploy to Kubernetes Cluster (Recommended for users)
65+
helm install kepler manifests/helm/kepler/ --namespace kepler --create-namespace
6666

67-
# ✨ Docker Compose (with Prometheus & Grafana)
68-
cd compose/dev && docker-compose up -d
67+
# 🧑‍💻 Local Development with Dashboards
68+
cd compose/dev && docker compose up -d
69+
# Access Grafana: http://localhost:23000 (admin/admin)
6970

70-
# 🐳 Kubernetes
71-
helm install kepler manifests/helm/kepler/ --namespace kepler --create-namespace
71+
# 🏗️ Local Kubernetes Development
72+
make cluster-up && make deploy
73+
74+
# 💻 Build from Source
75+
make build && sudo ./bin/kepler
7276
```
7377

78+
> **📖 For detailed installation instructions, troubleshooting, and advanced deployment options, see our [Installation Guide](docs/user/installation.md)**
79+
7480
## 📖 Documentation
7581

7682
### User Documentation
7783

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
8090
- **[Metrics Documentation](docs/user/metrics.md)** - Available metrics and their descriptions
8191

8292
### Developer Documentation
8393

94+
- **[Developer Getting Started Guide](docs/developer/getting-started.md)** - Local development setup with Docker Compose, dashboards, and building from source
8495
- **[Architecture Documentation](docs/developer/design/architecture/)** - Complete architectural documentation including design principles, system components, data flow, concurrency model, and deployment patterns
8596
- **[Power Attribution Guide](docs/developer/power-attribution-guide.md)** - How Kepler measures and attributes power consumption
8697
- **[Developer Documentation](docs/developer/)** - Contributing guidelines and development workflow

docs/index.md renamed to docs/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Welcome to the Kepler documentation. Kepler is a Prometheus exporter that measur
88

99
Documentation for users deploying and operating Kepler:
1010

11+
- [Getting Started Guide](user/getting-started.md) - Quick Kubernetes cluster deployment
1112
- [Installation Guide](user/installation.md) - How to install and deploy Kepler
1213
- [Configuration Guide](user/configuration.md) - Configuring Kepler for your environment
1314
- [Metrics Reference](user/metrics.md) - Available Prometheus metrics exported by Kepler
@@ -22,7 +23,7 @@ Documentation for developers contributing to Kepler:
2223

2324
## Quick Start
2425

25-
For a quick start, see the [Installation Guide](user/installation.md) and the main project README.
26+
For a quick start, see the [Getting Started Guide](user/getting-started.md) and the main project README.
2627

2728
## Contributing
2829

docs/developer/index.md renamed to docs/developer/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ This section contains documentation for developers working on Kepler.
2424

2525
## Development Workflow
2626

27+
- [Developer Getting Started](getting-started.md) - Building from source and setting up development environments
2728
- [Pre-commit Setup](pre-commit.md) - Setting up pre-commit hooks for code quality
2829

2930
## Release Management

docs/developer/design/architecture/index.md renamed to docs/developer/design/architecture/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ For specific implementation work:
8484
## Related Documentation
8585

8686
- **[Power Attribution Guide](../../power-attribution-guide.md)**: Detailed explanation of power calculation methodology
87-
- **[Development Setup](../../index.md)**: Setting up the development environment
87+
- **[Development Setup](../../README.md)**: Setting up the development environment
8888
- **[User Configuration Guide](../../../user/configuration.md)**: End-user configuration options
8989

9090
---

0 commit comments

Comments
 (0)