Skip to content

Commit 73aaae7

Browse files
Merge pull request #10299 from mendix/lint-docs
[Auto] Lint docs
2 parents bc06360 + 3f7e3cb commit 73aaae7

File tree

15 files changed

+39
-42
lines changed

15 files changed

+39
-42
lines changed

content/en/docs/apidocs-mxsdk/apidocs/deployment/build-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -296,9 +296,9 @@ An object with the following key-value pairs:
296296

297297
{{% alert color="warning" %}}
298298

299-
- For apps using SVN for version control, this call will build the specified revision even if that revision is not on the specified branch.
299+
* For apps using SVN for version control, this call will build the specified revision even if that revision is not on the specified branch.
300300

301-
- For apps using Git for version control, using a short commit hash can cause timeouts with large repositories. Mendix recommends using the full commit hash
301+
* For apps using Git for version control, using a short commit hash can cause timeouts with large repositories. Mendix recommends using the full commit hash
302302
{{% /alert %}}
303303

304304
##### Example

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,11 @@ Implement the code described in the [Code Descriptions](#code-descriptions) sect
6767
};
6868
```
6969

70-
## Code Descriptions {#code-descriptions}
70+
## Code Descriptions {#code-descriptions}
7171

7272
The following sections explain the various parts of the code.
7373

74-
### saveFile
74+
### saveFile
7575

7676
The `saveFile` callback calls the `putFile` API. It sets the file name to `HelloWorld.txt` and the content to `Hello world from a file!`.
7777

@@ -85,7 +85,7 @@ Implement the code described in the [Code Descriptions](#code-descriptions) sect
8585
};
8686
```
8787

88-
### loadFile
88+
### loadFile
8989

9090
The `loadFile` callback calls the `getFile` API. It requests to load `HelloWorld.txt`, then shows a message box that displays the content of the file.
9191

@@ -99,7 +99,7 @@ Implement the code described in the [Code Descriptions](#code-descriptions) sect
9999
};
100100
```
101101

102-
### deleteFile
102+
### deleteFile
103103

104104
The `deleteFile` callback calls the `deleteFile` API. It requests to delete `HelloWorld.txt`.
105105

@@ -110,7 +110,7 @@ Implement the code described in the [Code Descriptions](#code-descriptions) sect
110110
};
111111
```
112112

113-
### Adding Buttons
113+
### Adding Buttons
114114

115115
The final part of the code adds three new buttons which, when clicked, call the callbacks described above.
116116

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ A menu has the following properties:
2929
| `hasSeparatorAfter` <br> (default: `false`) | Adds a visual separator after the item |
3030
| `enabled` <br> (default: `true`) | Indicates that the menu item notifies the listener when clicked |
3131

32-
3332
{{< figure src="/attachments/apidocs-mxsdk/apidocs/extensibility-api/web/menus/grouped_menus.png" width="300" >}}
3433

3534
## Creating a Simple Menu

content/en/docs/deployment/mx-azure/configuration/_index.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,31 +29,31 @@ The [Mendix on Azure Portal](https://mendixonazure.mendix.com) provides a variet
2929
| --- | --- | --- |
3030
| Load Balancer Type | Controls whether your applications are reachable publicly or only privately via your own (Virtual) Network or Private Endpoints. | Yes |
3131
| AKS Node CIDR IP Range | Defines the IP address range on the VNet hosting AKS cluster nodes. This can only be set during initial deployment and should align with your organization's IP plan if you plan to connect Mendix on Azure to other networks via peering. Default is acceptable when no interconnection is required. | No |
32-
| AKS Network Isolated Cluster | When set to true will lead to a cluster without egress configuration, please carefully read the [documentation on cluster networking modes ](/developerportal/deploy/mendix-on-azure/configuration/ingress-egress/) to understand the implications | No |
32+
| AKS Network Isolated Cluster | When set to true will lead to a cluster without egress configuration, please carefully read the [documentation on cluster networking modes](/developerportal/deploy/mendix-on-azure/configuration/ingress-egress/) to understand the implications | No |
3333

3434
For more information, see [Configuring Ingress and Egress](/developerportal/deploy/mendix-on-azure/configuration/ingress-egress/).
3535

3636
### Application Cluster Settings
3737

38-
| Advanced Option | Description | Editable after Initial Creation |
39-
| --- | --- | --- |
38+
| Advanced Option | Description | Editable after Initial Creation |
39+
| --- | --- | --- |
4040
| AKS Node VM Size | The VM size used on the AKS application cluster. Default should suffice in most circumstances. You can change the default size in case of performance issues (for example, using non-burstable instances can improve Mendix Runtime performance), or if your Mendix app environment instances require more RAM than available under current selection. In case a Mendix app environment instance is configured to require more RAM than available on the current VM size, switching to a larger VM size might be required to have the app instance start at all. | Yes |
41-
| AKS Maximum Node Count | The number of available cluster nodes will be increased and decreased automatically based on the combined capacity requirement of all deployed Mendix apps. This setting controls the upper limit to the number of available nodes in order to avoid cost surprises. | Yes |
42-
| AKS Service Tier | The [AKS service tier](https://learn.microsoft.com/en-us/azure/aks/free-standard-pricing-tiers) determines the service level Microsoft provides on the Mendix on Azure Kubernetes cluster control plane. This does not impact application performance, only Microsoft's SLA. The Free tier is sufficient in most situations. Standard can be considered by organizations that value a financially backed SLA. For information about the associated costs, refer to Microsoft documentation. The Premium tier does not offer any additional value in combination with Mendix on Azure and is not recommended. | Yes |
41+
| AKS Maximum Node Count | The number of available cluster nodes will be increased and decreased automatically based on the combined capacity requirement of all deployed Mendix apps. This setting controls the upper limit to the number of available nodes in order to avoid cost surprises. | Yes |
42+
| AKS Service Tier | The [AKS service tier](https://learn.microsoft.com/en-us/azure/aks/free-standard-pricing-tiers) determines the service level Microsoft provides on the Mendix on Azure Kubernetes cluster control plane. This does not impact application performance, only Microsoft's SLA. The Free tier is sufficient in most situations. Standard can be considered by organizations that value a financially backed SLA. For information about the associated costs, refer to Microsoft documentation. The Premium tier does not offer any additional value in combination with Mendix on Azure and is not recommended. | Yes |
4343

4444
### Database Settings
4545

46-
| Advanced Option | Description | Editable after initial creation |
47-
| --- | --- | --- |
48-
| Enable Read Replica | Enables a read replica for direct app database access. For more information, see [Direct Database Access](/developerportal/deploy/mendix-on-azure/configuration/direct-database-access/). | Yes |
49-
| Compute Tier and Size | Specifies the DB Compute Tier for the shared PostgreSQL database used by all Mendix app environments. You may need to increase it for better app performance. For more information, see [Compute options in Azure Database for PostgreSQL](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-compute) in Microsoft documentation. | Yes |
50-
| Storage Performance Tier | Specifies the Storage Performance Tier for the shared PostgreSQL database. Consider increasing if performance issues arise. For more information, see [Storage in Azure Database for PostgreSQL](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-storage) in Microsoft documentation. | Yes |
46+
| Advanced Option | Description | Editable after initial creation |
47+
| --- | --- | --- |
48+
| Enable Read Replica | Enables a read replica for direct app database access. For more information, see [Direct Database Access](/developerportal/deploy/mendix-on-azure/configuration/direct-database-access/). | Yes |
49+
| Compute Tier and Size | Specifies the DB Compute Tier for the shared PostgreSQL database used by all Mendix app environments. You may need to increase it for better app performance. For more information, see [Compute options in Azure Database for PostgreSQL](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-compute) in Microsoft documentation. | Yes |
50+
| Storage Performance Tier | Specifies the Storage Performance Tier for the shared PostgreSQL database. Consider increasing if performance issues arise. For more information, see [Storage in Azure Database for PostgreSQL](https://learn.microsoft.com/en-us/azure/postgresql/flexible-server/concepts-storage) in Microsoft documentation. | Yes |
5151

5252
### Observability Settings
5353

54-
| Advanced Option | Description | Editable after initial creation |
55-
| --- | --- | --- |
56-
| Managed Grafana Accessibility | Determines whether the Managed Grafana observability dashboard is accessible publicly or only via private endpoints. [Virtual network peering](/developerportal/deploy/mendix-on-azure/configuration/interconnecting-networks/#network-peering) is required for private access. | Yes |
54+
| Advanced Option | Description | Editable after initial creation |
55+
| --- | --- | --- |
56+
| Managed Grafana Accessibility | Determines whether the Managed Grafana observability dashboard is accessible publicly or only via private endpoints. [Virtual network peering](/developerportal/deploy/mendix-on-azure/configuration/interconnecting-networks/#network-peering) is required for private access. | Yes |
5757

5858
## Self-service configuration available via Microsoft Azure Portal
5959

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ You must have **Manage Apps Backups** permission for the namespace to use this f
2727

2828
{{% alert color="info" %}}
2929
Backups cannot be created while the environment is in any of these states:
30+
3031
* Creation in progress
3132
* Creation failed
3233
* Deployment package is being deployed

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ To deploy the solution, perform the following steps:
4444

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

47-
4847
7. Identify the entry belonging to the Managed Application you deployed in previous steps. In the **Actions** column, click the dropdown menu icon, and then select **Initialize**.
4948

5049
The preflight check launches to verify the conditions are in place to successfully initialize a Mendix on Azure cluster.

content/en/docs/deployment/mx-azure/mx-azure-security-and-compliance.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ The automatic SOC2 assessment currently has identified the following compliance
2323
| AKS - cluster VNET: [All Internet traffic should be routed via your deployed Azure Firewall](https://www.azadvertizer.net/azpolicyadvertizer/fc5e4038-4584-4632-8c85-c0448d374b2c.html) | This is not automated, but customers can deploy their own Firewall if required. |
2424
| Storage Account: [Storage accounts should use customer-managed key for encryption](https://www.azadvertizer.net/azpolicyadvertizer/6fac406b-40ca-413b-bf8e-0bf964659c25.html) | The cluster is deployed and managed by Mendix, so this is not needed. |
2525

26-
2726
### Access to Customer Environments by Mendix
2827

2928
Mendix accesses customer environments securely by leveraging native Azure capabilities and adhering to Microsoft's best practices:

content/en/docs/developerportal/app-insights/feedback.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,8 @@ The following options are available:
134134

135135
* **Ungroup** – Ungroup all feedback in the group. This action does not delete the group.
136136
* **Delete Group** – Delete the group and all feedback within it. This action is destructive and, once you delete a group with feedback, the feedback is also deleted.
137-
* Group Name – The name of the group, which you can edit by clicking it.
138-
* **Description** – The description of the group.
137+
* **Group Name** – The name of the group, which you can edit by clicking it.
138+
* **Description** – The description of the group.
139139
* **Tags** – Any tags assigned to the group.
140140
You can either select a tag from the drop-down list, or create a new tag by typing its name inside the text box, then clicking **Create [the tag name]**.
141141
A tag should contain maximum 50 characters.

content/en/docs/howto9/integration/use-a-client-certificate.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,3 @@ To configure client certificates in Mendix Cloud, follow these steps:
7878
3. Close the **Details** screen.
7979
8080
6. Click **Stop application** and then **Start application**.
81-

content/en/docs/mendix-portal/mendix-profile/user-settings.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ This is what you can do on the [Profile](https://user-settings.mendix.com/link/p
2929
* Choose to make your profile public by clicking **Make Profile Public**. This allows the Mendix community to view your profile.
3030
To make your public profile private again, click **Make Profile Private**.
3131

32-
3332
* Add a **Recovery Email** address, which is useful if you lose access to your account or Mendix Profile. You can provide a non-business email address for this.
3433

3534
### Merging Profiles {#merging-profiles}

0 commit comments

Comments
 (0)