Skip to content

Commit 0341a1b

Browse files
committed
docs: cleanup and consistency improvements across README, CONTRIBUTING, and component docs
- Remove orphaned scratch design doc TMP_MON_PREVIEWS.md (1518 lines, duplicate changelog entries, not referenced; replaced by preview-infra/RUNBOOK.md). - Fix broken markdown in README.md: remove broken centered-div wrap that left code blocks center-aligned, drop duplicated "Use cases" section, fix unterminated backtick, consolidate Links/Support, and drop decorative emoji from H2 headers for consistency with the top half of the document. - Fix stale repo URL in cli/README.md (postgres_ai -> postgresai). - Fix invalid check ID in QUALITY_ENGINEERING_GUIDE example summary (U001 -> H002, D004 -> F004) and correct CLI command reference (postgresai monitoring -> postgresai mon). - Fix stray "SQL" delimiter outside heredoc and reschedule mismatch ("every 20 minutes" did not match the daily cron) in workload_examples/single_index_analysis.md. - Normalize curly quotes to ASCII in CONTRIBUTING.md and components/index_pilot docs, tighten Recommendations wording. - Minor SECURITY.md heading casing and grammar fixes. - Trim trailing blank lines in pgai/README.md, postgres_ai_helm/README.md, components/index_pilot/CONTRIBUTING.md. https://claude.ai/code/session_01U4F5KjW5neeCYxkKUZawfS
1 parent 222a355 commit 0341a1b

11 files changed

Lines changed: 58 additions & 1610 deletions

File tree

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ That means edits to:
113113
- `config/pgwatch-*/metrics.yml`
114114
- `config/scripts/*.sh`
115115

116-
can be picked up locally (see Applying config changes below).
116+
can be picked up locally (see "Applying config changes" below).
117117

118118
#### 1) Choose what Postgres you want to monitor
119119

@@ -290,7 +290,7 @@ Then attach:
290290
### Troubleshooting
291291

292292
- **Compose says `PGAI_TAG is required`**: set it in `.env` (see above).
293-
- **Host reporter cant connect to sink-postgres**: make sure the stack is up and `sink-postgres` is bound to `127.0.0.1:55433` (it is in `docker-compose.override.yml`).
293+
- **Host reporter can't connect to sink-postgres**: make sure the stack is up and `sink-postgres` is bound to `127.0.0.1:55433` (it is in `docker-compose.override.yml`).
294294
- **Need to regenerate pgwatch sources after editing `instances.yml`**:
295295

296296
```bash

README.md

Lines changed: 42 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -206,49 +206,20 @@ npx postgresai checkup --json postgresql://... | claude -p "find issues and sugg
206206
## Tips
207207

208208
- **Short alias:** `npx pgai checkup` works too
209-
- **Can I use it without registration on console.postgres.ai?** Yes, both express checkup and full-fledged monitoring are open-source and can be used without any connection to console.postgres.ai. In instructions above, just skip `npx postgresai auth` and:
209+
- **Can I use it without registration on console.postgres.ai?** Yes, both express checkup and full-fledged monitoring are open-source and can be used without any connection to console.postgres.ai. In the instructions above, just skip `npx postgresai auth` and:
210210
- Express checkup: use `--no-upload`
211-
- Full monitoring: omit --api-key`
212-
- **Managed version:** Express checkup finds problems. The managed version at [console.postgres.ai](https://console.postgres.ai) also explains how to fix them and provides an Issues workflow to track fixes
213-
## Links
214-
215-
| | |
216-
|---|---|
217-
| **Demo** | [demo.postgres.ai](https://demo.postgres.ai) (login: `demo` / `demo`) |
218-
| **Docs** | [postgres.ai/docs](https://postgres.ai/docs) |
219-
| **Issues** | [GitLab](https://gitlab.com/postgres-ai/postgresai/-/issues) |
220-
| **Community** | [Postgres.FM](https://postgres.fm) · [Postgres.TV](https://postgres.tv) |
211+
- Full monitoring: omit `--api-key`
212+
- **Managed version:** Express checkup finds problems. The managed version at [console.postgres.ai](https://console.postgres.ai) also explains how to fix them and provides an Issues workflow to track fixes.
221213

222-
---
214+
## Management commands
223215

224-
<div align="center">
225-
226-
**[PostgresAI](https://postgres.ai)** — Self-Driving Postgres
227-
228-
## 🎯 Use cases
229-
230-
**For developers:**
231216
```bash
232-
postgresai mon local-install --demo
233-
```
234-
Get a complete monitoring setup with demo data in under 2 minutes.
235-
236-
**For production:**
237-
```bash
238-
postgresai mon local-install --api-key=your_key
239-
# Then add your databases
240-
postgresai mon targets add "postgresql://user:pass@host:port/DB"
241-
```
242-
243-
## 🔧 Management commands
244-
245-
```bash
246-
# Instance management
247-
postgresai mon targets add "postgresql://user:pass@host:port/DB"
217+
# Target databases
218+
postgresai mon targets add "postgresql://user:pass@host:port/db" my-db
248219
postgresai mon targets list
249-
postgresai mon targets test my-DB
220+
postgresai mon targets test my-db
250221

251-
# Service management
222+
# Service lifecycle
252223
postgresai mon status
253224
postgresai mon logs
254225
postgresai mon restart
@@ -257,7 +228,7 @@ postgresai mon restart
257228
postgresai mon health
258229
```
259230

260-
## 🔄 Upgrading
231+
## Upgrading
261232

262233
To upgrade postgres_ai monitoring to a newer version:
263234

@@ -322,7 +293,7 @@ postgresai mon health
322293

323294
Check Grafana dashboards at http://localhost:3000 to confirm metrics are being collected.
324295

325-
## ☸️ Kubernetes deployment
296+
## Kubernetes deployment
326297

327298
Deploy postgres_ai monitoring to Kubernetes using helm:
328299

@@ -372,7 +343,7 @@ This automatically:
372343
- Triggers GitLab CI/CD to package and publish the chart
373344
- Creates a GitLab release with the packaged chart
374345

375-
## 📋 Checkup reports
346+
## Checkup reports
376347

377348
postgres_ai monitoring generates automated health check reports based on [postgres-checkup](https://gitlab.com/postgres-ai/postgres-checkup). Each report has a unique check ID and title:
378349

@@ -434,36 +405,34 @@ postgres_ai monitoring generates automated health check reports based on [postgr
434405
|----------|-------|
435406
| N001 | Wait events grouped by type and query |
436407

437-
## 🌐 Access points
408+
## Access points
438409

439-
After running local-install:
410+
After running `local-install`:
440411

441-
- **🚀 MAIN: Grafana Dashboard**: http://localhost:3000 (login: `monitoring`; password is shown at the end of local-install)
412+
- **Grafana dashboard:** http://localhost:3000 (login: `monitoring`; password is shown at the end of `local-install`)
442413

443414
Technical URLs (for advanced users):
444-
- **Demo DB**: postgresql://postgres:postgres@localhost:55432/target_database
445-
- **Monitoring**: http://localhost:58080 (PGWatch)
446-
- **Metrics**: http://localhost:59090 (Victoria Metrics)
447415

448-
## 📖 Help
416+
- **Demo DB:** `postgresql://postgres:postgres@localhost:55432/target_database`
417+
- **Monitoring:** http://localhost:58080 (PGWatch)
418+
- **Metrics:** http://localhost:59090 (Victoria Metrics)
419+
420+
## Help
449421

450422
```bash
451423
postgresai --help
452424
postgresai mon --help
453425
```
454426

455-
## 🔑 PostgresAI access token
456-
Get your access token at [PostgresAI](https://postgres.ai) for automated report uploads and advanced analysis.
457-
458-
## 🛣️ Roadmap
427+
## Roadmap
459428

460429
- Host stats for on-premise and managed Postgres setups
461430
- `pg_wait_sampling` and `pg_stat_kcache` extension support
462431
- Additional expert dashboards: autovacuum, checkpointer, lock analysis
463432
- Query plan analysis and automated recommendations
464433
- Enhanced AI integration capabilities
465434

466-
## 🧪 Testing
435+
## Testing
467436

468437
Python-based report generation lives under `reporter/` and now ships with a pytest suite.
469438

@@ -511,27 +480,36 @@ pytest tests/reporter -m unit --cov=reporter --cov-report=html
511480

512481
View the coverage report by opening `htmlcov/index.html` in your browser.
513482

514-
## 🤝 Contributing
483+
## Contributing
484+
485+
We welcome contributions from Postgres experts. See [CONTRIBUTING.md](CONTRIBUTING.md) for local development setup, and the [GitLab repository](https://gitlab.com/postgres-ai/postgresai) for:
515486

516-
We welcome contributions from Postgres experts! Please check our [GitLab repository](https://gitlab.com/postgres-ai/postgresai) for:
517487
- Code standards and review process
518488
- Dashboard design principles
519489
- Testing requirements for monitoring components
520490

521-
## 📄 License
491+
## License
522492

523-
This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
493+
This project is licensed under the Apache License 2.0 — see the [LICENSE](LICENSE) file for details.
494+
495+
## About PostgresAI
496+
497+
`postgresai` is developed by [PostgresAI](https://postgres.ai), bringing years of Postgres expertise into automated monitoring and analysis tools. We provide enterprise consulting and advanced Postgres solutions for fast-growing companies.
498+
499+
## Links
524500

525-
## 🏢 About PostgresAI
501+
| | |
502+
|---|---|
503+
| **Demo** | [demo.postgres.ai](https://demo.postgres.ai) (login: `demo` / `demo`) |
504+
| **Docs** | [postgres.ai/docs](https://postgres.ai/docs) |
505+
| **Issues** | [GitLab](https://gitlab.com/postgres-ai/postgresai/-/issues) |
506+
| **Community** | [Postgres.FM](https://postgres.fm) · [Postgres.TV](https://postgres.tv) |
507+
| **Support** | [Get support](https://postgres.ai/contact) · [Enterprise support](https://postgres.ai/consulting) |
526508

527-
postgres_ai monitoring is developed by [PostgresAI](https://postgres.ai), bringing years of Postgres expertise into automated monitoring and analysis tools. We provide enterprise consulting and advanced Postgres solutions for fast-growing companies.
509+
---
528510

529-
## 📞 Support & community
511+
<div align="center">
530512

531-
- 💬 [Get support](https://postgres.ai/contact)
532-
- 📺 [Postgres.TV (YouTube)](https://postgres.tv)
533-
- 🎙️ [Postgres FM Podcast](https://postgres.fm)
534-
- 🐛 [Report issues](https://gitlab.com/postgres-ai/postgresai/-/issues)
535-
- 📧 [Enterprise support](https://postgres.ai/consulting)
513+
**[PostgresAI](https://postgres.ai)** — Self-Driving Postgres
536514

537515
</div>

SECURITY.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ If you discover a security vulnerability in this project, please report it to **
1313

1414
### When should I NOT report a vulnerability?
1515

16-
- Your issue is not security related.
16+
- Your issue is not security-related.
1717

18-
## Security Vulnerability Response
18+
## Security vulnerability response
1919

2020
Each report is acknowledged and analyzed by the project maintainers and the security team within 3 working days.
2121

22-
The reporter will be kept updated at every stage of the issue's analysis and resolution (triage → fix → release).
22+
The reporter is kept updated at every stage of the issue's analysis and resolution (triage → fix → release).
2323

24-
## Public Disclosure Timing
24+
## Public disclosure timing
2525

2626
A public disclosure date is negotiated by the maintainers (security@postgres.ai) and the bug submitter. We prefer to fully disclose the bug as soon as possible once user mitigation is available. It is reasonable to delay disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for vendor coordination. The timeframe for disclosure is from immediate (especially if it's already publicly known) to a few weeks. We expect the timeframe between a report and public disclosure to typically be in the order of 7 days.

0 commit comments

Comments
 (0)