Skip to content

Commit a7b22a7

Browse files
committed
docs: Remove development and contribution sections from README
1 parent a84df20 commit a7b22a7

File tree

1 file changed

+0
-49
lines changed

1 file changed

+0
-49
lines changed

README.md

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -42,27 +42,6 @@
4242

4343
## 🚀 Deployment Options
4444

45-
### Prerequisites for Helm Repository
46-
47-
Before installing from the Helm repository, ensure the GitHub Pages repository is set up:
48-
49-
1. **Enable GitHub Pages**:
50-
- Go to your repository Settings → Pages
51-
- Set Source to "Deploy from a branch"
52-
- Select the `gh-pages` branch
53-
- Save the settings
54-
55-
2. **Trigger Chart Release**:
56-
- The chart-releaser action will automatically run on pushes to `main`
57-
- It will create the `gh-pages` branch and publish the chart
58-
- You can manually trigger it by pushing changes to the `charts/slaking/` directory
59-
60-
3. **Verify Repository**:
61-
```bash
62-
# Check if the repository is available
63-
curl https://elementtech.github.io/slaking/index.yaml
64-
```
65-
6645
### Option 1: Helm Chart (Recommended) 🦥
6746

6847
The easiest way to deploy Slaking is using the provided Helm chart from the GitHub Pages repository:
@@ -288,26 +267,6 @@ helm upgrade slaking slaking/slaking \
288267
--reuse-values
289268
```
290269

291-
## 🛠️ Development
292-
293-
### Local Development
294-
295-
```bash
296-
npm run dev
297-
```
298-
299-
### Testing
300-
301-
```bash
302-
npm test
303-
```
304-
305-
### Building Docker Image
306-
307-
```bash
308-
npm run build
309-
```
310-
311270
## 🔌 API Endpoints
312271

313272
- `GET /health` - Health check (Slaking's vital signs)
@@ -498,14 +457,6 @@ The service requires minimal permissions:
498457
- Slack token is stored in Kubernetes Secret
499458
- Consider using external secret management (HashiCorp Vault, AWS Secrets Manager, etc.)
500459

501-
## 🤝 Contributing
502-
503-
1. Fork the repository
504-
2. Create a feature branch
505-
3. Make your changes
506-
4. Add tests
507-
5. Submit a pull request
508-
509460
---
510461

511462
```

0 commit comments

Comments
 (0)