Documentation: Enhanced Studio documentation #24558
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yekalkan
changed the title
monitoring applications
enisn
approved these changes
Jan 12, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request enhances the ABP Studio documentation by adding more detailed explanations, clarifying existing content, and fixing inconsistencies across multiple documentation files. The changes improve user understanding of Studio features including Suite integration, Solution Explorer capabilities, application running/monitoring, and Kubernetes integration.
Changes:
- Enhanced Suite documentation with clearer explanations of context menu options and automatic version matching
- Expanded Solution Explorer documentation with detailed descriptions of Analyze features, Open With options, and README support
- Improved Running Applications documentation with comprehensive property descriptions and Open With submenu details
- Significantly enhanced Monitoring Applications documentation with detailed tables, subsections, and feature explanations
- Fixed typo in Kubernetes documentation ("Refrest" → "Refresh")
- Added new Metadata and Secrets concepts with hierarchical structure explanations
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/en/studio/working-with-suite.md | Enhanced context menu documentation and added automatic version matching section |
| docs/en/studio/solution-explorer.md | Added Analyze feature documentation, Open With options, and README support across solution/module/package levels |
| docs/en/studio/running-applications.md | Expanded Properties section with detailed explanations and added Open With submenu documentation |
| docs/en/studio/monitoring-applications.md | Comprehensive restructuring with detailed tables, subsections, and feature descriptions for monitoring features |
| docs/en/studio/kubernetes.md | Fixed typo in context menu option and added Kubernetes service context menu documentation |
| docs/en/studio/concepts.md | Added comprehensive Metadata and Secrets documentation with hierarchy and common keys |
| @@ -215,13 +222,28 @@ We can open the *Application Properties* window to change *Launch url*, *Health | |||
|
|
|||
|  | |||
There was a problem hiding this comment.
There's a typo in the filename reference. It should be "solution-runner-properties" not "solutioın-runner-properties" (note the special character ı instead of i).
Suggested change
|  | |
|  |
| - **Health check endpoint**: Endpoint for controlling the health status of the application periodically. If the application doesn't have a endpoint for health check, you can enter `/` to use the home page of the application as health check endpoint. | ||
| - **Launch URL**: The URL used when browsing the application. This is the address where the application is accessible. | ||
| - **Kubernetes service**: A regex pattern to match Kubernetes service names. When connected to a Kubernetes cluster, ABP Studio uses this pattern to find the corresponding Kubernetes service and uses its URL instead of the Launch URL. This applies to *Browse*, *Copy URL*, and *Health UI* features. For example, if your Helm chart creates a service named `bookstore-identity-service`, you can use `.*-identity-service` or `bookstore-identity.*` as the pattern. For [microservice](../get-started/microservice.md) templates, this is pre-configured. | ||
| - **Health check endpoint**: Endpoint for controlling the health status of the application periodically. If the application doesn't have an endpoint for health check, you can enter `/` to use the home page of the application as health check endpoint. |
There was a problem hiding this comment.
Grammar error: "an endpoint" should be used instead of "a endpoint" because "endpoint" starts with a vowel sound.
Co-authored-by: Copilot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.