Skip to content

Commit fc22187

Browse files
authored
Merge pull request #9770 from mendix/lint-docs
[Auto] Lint docs
2 parents b987e58 + 486ce21 commit fc22187

File tree

31 files changed

+154
-165
lines changed

31 files changed

+154
-165
lines changed

content/en/docs/apidocs-mxsdk/apidocs/frontend/design-properties/design-properties-10.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,6 @@ To provide translations for your design properties, create a file *locales/{lang
754754
755755
These JSON files follow the format used by the i18next library, specifically v3. See the [the i18next JSON format documentation](https://www.i18next.com/misc/json-format) for more information. For example to translate a design property with the name **Text align** with the options **left**, **center** and **right**, the contents of *locales/ko-KR/translation.json* might look something like this:
756756
757-
758757
```json
759758
{
760759
"Text align": "텍스트 정렬",

content/en/docs/apidocs-mxsdk/apidocs/governance/user-deactivation-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,4 @@ The following steps lead to deactivating the user based on the UUID provided as
7878

7979
## API Reference
8080

81-
{{< swaggerui src="/openapi-spec/user-deactivation-api.yaml" >}}
81+
{{< swaggerui src="/openapi-spec/user-deactivation-api.yaml" >}}

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-10/pluggable-widgets/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@ Translations for a pluggable widget can be provided in two ways: in the widget p
332332

333333
### Providing Translations in a Pluggable Widget Package
334334

335-
To support a translation for a specific language and locale, create a *locales/{language-code}/{widget ID}.json* or *locales/{language-code}/translation.json* file. The language code can be any of the user interface languages supported by Studio Pro, such as *en-US*, *ja-JP*, *ko-KR*, or *zh-CN*. Other files in the **locales** folder will be ignored. As a result, custom namespaces cannot be used. We recommend using *translation.json*, unless your .MPK contains multiple pluggable widgets. Note that if you use the widget ID as the file name, you will have to replace any spaces and illegal path characters (if there are any) with underscores. The file name should be all lower case. For example, if your widget ID is *%My Pluggable Widget%*, the name of the file should be *_my_pluggable_widget_.json*.
335+
To support a translation for a specific language and locale, create a *locales/{language-code}/{widget ID}.json* or *locales/{language-code}/translation.json* file. The language code can be any of the user interface languages supported by Studio Pro, such as *en-US*, *ja-JP*, *ko-KR*, or *zh-CN*. Other files in the **locales** folder will be ignored. As a result, custom namespaces cannot be used. We recommend using *translation.json*, unless your .MPK contains multiple pluggable widgets. Note that if you use the widget ID as the file name, you will have to replace any spaces and illegal path characters (if there are any) with underscores. The file name should be all lower case. For example, if your widget ID is *%My Pluggable Widget%*, the name of the file should be `_my_pluggable_widget_.json`.
336336

337337
These JSON files follow the format used by the i18next library, specifically v3. For more information, see [the i18nest JSON documentation](https://www.i18next.com/misc/json-format). For example, to translate a widget with the name *Text Box* that has a property *length*, the contents of *locales/ko-KR/translation.json* might look something like this example:
338338

@@ -347,7 +347,7 @@ These JSON files follow the format used by the i18next library, specifically v3.
347347

348348
Translations for a pluggable widget can also be provided by a module. This can be useful when you would like to provide a module that has more than one pluggable widget, or if your pluggable widget uses one or more [/apidocs-mxsdk/apidocs/frontend/design-properties/](design properties).
349349

350-
To achieve this, create a *locales/{language-code}/{widget ID}.json* file in the **Styling** folder of your module. You will have to replace any spaces and illegal path characters (if there are any) with underscores. The file name should be all lower case. For example, if your widget ID is *%My Pluggable Widget%*, the name of the file should be *_my_pluggable_widget_.json*. In addition, create a *locales/metadata.json* file. The resulting structure will look something like this example:
350+
To achieve this, create a *locales/{language-code}/{widget ID}.json* file in the **Styling** folder of your module. You will have to replace any spaces and illegal path characters (if there are any) with underscores. The file name should be all lower case. For example, if your widget ID is *%My Pluggable Widget%*, the name of the file should be `_my_pluggable_widget_.json`. In addition, create a *locales/metadata.json* file. The resulting structure will look something like this example:
351351

352352
{{< figure src="/attachments/apidocs-mxsdk/apidocs/pluggable-widgets/translations.png" alt="A metadata.json file in the Styling/locales folder and a custom.widget.id.json file in the Styling/locales/ko-KR folder" class="no-border" max-width=50% >}}
353353

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-8/pluggable-widgets/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,3 @@ description: "This API helps you to understand pluggable widgets, how they exten
88
---
99

1010
The following Mendix 8 pluggable widget API documents are available here:
11-

content/en/docs/apidocs-mxsdk/apidocs/studio-pro-9/pluggable-widgets/_index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,3 @@ description: "This API helps you to understand pluggable widgets, how they exten
88
---
99

1010
The following Mendix 9 pluggable widget API documents are available here:
11-

content/en/docs/control-center/entitlements/cloud-tokens.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,4 +98,4 @@ You can no longer purchase Legacy Cloud Resources Packs. You can now only purcha
9898
* Mendix Cloud Tokens are a specific type of Token used to access Cloud Resources in the Mendix Platform.
9999
* The number of Mendix Cloud Tokens required depends on the CRP you want.
100100
* You buy Tokens in advance, and can use them to obtain CRPs.
101-
* If you no longer need those resources, you can reuse the Token to obtain other CRPs, or keep it to be used later.
101+
* If you no longer need those resources, you can reuse the Token to obtain other CRPs, or keep it to be used later.

content/en/docs/deployment/mendix-cloud-deploy/change-plan.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,6 @@ Before requesting a plan change, verify the following:
3535
Changing your app environment's plan does not change the additional storage attached to it. To change the additional storage, you must request an [environment resize](/support/new-app-node-request-template/#resize) through [Mendix Support](https://support.mendix.com/).
3636
{{% /alert %}}
3737

38-
3938
## Changing a Plan {#changing-plan}
4039

4140
{{% alert color="info" %}}

content/en/docs/deployment/mendix-cloud-deploy/custom-domains.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,6 @@ To create a CSR and an RSA (Rivest–Shamir–Adleman) encryption key, follow th
100100

101101
4. Click **Generate**.
102102

103-
104103
An SSL/TLS private key and a certificate request is generated. The certificate request will be shown in PEM (Privacy-Enhanced Mail) format.
105104

106105
{{< figure src="/attachments/deployment/mendix-cloud-deploy/custom-domains/new-pem-format.png" >}}

content/en/docs/developerportal/digital-execution/compass/lead-mendix-implementation-your-organization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -950,4 +950,4 @@ Here are some resources help familiarize yourself with the Mendix platform:
950950
* The [Mendix Partner Hub](https://www.mendix.com/partners/) allows you to explore our Partner Network.
951951
* The [Mendix Marketplace](https://marketplace.mendix.com/) provides access to modules, widgets, solutions, and other content provided by Mendix, partners or the community.
952952
* The [Siemens Annual Reports](https://www.siemens.com/global/en/company/investor-relations/events-publications-ad-hoc/annualreports.html?gclid=CjwKCAjwzo2mBhAUEiwAf7wjkpk1onH3tK1d_kOzGxjbQa5MTFF91cbKKfp7a6F3AS8mDpov1_M6choCbE8QAvD_BwE&acz=1) offer details on financial, corporate governance, and sustainability.
953-
* The [DEP Manual](https://www.mendix.com/resources/digital-execution-manual/) provides information about the 5 P’s and how to best leverage the Mendix low-code platform.
953+
* The [DEP Manual](https://www.mendix.com/resources/digital-execution-manual/) provides information about the 5 P’s and how to best leverage the Mendix low-code platform.

content/en/docs/developerportal/general/settings/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The page header displays the following information:
3333

3434
* The app image – You can change the image by clicking it.
3535
* The app name – You can change the name of the app by clicking the pencil icon next to it.
36-
Renaming the app in the Mendix Portal does not rename it in Studio Pro. The app name in Studio Pro is tied to its *.mpr* file. However, changing the name of the *.mpr* file is not supported, and we strongly advise against it. For more information, refer to the [Mendix MPR Storage ](/refguide/version-control/#mpr-format) section in *Version Control*.
36+
Renaming the app in the Mendix Portal does not rename it in Studio Pro. The app name in Studio Pro is tied to its *.mpr* file. However, changing the name of the *.mpr* file is not supported, and we strongly advise against it. For more information, refer to the [Mendix MPR Storage](/refguide/version-control/#mpr-format) section in *Version Control*.
3737
* The company that owns the app.
3838
* The **Watch** / **Stop Watching** toggle – You can enable or disable notifications for this app.
3939

content/en/docs/marketplace/create-content/create-solutions/implement-solutions/sol-upgrade.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ To upgrade a solution, follow these steps:
4141

4242
### Read More
4343

44-
* [Setting Up Solutions](/appstore/creating-content/sol-set-up/)
44+
* [Setting Up Solutions](/appstore/creating-content/sol-set-up/)

content/en/docs/marketplace/create-content/upload-content/oss-compliance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ To ensure your Marketplace contribution is OSS-compliant, you must include the f
4444
* List each OSS component, its license, and any required attributions.
4545
* Follow all license conditions around modification or redistribution.
4646

47-
## Prohibited or High-Risk OSS Licenses
47+
## Prohibited or High-Risk OSS Licenses
4848

4949
Certain OSS licenses impose strong copyleft obligations that may conflict with how Mendix modules are distributed or used in customer environments.
5050

content/en/docs/marketplace/platform-supported-content/widgets/charts/charts-custom-usage.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ If need be, the layout can also be generated in the same way as the data. In mos
9393

9494
Editing the JSON configuration in Studio Pro can be cumbersome. With the live preview editor, developers can directly see the output of their changes.
9595

96-
See (Chart advanced tuning)[/appstore/widgets/chart-advanced-tuning/] for more information on fine tuning **Custom Chart** with using **Chart Playground** widget.
96+
See [Chart advanced tuning](/appstore/widgets/chart-advanced-tuning/) for more information on fine tuning **Custom Chart** with using **Chart Playground** widget.
9797

9898
{{% alert color="info" %}}
9999
Since the introduction of design mode, react-ready widgets can render data as it is entered. This makes it possible for user to see Static data and configurations directly in design mode without the needs of running the apps.
@@ -103,17 +103,16 @@ Since the introduction of design mode, react-ready widgets can render data as it
103103

104104
These are the dimension configurations for custom charts:
105105

106-
- **Width** — Determines the width size for the custom charts. User can choose to use either pixels (px) or percentage (%).
107-
- **Height** — Determine the height size for the custom charts. User can choose to use either pixels (px), percentage (%), or Viewport (vh). Choosing setting to **Auto** will allow user to set minimum and maximum height instead.
108-
- **Minimum Height** — Determines the minimum size for the custom charts container.
109-
- **Maximum Height** — Determines the maximum size for the custom charts container.
110-
- **Vertical Overflow** — If maximum height is set, vertical overflow will determine the widget's behavior to show overflowing content if it reached height size larger than the maximum height allowed.
111-
106+
* **Width** — Determines the width size for the custom charts. User can choose to use either pixels (px) or percentage (%).
107+
* **Height** — Determine the height size for the custom charts. User can choose to use either pixels (px), percentage (%), or Viewport (vh). Choosing setting to **Auto** will allow user to set minimum and maximum height instead.
108+
* **Minimum Height** — Determines the minimum size for the custom charts container.
109+
* **Maximum Height** — Determines the maximum size for the custom charts container.
110+
* **Vertical Overflow** — If maximum height is set, vertical overflow will determine the widget's behavior to show overflowing content if it reached height size larger than the maximum height allowed.
112111

113112
## Events
114113

115-
- **On Click** — Determines the actions that will be triggered if parts of the custom charts is clicked.
116-
- **Event data attribute** — The string value that the chart uses when click events occur. User can use this same attribute as the parameters for on-click events action to retrieve the data from the custom chart:
114+
* **On Click** — Determines the actions that will be triggered if parts of the custom charts is clicked.
115+
* **Event data attribute** — The string value that the chart uses when click events occur. User can use this same attribute as the parameters for on-click events action to retrieve the data from the custom chart:
117116

118117
{{< figure src="/attachments/appstore/platform-supported-content/widgets/charts/charts-tutorials/charts-any-usage/custom-chart-events-attribute.png" alt="Setup on click events" class="no-border" >}}
119118

content/en/docs/marketplace/platform-supported-content/widgets/document-viewer.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,11 @@ To configure this widget, follow these steps:
3939

4040
These are the dimension configurations for document viewer:
4141

42-
- **Width** — Determines the width size for the document viewer. The developer can choose to use either pixels (px), percentage (%), or **Fit to content**.
43-
- **Height** — Determine the height size for the document viewer. The developer can choose to use either pixels (px), percentage (%), or **Viewport** (vp). Choosing setting to **Auto** will allow the developer to set minimum and maximum heights instead.
44-
- **Minimum Height** — Determines the minimum size for the custom charts container.
45-
- **Maximum Height** — Determines the maximum size for the custom charts container.
46-
- **Vertical Overflow** — If maximum height is set, vertical overflow will determine the widget's behavior to show overflowing content if that content exceeded the maximum height allowed.
42+
* **Width** — Determines the width size for the document viewer. The developer can choose to use either pixels (px), percentage (%), or **Fit to content**.
43+
* **Height** — Determine the height size for the document viewer. The developer can choose to use either pixels (px), percentage (%), or **Viewport** (vp). Choosing setting to **Auto** will allow the developer to set minimum and maximum heights instead.
44+
* **Minimum Height** — Determines the minimum size for the custom charts container.
45+
* **Maximum Height** — Determines the maximum size for the custom charts container.
46+
* **Vertical Overflow** — If maximum height is set, vertical overflow will determine the widget's behavior to show overflowing content if that content exceeded the maximum height allowed.
4747

4848
### Common Tab
4949

@@ -61,4 +61,3 @@ This widget is not intended to replace the standalone file viewer application. I
6161
* **Excel**
6262
* The widget is only able to display the first sheet from an xlsx document.
6363
* The Excel 1997-2003 document format (*.xls) is not supported.
64-

content/en/docs/refguide/mobile/distributing-mobile-apps/distributing-native-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,4 +154,4 @@ To publish in the Android Google Play Console, do the following:
154154
1. Upload your signed *.apk* or *.aab* file.
155155
1. Review and roll out your release to production.
156156
157-
Be sure to enroll in Google Play App Signing if you plan to use AAB files. Also, don’t forget to set up content rating, privacy policies, and testing tracks if needed.
157+
Be sure to enroll in Google Play App Signing if you plan to use AAB files. Also, don’t forget to set up content rating, privacy policies, and testing tracks if needed.

content/en/docs/refguide/modeling/application-logic/workflows/jump-to.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,4 +49,4 @@ For more information about jumping rules in a boundary event path, see the [Jump
4949
## Read More
5050

5151
* [Generate Jump-To Options](/refguide/generate-jump-to-options/)
52-
* [Apply Jump-To Option](/refguide/apply-jump-to-option/)
52+
* [Apply Jump-To Option](/refguide/apply-jump-to-option/)

content/en/docs/refguide/modeling/domain-model/oql/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,4 +86,4 @@ In OQL, `FLOAT` is a reserved word for legacy reasons. Mendix no longer supports
8686

8787
{{% alert color="info" %}}
8888
In OQL, `DELETE`, `INSERT`, `REPLACE`, `UPDATE`, `UPSERT`, `INTO`, `SET`, `VALUES`, `IGNORE`, `MATCHED`, `DUPLICATE`, `KEY`, `CONFLICT`, `MERGE`, `USING`, `SOURCE`, `TARGET`, and `WITH` are reserved but not yet used.
89-
{{% /alert %}}
89+
{{% /alert %}}

content/en/docs/refguide/modeling/pages/data-widgets/data-sources/listen-to-grid-source.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ A data view in an image above listens to a data grid. In this example, the data
1414

1515
List views, template grids, and data grids are list widgets and can be listened to. If no object is selected in the list widget, the data view will remain empty and unresponsive.
1616

17-
1817
To enable **Listen to widget** in common data sources, do the following per your use case:
1918

2019
* DataGrid2: Select **Selection** > **Single** and **Selection method** > **Row click** to be able to select a DataGrid2 as a **Listen to widget** data source in your dataview.

content/en/docs/refguide/runtime/mendix-client/react.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@ Because the reference set selector widget is technically a grid, while combo box
121121

122122
The [HTML/JavaScript snippet](/appstore/widgets/html-javascript-snippet/) widget is not supported in the React Client. To leverage React, this widget can be replaced using [HTML Element](/appstore/widgets/htmlelement/) widget or [JavaScript actions](/refguide/javascript-actions/):
123123

124-
* **Content Type** HTML — The HTML Element can be downloaded [here](https://marketplace.mendix.com/link/component/204843).
125-
* **Content Type** JavaScript — Write the code inside the supported JavaScript actions. If the user needs to execute the code in a certain way, calling the JavaScript action via nanoflow that triggers by [Events](/appstore/widgets/events/) widget is recommended.
124+
* **Content Type** HTML — The HTML Element can be downloaded [here](https://marketplace.mendix.com/link/component/204843).
125+
* **Content Type** JavaScript — Write the code inside the supported JavaScript actions. If the user needs to execute the code in a certain way, calling the JavaScript action via nanoflow that triggers by [Events](/appstore/widgets/events/) widget is recommended.
126126

127127
#### Data Grid{#data-grid}
128128

content/en/docs/refguide/version-control/version-control-troubleshooting/repository-size.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ Other places where you might encounter performance issues or timeouts are the fo
3636

3737
### MPR Storage Format {#mpr-format}
3838

39-
4039
In Studio Pro 11, apps are automatically converted to the MPRv2 storage format. For more information of the effects of the MPRv1 storage format, please see the [MPR Storage Format](/refguide10/troubleshoot-repository-size/#mpr-format) section in *Troubleshooting Repository Size* in *Studio Pro 10 Guide*.
4140

4241
MPRv2 storage format prevents your repository from a rapid growth. Documents such as microflows, are not stored as part of the *.mpr* file but as separate files in the *mprcontents* directory. The *.mpr* file functions as an index file pointing to all the different files on disk.
@@ -214,4 +213,4 @@ Follow the decision tree in the image below to troubleshoot Git-related performa
214213

215214
\** For more information on partial clone, see [Clone Type](/refguide/clone-type/).
216215

217-
\*** For more information on Git cleanup, see the [Cleanup](/refguide/troubleshoot-repository-size/#cleanup-tool) section in *Troubleshooting Repository Size*.
216+
\*** For more information on Git cleanup, see the [Cleanup](/refguide/troubleshoot-repository-size/#cleanup-tool) section in *Troubleshooting Repository Size*.

content/en/docs/refguide10/mobile/distributing-mobile-apps/distributing-native-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,4 +154,4 @@ To publish in the Android Google Play Console, do the following:
154154
1. Upload your signed *.apk* or *.aab* file.
155155
1. Review and roll out your release to production.
156156
157-
Be sure to enroll in Google Play App Signing if you plan to use AAB files. Also, don’t forget to set up content rating, privacy policies, and testing tracks if needed.
157+
Be sure to enroll in Google Play App Signing if you plan to use AAB files. Also, don’t forget to set up content rating, privacy policies, and testing tracks if needed.

content/en/docs/refguide10/modeling/menus/edit-menu/preferences-dialog.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -260,8 +260,6 @@ This option allows you to change the user interface language you work in while u
260260
| Korean | 10.17 | 10.24 |
261261
| Portuguese (Brazilian) | 10.23 | TBD |
262262

263-
264-
265263
### Editor Tabs Closing Policy {#closing-policy}
266264

267265
It is recommended to limit the number of open tabs (open documents) to improve the performance of Studio Pro. This option is enabled by default and set to a limit of 15 tabs. However, you can disable this behavior completely or change the limit value.

0 commit comments

Comments
 (0)