Skip to content

Commit e765573

Browse files
Fixing lint errors
1 parent 2ce0f6d commit e765573

26 files changed

Lines changed: 365 additions & 380 deletions

File tree

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/csharp/extensibility-api-howtos/build-todo-example-extension.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -750,27 +750,27 @@ This HTML page provides a simple interface styled with Tailwind CSS. The JavaScr
750750

751751
1. Add a helper function to simplify the call to the browser API:
752752

753-
```javascript
754-
function postMessage(message, data) {
755-
window.chrome.webview.postMessage({ message, data });
756-
}
757-
```
753+
```javascript
754+
function postMessage(message, data) {
755+
window.chrome.webview.postMessage({ message, data });
756+
}
757+
```
758758

759-
1. Initialize message handling and respond to incoming messages:
759+
2. Initialize message handling and respond to incoming messages:
760760

761-
```javascript
762-
// Register message handler.
763-
window.chrome.webview.addEventListener("message", handleMessage);
764-
// Indicate that you are ready to receive messages.
765-
postMessage("MessageListenerRegistered");
761+
```javascript
762+
// Register message handler.
763+
window.chrome.webview.addEventListener("message", handleMessage);
764+
// Indicate that you are ready to receive messages.
765+
postMessage("MessageListenerRegistered");
766766

767-
async function handleMessage(event) {
768-
const { message, data } = event.data;
769-
if (message === "RefreshToDos") {
770-
await refreshToDos();
771-
}
772-
}
773-
```
767+
async function handleMessage(event) {
768+
const { message, data } = event.data;
769+
if (message === "RefreshToDos") {
770+
await refreshToDos();
771+
}
772+
}
773+
```
774774

775775
{{% alert color="warning" %}}
776776

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/web/get-started.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This section will show you how to build and test an extension.
3030
### Create a Test App
3131

3232
1. Create a new app using the **Blank Web App** template.
33-
1. Install the [Studio Pro Web Extension Template](https://github.com/mendix/web-extension-template) from GitHub using the instructions in the repository.
33+
2. Install the [Studio Pro Web Extension Template](https://github.com/mendix/web-extension-template) from GitHub using the instructions in the repository.
3434

3535
### Building the Extension
3636

@@ -54,7 +54,7 @@ You can explore the extension to understand what it does when it is installed. D
5454

5555
Reading through the source code you should see the following:
5656

57-
a. Line 7 adds a menu
57+
a. Line 7 adds a menu
5858

5959
```typescript
6060
await studioPro.ui.extensionsMenu.add({
@@ -64,24 +64,24 @@ You can explore the extension to understand what it does when it is installed. D
6464
});
6565
```
6666

67-
1. Line 14 opens a tab
68-
69-
```typescript
70-
// Open a tab when the menu item is clicked
71-
studioPro.ui.extensionsMenu.addEventListener("menuItemActivated", (args) => {
72-
if (args.menuId === "myextension.ShowTabMenuItem") {
73-
studioPro.ui.tabs.open(
74-
{
75-
title: "My Extension Tab",
76-
},
77-
{
78-
componentName: "extension/myextension",
79-
uiEntrypoint: "tab",
80-
}
81-
);
82-
}
83-
});
84-
```
67+
b. Line 14 opens a tab
68+
69+
```typescript
70+
// Open a tab when the menu item is clicked
71+
studioPro.ui.extensionsMenu.addEventListener("menuItemActivated", (args) => {
72+
if (args.menuId === "myextension.ShowTabMenuItem") {
73+
studioPro.ui.tabs.open(
74+
{
75+
title: "My Extension Tab",
76+
},
77+
{
78+
componentName: "extension/myextension",
79+
uiEntrypoint: "tab",
80+
}
81+
);
82+
}
83+
});
84+
```
8585

8686
When you install the extension, you will see a new menu item within Studio Pro.
8787

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/extensibility-api/web/web-extensions-howtos/dockable-pane-api.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ Your `loaded()` method should now look like this:
174174
Create a new web view endpoint where you define the user interface that will be rendered within the pane. You can use and rename the existing endpoint. Follow the steps below:
175175

176176
1. Rename `ui/index.tsx` to `ui/tab.tsx`.
177-
1. Add the new endpoint file, `ui/dockablepane.tsx`, by copying `ui/tab.tsx`.
177+
2. Add the new endpoint file, `ui/dockablepane.tsx`, by copying `ui/tab.tsx`.
178178

179179
You must also alter the `vite.config.ts` and `manifest.json` files to bind to the correct endpoint, as described in the following sections:
180180

@@ -255,13 +255,13 @@ You will close your pane using a new menu item. Follow the steps below:
255255

256256
1. Add a new sub-menu item to the menu on line 11.
257257

258-
```typescript {linenos=table linenostart=11}
259-
{ menuId: "myextension.HideDockMenuItem", caption: "Hide dock pane" },
260-
```
258+
```typescript {linenos=table linenostart=11}
259+
{ menuId: "myextension.HideDockMenuItem", caption: "Hide dock pane" },
260+
```
261261

262-
1. Alter the event handler for the new menu at the end of the loaded method:
262+
2. Alter the event handler for the new menu at the end of the loaded method:
263263

264-
```typescript
264+
```typescript
265265
// Open a tab when the menu item is clicked
266266
studioPro.ui.extensionsMenu.addEventListener(
267267
"menuItemActivated",
@@ -285,7 +285,7 @@ You will close your pane using a new menu item. Follow the steps below:
285285
}
286286
}
287287
);
288-
```
288+
```
289289

290290
The loaded method should now look like this:
291291

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/extensibility-api/csharp/extensibility-api-howtos/build-todo-example-extension.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -750,27 +750,27 @@ This HTML page provides a simple interface styled with Tailwind CSS. The JavaScr
750750

751751
1. Add a helper function to simplify the call to the browser API:
752752

753-
```javascript
754-
function postMessage(message, data) {
755-
window.chrome.webview.postMessage({ message, data });
756-
}
757-
```
753+
```javascript
754+
function postMessage(message, data) {
755+
window.chrome.webview.postMessage({ message, data });
756+
}
757+
```
758758

759-
1. Initialize message handling and respond to incoming messages:
759+
2. Initialize message handling and respond to incoming messages:
760760

761-
```javascript
762-
// Register message handler.
763-
window.chrome.webview.addEventListener("message", handleMessage);
764-
// Indicate that you are ready to receive messages.
765-
postMessage("MessageListenerRegistered");
761+
```javascript
762+
// Register message handler.
763+
window.chrome.webview.addEventListener("message", handleMessage);
764+
// Indicate that you are ready to receive messages.
765+
postMessage("MessageListenerRegistered");
766766

767-
async function handleMessage(event) {
768-
const { message, data } = event.data;
769-
if (message === "RefreshToDos") {
770-
await refreshToDos();
771-
}
772-
}
773-
```
767+
async function handleMessage(event) {
768+
const { message, data } = event.data;
769+
if (message === "RefreshToDos") {
770+
await refreshToDos();
771+
}
772+
}
773+
```
774774

775775
{{% alert color="warning" %}}
776776

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

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -87,16 +87,12 @@ Import the preferences API and use it to fetch the user’s preferences.
8787
);
8888
```
8989

90-
{{% alert color="info" %}}
91-
The function is `async` in order for you to use `await` when fetching the preferences.
92-
{{% /alert %}}
90+
{{% alert color="info" %}} The function is `async` in order for you to use `await` when fetching the preferences.
91+
{{% /alert %}}
9392

94-
1. Use the fetched preferences to update the text in the message box so you can see the user's current theme and language.
95-
96-
The `getPreferences()` function returns an object with two properties:
97-
98-
* Themeeither **Light** or **Dark**, representing the current theme setting in Studio Pro
99-
* Languagea string representing the current language setting, such as `en_US` for English (United States)
93+
3. Use the fetched preferences to update the text in the message box so you can see the user's current theme and language. The `getPreferences()` function returns an object with two properties:
94+
* Themeeither **Light** or **Dark**, representing the current theme setting in Studio Pro
95+
* Languagea string representing the current language setting, such as `en_US` for English (United States)
10096

10197
The complete `src/main/index.ts` file should now look like this:
10298

content/en/docs/deployment/mx-azure/configuration/mx-azure-direct-database-access.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,21 @@ By default, the read replica for Postgres database is disabled. To enable it, pe
3030

3131
1. On the **Provision > Database Settings** section of the **Initialize Cluster** page, set the **Enable Read Replica** option to **Yes**.
3232

33-
{{% alert color="info" %}} For existing clusters, you can also enable or disable the read replica in the **Edit Cluster** flow.{{% /alert %}}
33+
{{% alert color="info" %}} For existing clusters, you can also enable or disable the read replica in the **Edit Cluster** flow.{{% /alert %}}
3434

35-
1. Click **Next** to initialize the cluster.
35+
2. Click **Next** to initialize the cluster.
3636

3737
{{< figure src="/attachments/deployment/mx-azure/enableReadReplica.png" class="no-border" >}}
3838

3939
After the cluster is initialized, the read replica for PostgreSQL database is enabled, and a read replica for the PostgreSQL database has been created automatically.
4040

4141
{{< figure src="/attachments/deployment/mx-azure/readReplicaEnabled.png" class="no-border" >}}
4242

43-
2. Copy the address value from the record set within the private DNS zone created for your PostgreSQL database. You can find this private DNS zone in the [Managed Resource Group of your Mendix on Azure environment](/developerportal/deploy/mendix-on-azure/configuration/#mrg).
43+
3. Copy the address value from the record set within the private DNS zone created for your PostgreSQL database. You can find this private DNS zone in the [Managed Resource Group of your Mendix on Azure environment](/developerportal/deploy/mendix-on-azure/configuration/#mrg).
4444

4545
{{< figure src="/attachments/deployment/mx-azure/copyAddressValue.png" class="no-border" >}}
4646

47-
3. Add Entra ID users who should be able to access the replica database by performing the following steps:
47+
4. Add Entra ID users who should be able to access the replica database by performing the following steps:
4848

4949
1. In the Azure portal, go to the [Managed Resource Group of your Mendix on Azure environment](/developerportal/deploy/mendix-on-azure/configuration/#mrg).
5050
2. Select the PostgreSQL master database resou.rce (type: Azure Database for PostgreSQL Flexible Server).

content/en/docs/deployment/mx-azure/mx-azure-backups.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,18 @@ You must have **Manage Apps Backups** permission for the namespace to use this f
2525
2. Click **Backups** in the navigation pane.
2626
3. Choose the environment to back up from the environment dropdown.
2727

28-
{{% alert color="info" %}}
28+
{{% alert color="info" %}}
29+
<!-- Need to do it this way to satisfy linter and get correct format-->
2930
Backups cannot be created while the environment is in any of these states:
3031

3132
* Creation in progress
3233
* Creation failed
3334
* Deployment package is being deployed
34-
* Environment is in transition state (runtime processing)
35-
{{% /alert %}}
35+
* Environment is in transition state (runtime processing)
36+
{{% /alert %}}
3637

3738
1. Click **Create Backup**.
38-
2. Monitor progress in the **Status** column.
39+
1. Monitor progress in the **Status** column.
3940

4041
{{% alert color="info" %}}
4142
Tables are locked during backup creation, so if you attempt to start the environment while a backup is in progress, you may encounter a timeout error. Wait for backup completion before restarting.

content/en/docs/deployment/private-cloud/private-cloud-cluster/_index.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1359,20 +1359,20 @@ You can invite additional members to the namespace, and configure their role dep
13591359
2. **Administrator** – a standard set of rights needed by an administrator, these are listed on the screen
13601360
3. **Custom** – This option is now deprecated.
13611361

1362-
{{% alert color="info" %}}
1363-
The custom permission if needed to be edited, a role need to be assigned with appropriate permissions. See [Roles and Permissions](/developerportal/deploy/private-cloud-cluster/#rolesandpermissions) for more information.
1364-
{{% /alert %}}
1362+
{{% alert color="info" %}}
1363+
The custom permission if needed to be edited, a role need to be assigned with appropriate permissions. See [Roles and Permissions](/developerportal/deploy/private-cloud-cluster/#rolesandpermissions) for more information.
1364+
{{% /alert %}}
13651365

1366-
{{% alert color="info" %}}
1367-
If an application is in the Stopped state, the scaling does not come into effect until the application is Started. This means that you have to click **Start application** in order for the changes to be sent to the cluster.
1368-
Along with this, we have also decoupled the permission for modifying the MxAdmin password and managing environments.
1369-
{{% /alert %}}
1366+
{{% alert color="info" %}}
1367+
If an application is in the Stopped state, the scaling does not come into effect until the application is Started. This means that you have to click **Start application** in order for the changes to be sent to the cluster.
1368+
Along with this, we have also decoupled the permission for modifying the MxAdmin password and managing environments.
1369+
{{% /alert %}}
13701370

1371-
1. Click **Send Invite** to send an invite to this person.
1371+
6. Click **Send Invite** to send an invite to this person.
13721372

13731373
{{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/AutoAcceptInvite.png" class="no-border" >}}
13741374

1375-
2. If you have not enabled the **Automatically accept invites** option, the user will receive an email and will be required to follow a link to confirm that they want to join this namespace. They will need to be logged in to Mendix when they follow the confirmation link.
1375+
7. If you have not enabled the **Automatically accept invites** option, the user will receive an email and will be required to follow a link to confirm that they want to join this namespace. They will need to be logged in to Mendix when they follow the confirmation link.
13761376

13771377
##### Editing and Removing Members
13781378

content/en/docs/deployment/private-cloud/private-cloud-cluster/private-cloud-global-operator.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ To install and configure the Global Operator, perform the following steps:
5151
2. [Sign into the Platform](/developerportal/deploy/standard-operator/#openshift-signin).
5252
3. Perform the [Base Installation](/developerportal/deploy/standard-operator/#base-installation).
5353

54-
{{< figure src="/attachments/deployment/private-cloud/global-operator/global-operator6.png" class="no-border" >}}
54+
{{< figure src="/attachments/deployment/private-cloud/global-operator/global-operator6.png" class="no-border" >}}
5555

56-
1. You can apply the custom TLS and proxy settings in the Global Operator main namespace by just selecting only the **Custom TLS** and **Proxy** options in the Configuration Tool.
56+
4. You can apply the custom TLS and proxy settings in the Global Operator main namespace by just selecting only the **Custom TLS** and **Proxy** options in the Configuration Tool.
5757

5858
{{% alert color="info" %}}Base installation can only be performed on the Global Operator main namespace. Along with base installation, you can also apply custom TLS and proxy settings. However, other configurations such as storage plan, database plan, ingress configuration, or registry configuration are not supported in Global Operator main namespace.{{% /alert %}}
5959

content/en/docs/marketplace/platform-supported-content/modules/azure/azure-blob-storage-connector.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ To use this operation in your microflow, perform the following steps:
121121
7. Configure a method to trigger the `ACT_PutBlob` microflow.
122122
For example, you can call the microflow with a custom button on a page in your app. For an example of how this can be implemented, see [Creating a Custom Save Button with a Microflow](/refguide/creating-a-custom-save-button/).
123123

124-
The operation returns a **PutBlobRequestResponse** object, which is empty on itself, only its generization AbstractResponse entity contains the http status code and optional the http reason phrase.
124+
The operation returns a **PutBlobRequestResponse** object, which is empty on itself, only its generalization AbstractResponse entity contains the http status code and optional the http reason phrase.
125125

126126
#### GET_v1_Azure_GetBlob
127127

@@ -142,7 +142,7 @@ To use this operation in your microflow, perform the following steps:
142142
3. Call the **GET_v1_Azure_GetBlob** action in your microflow.
143143

144144
The operation returns a **GetBlobResponse** object with the returned Blob associated with it.
145-
Its generization AbstractResponse entity contains the http status code and optional the http reason phrase.
145+
Its generalization AbstractResponse entity contains the http status code and optional the http reason phrase.
146146

147147
#### DELETE_v1_Azure_DeleteBlob
148148

@@ -161,7 +161,7 @@ To use this operation in your microflow, perform the following steps:
161161
3. Call the **DELETE_v1_Azure_DeleteBlob** action in your microflow.
162162

163163
The operation returns a **DeleteBlobResponse** object, which is a generalization of **AbstractResponse** and contains the **StatusCode** and **ReasonPhrase**.
164-
Its generization AbstractResponse entity contains the http status code and optional the http reason phrase.
164+
Its generalization AbstractResponse entity contains the http status code and optional the http reason phrase.
165165

166166
#### GET_v1_Azure_ListBlobs
167167

@@ -182,7 +182,7 @@ To use this operation in your microflow, perform the following steps:
182182
3. Call the **GET_v1_Azure_ListBlobs** action in your microflow.
183183

184184
The operation returns a list of **Blob** objects associated to the **ListBlobResponse**, which is a generalization of **AbstractResponse** and contains the **StatusCode** and **ReasonPhrase**.
185-
Its generization AbstractResponse entity contains the http status code and optional the http reason phrase.
185+
Its generalization AbstractResponse entity contains the http status code and optional the http reason phrase.
186186

187187
#### GET_v1_Azure_ListContainers
188188

@@ -202,7 +202,7 @@ To use this operation in your microflow, perform the following steps:
202202
3. Call the **GET_v1_Azure_ListContainers** action in your microflow.
203203

204204
The operation returns a list of **Container** objects associated to the **ListContainersResponse**, which is a generalization of **AbstractResponse** and contains the **StatusCode** and **ReasonPhrase**.
205-
Its generization AbstractResponse entity contains the http status code and optional the http reason phrase.
205+
Its generalization AbstractResponse entity contains the http status code and optional the http reason phrase.
206206

207207
#### POST_v1_Azure_GetApplicationBearerToken
208208

@@ -219,7 +219,7 @@ To use this operation in your microflow, perform the following steps:
219219
2. Call the **POST_v1_Azure_GetApplicationBearerToken** action in your microflow.
220220

221221
The operation returns a **GetApplicationBearerTokenResponse** object with the returned **EntraCredentialsUsage** associated to it. The **EntraCredentialsUsage** entity is a specialization of the **EntraCredentials** entity so the returned object can be used to authenticate Blob operations.
222-
Its generization AbstractResponse entity contains the http status code and optional the http reason phrase.
222+
Its generalization AbstractResponse entity contains the http status code and optional the http reason phrase.
223223

224224
#### POST_v1_Azure_GetUserDelegationKey{#get-user-delegation-key}
225225

0 commit comments

Comments
 (0)