Skip to content

Commit 6829143

Browse files
committed
Review VC API
1 parent 783a538 commit 6829143

File tree

1 file changed

+10
-9
lines changed
  • content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos

1 file changed

+10
-9
lines changed

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/web/web-extensions-howtos/version-control-api.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,25 @@ This how-to describes how to display version control information in Studio Pro.
1010

1111
## Prerequisites
1212

13-
This how-to uses the results of [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/). Complete that how-to before starting this one. You should also be familiar with creating menus as described in [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).
13+
Before starting this how-to, make sure you have completed the following prerequisites:
14+
15+
* This how-to uses the results of [Get Started with the Web Extensibility API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/getting-started/). Complete that how-to before starting this one.
16+
* Make sure you are familiar with creating menus, as described in [Create a Menu Using Web API](/apidocs-mxsdk/apidocs/web-extensibility-api-11/menu-api/).
1417

1518
## Showing Version Control Information
1619

17-
The extension creates a menu item labeled **Current version control system**. When the menu is activated, it fetches version control details (system type, branch, last commit) and displays them in a message box.
20+
The extension creates a menu item named **Current version control system**. When the menu is activated, it fetches version control details (system type, branch, last commit) and displays them in a message box.
1821

1922
### Set Up the Extension Structure
23+
2024
In the example below, you create one menu item that will show version control details in a message box.
2125

2226
It performs the following actions:
23-
1. Creates a menu item labeled "Current version control system"
27+
28+
1. Creates a menu item named **Current version control system**
2429
2. Listens for when the menu item is clicked
25-
3. When clicked, retrieves the version control information which includes:
26-
* The type of version control system (like Git)
30+
3. When clicked, it retrieves the version control information which includes:
31+
* The type of version control system (for example, Git)
2732
* Current branch name
2833
* Last commit details (SHA, author, message, and date)
2934
4. Displays this information in a message box
@@ -77,10 +82,6 @@ export const component: IComponent = {
7782
}
7883
```
7984

80-
## Conclusion
81-
82-
You have seen how to add a menu in Studio Pro that shows version control details for your app, making it easy for users to see the branch and head commit information.
83-
8485
## Extensibility Feedback
8586

8687
If you would like to provide us with additional feedback, you can complete a small [survey](https://survey.alchemer.eu/s3/90801191/Extensibility-Feedback).

0 commit comments

Comments
 (0)