Skip to content

Commit e3f270c

Browse files
[Auto] Lint docs (#11282)
* Run markdownlint-cli2 on docs to find (and correct) linting errors. * lint fixing after github action run --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Olufunke Moronfolu <olufunke.moronfolu@mendix.com>
1 parent d775509 commit e3f270c

163 files changed

Lines changed: 368 additions & 376 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/en/docs/apidocs-mxsdk/apidocs/audit-logs-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,4 @@ Two types of Authorization headers are supported: `Bearer` (Client credentials o
3434

3535
The following API reference includes information on which scope and token type is required for each endpoint.
3636

37-
{{< swaggerui src="/openapi-spec/audit-logging-v1.yaml" >}}
37+
{{< swaggerui src="/openapi-spec/audit-logging-v1.yaml" >}}

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-11/pluggable-widgets/pluggable-widgets-property-types.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,6 @@ Then the Studio Pro UI for the property appears like this:
482482

483483
### Action {#action}
484484

485-
486485
The action property type allows a user to configure an action which can do things like call nanoflows, save changes, and open pages.
487486

488487
If a `dataSource` attribute is not specified, the client will receive an `ActionValue` representing the action or `undefined` if the **Do nothing** action was selected.
@@ -838,7 +837,6 @@ The [`action`](#action), [`attribute`](#attribute), [`association`](#association
838837

839838
### Selection {#selection}
840839

841-
842840
The selection property allows a widget to read and set a selection that can be used in actions, expressions, or a `Listen to` data source of a data view.
843841

844842
#### XML Attributes
@@ -909,7 +907,6 @@ Label property allows a pluggable widget to have labeling functionality similar
909907

910908
#### setLabel {#setLabel}
911909

912-
913910
You can use `setLabel` to specify which properties can be used to set the `Label` property value.
914911

915912
Configuring the value of a property with the `setLabel` attribute will automatically update the value of `Label`.

content/en/docs/deployment/mx-azure/mx-azure-cluster-visibility.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Below is a short summary of the key aspects of cluster visibility. For more info
1616
* Visibility - All cluster namespace members can view initialized clusters to facilitate support and monitoring.
1717
* Security - Only Cluster Managers with appropriate Azure RBAC roles (Owner or Contributor) can modify cluster settings.
1818
* Separation of Concerns:
19-
* Initialized clusters are visible to all namespace members regardless of Azure RBAC.
20-
* Editing capabilities require both Cluster Manager role or Azure Owner or Contributor permissions.
19+
* Initialized clusters are visible to all namespace members regardless of Azure RBAC.
20+
* Editing capabilities require both Cluster Manager role or Azure Owner or Contributor permissions.
2121

2222
## Cluster Visibility
2323

content/en/docs/deployment/on-premises-design/cloud-foundry/cloud-foundry-deploy-pad.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,4 +71,5 @@ To deploy your app to Cloud Foundry, perform the following steps:
7171
```
7272
7373
5. Run the `cf push` command.
74+
7475
6. Verify that the Mendix app has started successfully.

content/en/docs/marketplace/genai/reference-guide/agent-editor.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,7 @@ If a call fails during testing, a generic error message is shown in the Agent Ed
225225
### Including the Agent in the App Logic {#call-agent}
226226

227227
Include an agent in the app logic by calling it from a microflow. Agent Editor provides **Call Agent** toolbox actions in the **Agent Editor** category:
228+
228229
* **Call Agent without History** focuses on single-call, task-style execution
229230
* **Call Agent with History** supports conversational scenarios with multiple messages
230231

content/en/docs/marketplace/platform-supported-content/modules/excel-exporter.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ On the template details page, you can define the template with the following ite
5757
{{% alert color="info" %}}If you use an uploaded Excel file as a template, the names of the sheets and columns in your template will be used. However, the background color in your template will be overruled by the **Background color** (including **none**) specified in the applicable style. {{% /alert %}}
5858

5959
* **Sanitize formulas to text**: When enabled, the module automatically sanitizes any string values that begin with potentially dangerous characters:
60-
- `=` (equals)
61-
- `+` (plus)
62-
- `-` (minus/hyphen)
63-
- `@` (at)
60+
* `=` (equals)
61+
* `+` (plus)
62+
* `-` (minus/hyphen)
63+
* `@` (at)
6464

6565
{{% alert color="info" %}} When sanitization is enabled, the exporter prepends a apostrophe (`'`) to any string value starting with these
6666
characters. This forces Excel and CSV applications to treat the value as literal text rather than a formula.

content/en/docs/marketplace/platform-supported-content/modules/snowflake/snowflake-mcp-byo.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -38,27 +38,25 @@ Because Snowflake conforms to the API specification of OpenAI, you can use the O
3838
1. Click **New**.
3939
2. Enter an identifying name.
4040
3. For API type, select **OpenAI**.
41-
4. For **Endpoint**, enter your Snowflake account URL with the `/api/v2/cortex/v1/` suffix.
42-
43-
For example, the URL may look like the following: `https:/<snowflake_accountname>.snowflakecomputing.com/api/v2/cortex/v1/`.
41+
4. For **Endpoint**, enter your Snowflake account URL with the `/api/v2/cortex/v1/` suffix. For example, the URL may look like the following: `https:/<snowflake_accountname>.snowflakecomputing.com/api/v2/cortex/v1/`.
4442

4543
5. Save your changes.
4644

47-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-byok/save-changes.png" >}}
45+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-byok/save-changes.png" >}}
4846

4947
2. Add a Large Language Model by performing the following steps:
5048

5149
1. Hover over the **three dots** icon and select **Manage deployed models** from the pop-up menu.
5250

53-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-byok/manage-deployed-models.png" >}}
51+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-byok/manage-deployed-models.png" >}}
5452

5553
2. Click **Add new model** to add an LLM from the [list of available LLMs](https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-rest-api#model-availability) in your Snowflake account.
5654

57-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-byok/new-deployed-model.png" >}}
55+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-byok/new-deployed-model.png" >}}
5856

59-
Alternatively, you can log into your Snowflake account with Snowsight and select **AI & ML > AI Studio > Cortex Playground**. The list in the top middle of the screen lists all available models.
60-
61-
The **Model name** field in the Deployed Model configuration in Mendix must match exactly with the model name in Snowflake.
57+
Alternatively, you can log into your Snowflake account with Snowsight and select **AI & ML > AI Studio > Cortex Playground**. The list in the top middle of the screen lists all available models.
58+
59+
The **Model name** field in the Deployed Model configuration in Mendix must match exactly with the model name in Snowflake.
6260

6361
3. Complete the configuration for your model.
6462
4. Save your changes.
@@ -67,9 +65,9 @@ Because Snowflake conforms to the API specification of OpenAI, you can use the O
6765

6866
1. Hover over the **three dots** icon and select **Test** from the pop-up menu.
6967

70-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-byok/test-option.png" >}}
68+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-byok/test-option.png" >}}
7169

7270
2. Select your deployed model from the drop-down list.
7371
3. Click **Test**.
7472

75-
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-byok/test.png" >}}
73+
{{< figure src="/attachments/appstore/platform-supported-content/modules/snowflake-byok/test.png" >}}

content/en/docs/marketplace/platform-supported-content/modules/snowflake/snowflake-mcp.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -410,10 +410,9 @@ After setting up the MCP server, you can now create a Mendix AI agent and connec
410410
8. On the **Consumed MCP Services** page, click **MCP Client** and configure the following properties of your Snowflake MCP server:
411411
412412
1. Enter a name.
413-
2. Specify the MCP endpoint in the following format: `https://<snoflake-account-id>.snowflakecomputing.com/api/v2/databases/<database name>/schemas/<schema name>/mcp-servers/<mcpserver name> `
413+
2. Specify the MCP endpoint in the following format: `https://<snoflake-account-id>.snowflakecomputing.com/api/v2/databases/<database name>/schemas/<schema name>/mcp-servers/<mcpserver name>`.
414414
415-
{{% alert color="info" %}}
416-
If your Snowflake account ID contains underscores (`_`), replace them with `-` in the endpoint. This is only required for the account ID, not for the database name, schema name, or MCP server name.
415+
{{% alert color="info" %}} If your Snowflake account ID contains underscores (`_`), replace them with `-` in the endpoint. This is only required for the account ID, not for the database name, schema name, or MCP server name.
417416
{{% /alert %}}
418417
419418
3. For the protocol value, enter *v2025_03_26*.
@@ -472,4 +471,4 @@ The primary table is SNOWFLAKE_MCP_DEMO.TESTDATA.TICKETS:
472471
- Always confirm successful operations by showing the user what was created or retrieved.
473472
- Use fully qualified table names (DATABASE.SCHEMA.TABLE) in all tool calls.
474473
- If a tool call returns an error, explain the issue clearly and suggest a correction.
475-
```
474+
```

content/en/docs/private-platform/nist-controls/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,3 @@ Documents in this section provide more information about Private Mendix Platform
1515
In general, Mendix is responsible for the Private Mendix Platform, Mendix Operator, Mendix Studio Pro, Mendix Runtime, and so on. Customer responsibilities are related to infra and organization processes. For more information, refer to detailed documentation below.
1616

1717
## Control Categories
18-

content/en/docs/private-platform/nist-controls/ac/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ simple_list: true
1212

1313
Documents in this section provide more information about Private Mendix Platform's compliance with the Access Control (AC) category of the [NIST 800-53](https://csrc.nist.gov/pubs/sp/800/53/r5/upd1/final) security framework. For each applicable control, we have listed which party (Mendix or the customer) is responsible for which component or aspect.
1414

15-
In general, Mendix is responsible for the Private Mendix Platform, Mendix Operator, Mendix Studio Pro, Mendix Runtime, and so on. Customer responsibilities are related to infra and organization processes. For more information, refer to detailed documentation below.
15+
In general, Mendix is responsible for the Private Mendix Platform, Mendix Operator, Mendix Studio Pro, Mendix Runtime, and so on. Customer responsibilities are related to infra and organization processes. For more information, refer to detailed documentation below.

0 commit comments

Comments
 (0)