Enhance Monitoring PDPs documentation #609
Conversation
✅ Deploy Preview for permitio-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR enhances the Monitoring PDPs documentation by providing comprehensive guidance on the PDP Monitoring page, its purpose, and how to interpret connection statuses. The documentation has been restructured to clarify operational expectations and address common misconceptions about PDP status indicators.
Changes:
- Updated sidebar configuration to use explicit doc type with a custom label
- Completely rewrote the monitoring PDPs documentation to provide detailed operational guidance
- Added sections explaining connection status interpretation, common scenarios for red PDPs, and version management
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| sidebars.js | Changed sidebar entry from simple string reference to explicit doc type configuration with custom label |
| docs/how-to/monitoring-pdps/monitoring-pdps.mdx | Comprehensive rewrite of monitoring documentation including EAP notice, connection status guidance, timeout configuration, and version management best practices |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
|  | ||
| # Monitoring PDPs | ||
| :::note Early Access Program | ||
| The PDP Monitoring page is an **Early Access Program (EAP)** feature. |
There was a problem hiding this comment.
Omer told me to add EAP here
| The Monitoring Page retrieves data via the [PDP Statistics API](./../../api/pdp-statistics.mdx), ensuring up-to-date insights. | ||
|
|
||
|  | ||
| # Monitoring PDPs |
There was a problem hiding this comment.
Add frontmatter at the beginning of the file:
---
sidebar_position: 1
title: Monitoring PDPs
---
# Monitoring PDPs| - [PDP Statistics API](../../api/pdp-statistics) — Programmatic access to PDP monitoring data | ||
| - [PDP Webhooks](../../api/pdp-webhooks) — Real-time notifications for PDP events | ||
| - [PDP Overview](../../concepts/pdp/overview) — Learn more about Policy Decision Points | ||
| - [PDP Configuration](../../concepts/pdp/configuration) — Configure PDP settings and timeouts |
There was a problem hiding this comment.
Use absolute paths from the docs root for more resilience:
/concepts/pdp/overviewinstead of../../concepts/pdp/overview/concepts/pdp/configurationinstead of../../concepts/pdp/configuration/api/pdp-statisticsinstead of../../api/pdp-statistics/api/pdp-webhooksinstead of../../api/pdp-webhooks
|
@alon-boshi I don't see the page in the preview, what is the path for it? |
| "how-to/monitoring-pdps/monitoring-pdps", | ||
| { | ||
| type: "doc", | ||
| id: "how-to/monitoring-pdps/monitoring-pdps", |
There was a problem hiding this comment.
| id: "how-to/monitoring-pdps/monitoring-pdps", | |
| id: "how-to/monitoring-pdps", |
No description provided.