Merge branch rel-10.1 with rel-10.0 #24554
Conversation
…ection Documentation: Updated tools section in Monitoring Applications document
There was a problem hiding this comment.
Pull request overview
This is an automated merge from rel-10.1 to rel-10.0 that enhances the documentation for the Tools feature in ABP Studio's monitoring capabilities. The changes transform a brief, basic description into comprehensive documentation with detailed usage instructions and configuration examples.
- Expanded documentation from 3 lines to nearly 100 lines with structured sections covering tool properties, activation states, and Kubernetes integration
- Added detailed JSON configuration examples showing pre-configured infrastructure tools (Grafana, RabbitMQ, Redis Commander, pgAdmin, Seq)
- Included a new screenshot (tools-create.png) showing the Create Tool dialog interface
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/en/studio/monitoring-applications.md | Comprehensive rewrite of the Tools section with detailed subsections covering tool creation, properties, activation states, Kubernetes integration, configuration examples, and default credentials |
| docs/en/studio/images/monitoring-applications/tools-create.png | New screenshot added to illustrate the Create Tool dialog interface |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| | Property | Required | Description | | ||
| |----------|----------|-------------| | ||
| | **Name** | Yes | A unique identifier displayed as the tab header. | |
There was a problem hiding this comment.
The description states "A unique identifier displayed as the tab header" but it doesn't clarify whether this name must be unique across all tools or just within the current profile. Consider clarifying this to avoid confusion.
| | **Name** | Yes | A unique identifier displayed as the tab header. | | |
| | **Name** | Yes | A unique identifier for the tool within the current profile, displayed as the tab header. | |
| |-------|-----------|----------| | ||
| | **Always Active** | No *Related Container* specified | Tool is always accessible regardless of container state. | | ||
| | **Container-Dependent** | *Related Container* specified | Tool activates only when the specified Docker container is running. | | ||
| | **Kubernetes-Aware** | *Related Kubernetes Service* specified | Tool URL switches between local and Kubernetes endpoints automatically. | |
There was a problem hiding this comment.
The table row for "Kubernetes-Aware" only mentions "Related Kubernetes Service specified" but doesn't indicate whether this is mutually exclusive with "Related Container" or if they work together. Based on the JSON example and documentation, both can be specified together. Consider clarifying in the Condition column that this applies "when Related Kubernetes Service is specified (optionally with Related Container)" to avoid ambiguity.
| | **Kubernetes-Aware** | *Related Kubernetes Service* specified | Tool URL switches between local and Kubernetes endpoints automatically. | | |
| | **Kubernetes-Aware** | *Related Kubernetes Service* specified (optionally with *Related Container*) | Tool URL switches between local and Kubernetes endpoints automatically. | |
This PR generated automatically to merge rel-10.1 with rel-10.0. Please review the changed files before merging to prevent any errors that may occur.