Skip to content

Commit d9903db

Browse files
NatasaKraljMarkvanMents
authored andcommitted
Run markdownlint-cli2 on docs to find (and correct) linting errors.
1 parent 4ea9e94 commit d9903db

24 files changed

Lines changed: 59 additions & 52 deletions

File tree

content/en/docs/appstore/create-content/create-connectors/connector-guide-best-practices.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,6 @@ When calling a REST service, you can run into an error. This can be one of two t
431431
1. Error with a response
432432
2. Error without a response
433433

434-
435434
If there is no response, the default error handling is enough. This will typically occur when the endpoint is down or when you get a timeout.
436435

437436
If there is a response the error message will contain the error code and the reason, but not the message. For that reason, add an additional log message with the response and then rethrow the error. Add details about the request that will help the developer.

content/en/docs/appstore/create-content/create-modules/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ The guidelines to develop modules and submit them to the Marketplace as as follo
1616

1717
* For Java dependencies, follow the following guidelines:
1818

19-
* In versions Mendix 10.3.0 and above, use [managed dependencies](/refguide/managed-dependencies/) where possible. For versions below 10.3, ensure that Java dependencies are put in the `userlib` folder. You should also put any [unmanaged dependencies](/refguide/managed-dependencies/#unmanaged), that is, non-publicly-available *.jar* files, in the **userlib** folder.
20-
* When putting *.jar* files in the **userlib** folder, make sure the name includes a version number (for example, `org.apache.commons.io-2.3.0.jar`) and is accompanied by a blank `{jarfile-including-version}.{module_name}.RequiredLib` file so that users know where the .*jar* files come from (for example, for the module *MyModule*, `org.apache.commons.io-2.3.0.jar.MyModule.RequiredLib`).
19+
* In versions Mendix 10.3.0 and above, use [managed dependencies](/refguide/managed-dependencies/) where possible. For versions below 10.3, ensure that Java dependencies are put in the `userlib` folder. You should also put any [unmanaged dependencies](/refguide/managed-dependencies/#unmanaged), that is, non-publicly-available *.jar* files, in the **userlib** folder.
20+
* When putting *.jar* files in the **userlib** folder, make sure the name includes a version number (for example, `org.apache.commons.io-2.3.0.jar`) and is accompanied by a blank `{jarfile-including-version}.{module_name}.RequiredLib` file so that users know where the .*jar* files come from (for example, for the module *MyModule*, `org.apache.commons.io-2.3.0.jar.MyModule.RequiredLib`).
2121

2222
{{< figure src="/attachments/appstore/submit-content/userlibBlankFiles_boxed.jpg" width="400" >}}
2323

@@ -35,4 +35,4 @@ The guidelines to develop modules and submit them to the Marketplace as as follo
3535

3636
* Do not rename entities and attributes when creating new versions, as data in these entities will get lost (replacing an existing module is based on the entity names).
3737

38-
* The module must include the English language.
38+
* The module must include the English language.

content/en/docs/appstore/create-content/create-widgets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ The guidelines to develop widgets submit them to the Marketplace as as follows:
1717
* A function should contain at most 200 lines of code.
1818
* A function should only do one thing and do it properly.
1919
* Use hooks and functional components over class components.
20-
* Create test pages for mobile when content is made for mobile platforms.
20+
* Create test pages for mobile when content is made for mobile platforms.

content/en/docs/appstore/create-content/guidelines-content-creators.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -87,19 +87,19 @@ If you have created own product specific terms and conditions, you must host the
8787

8888
If your product is not licensed as an open-source component and you would like to specify certain licensing terms and conditions or end-user license agreements, Mendix recommends creating a document that covers the following topics:
8989

90-
- Copyright information and license conditions
90+
* Copyright information and license conditions
9191

92-
- IP usage, which covers a list of OSS/commercial licenses used
92+
* IP usage, which covers a list of OSS/commercial licenses used
9393

9494
Below is a declaration template you can use for terms & conditions.
9595

9696
| Software Name and Version | Software URL | What does the Software do? Why is it needed? | License |
9797
| ------------------------- | ------------ | -------------------------------------------- | ------- |
9898
| Pro Secure Net 5.0 | https://example.com/prosecurenet/9f86d081884c7d659a2feaa0c55ad915 | A network security software that protects systems from unauthorized access and cyber threats. The software is needed to ensure the safety and integrity of network data. | MIT |
9999

100-
- Export control
101-
- Data Privacy, including data processing agreement, as necessary
102-
- Customer Service Level Agreement (SLA)
100+
* Export control
101+
* Data Privacy, including data processing agreement, as necessary
102+
* Customer Service Level Agreement (SLA)
103103

104104
#### Data Privacy
105105

@@ -237,21 +237,21 @@ Follow your description by adding information on how the product solves the prob
237237

238238
The requirements for the product description are as follows:
239239

240-
* There is no limit on the characters in the description.
241-
* Mendix recommends adding a catchy one-liner before the rich text of the description. This line is used in the product's thumbnail as plain text—a maximum of 150 characters.
240+
* There is no limit on the characters in the description.
241+
* Mendix recommends adding a catchy one-liner before the rich text of the description. This line is used in the product's thumbnail as plain text—a maximum of 150 characters.
242242

243243
Below are some tips that can help you write a proper product description:
244244

245-
* The product description should cover answers to the key questions that developers have when they look for content.
245+
* The product description should cover answers to the key questions that developers have when they look for content.
246246

247-
* The product description should cover the product benefits. Rather than covering many technical features, which you can also cover in the **Documentation** tab, the **Overview** tab can draw attention to the benefits. Specify how your product can improve customers' app development or work life in general. What can help you is outlining the features and benefits of your product, before writing the description. For every feature you list, think about how it will directly benefit a customer.
247+
* The product description should cover the product benefits. Rather than covering many technical features, which you can also cover in the **Documentation** tab, the **Overview** tab can draw attention to the benefits. Specify how your product can improve customers' app development or work life in general. What can help you is outlining the features and benefits of your product, before writing the description. For every feature you list, think about how it will directly benefit a customer.
248248

249-
* Knowing the target audience will help you understand why this person needs your product, what features or benefits interest your customer. That way, you can put the focus on the right aspects.
250-
* Use natural language. Imagine you are telling your friend about the product. Reading the description aloud helps you see if you bring the natural tone like in the real conversation. Friendly- and easily-explained lines in the description help your customers connect to your product. 
249+
* Knowing the target audience will help you understand why this person needs your product, what features or benefits interest your customer. That way, you can put the focus on the right aspects.
250+
* Use natural language. Imagine you are telling your friend about the product. Reading the description aloud helps you see if you bring the natural tone like in the real conversation. Friendly- and easily-explained lines in the description help your customers connect to your product. 
251251

252-
* Try not to use plain text, but rather support your description with bullet points, short paragraphs, and different size fonts. That way, you will help customers skim your text faster and draw attention to the most important parts of the text.
252+
* Try not to use plain text, but rather support your description with bullet points, short paragraphs, and different size fonts. That way, you will help customers skim your text faster and draw attention to the most important parts of the text.
253253

254-
* You can also add keywords to your description to optimize the content for search engines like Mendix or Google Search. That way, if someone is searching for your product using a certain word, your product may come out in the search of the potential customer.
254+
* You can also add keywords to your description to optimize the content for search engines like Mendix or Google Search. That way, if someone is searching for your product using a certain word, your product may come out in the search of the potential customer.
255255

256256
### Screenshots and Assets
257257

@@ -289,12 +289,12 @@ Any products listed on Mendix Marketplace must meet the following requirements:
289289

290290
To provide the best level of support to customers of the product. Mendix recommends that you do the following:
291291

292-
- Set up a Service Level Agreement (SLA). For inspiration, consider the Mendix SLA as one example.
293-
- Provide customers 24 x 7 x 365 support with global coverage. Ideally, a dedicated support team is available. In any case, make it straightforward for customers to identify which team or contact person gives them support. Ensure proper Mendix training for the team—Mendix Advanced Certification is recommended.
294-
- Continuously monitor customer satisfaction with both the product itself and the support you are providing.
295-
- The support team should have a direct line of communication with the engineering team delivering the product as second- or third-line support.
296-
- Put internal procedures in place to manage changes, incidents, and escalations.
297-
- Make a status page like status.mendix.com available for all customers.
292+
* Set up a Service Level Agreement (SLA). For inspiration, consider the Mendix SLA as one example.
293+
* Provide customers 24 x 7 x 365 support with global coverage. Ideally, a dedicated support team is available. In any case, make it straightforward for customers to identify which team or contact person gives them support. Ensure proper Mendix training for the team—Mendix Advanced Certification is recommended.
294+
* Continuously monitor customer satisfaction with both the product itself and the support you are providing.
295+
* The support team should have a direct line of communication with the engineering team delivering the product as second- or third-line support.
296+
* Put internal procedures in place to manage changes, incidents, and escalations.
297+
* Make a status page like status.mendix.com available for all customers.
298298

299299
{{% alert color="info" %}}
300300
Mendix reserves the right to temporarily delist any products that do not adhere to these requirements until resolved. In principle, you will be notified in advance, but for critical issues, the notification can be sent at the same time as the delisting and customer notifications.

content/en/docs/appstore/use-content/platform-supported-content/modules/aws/amazon-bedrock.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ The input and output for this service are shown in the table below:
252252

253253
The request object passed to this operation must include a KnowledgeBaseTool object, which can be added to the request using the [Request: Add Knowledge Base Tool to Collection](#add-knowledge-base-tool) operation.
254254

255-
##### Prompt Template {#PromptTemplate}
255+
##### Prompt Template {#PromptTemplate}
256256

257257
Amazon Bedrock's Retrieve and Generate action has a limitation: it does not support system prompts within the request. This can pose challenges when trying to orchestrate responses in specific ways, such as adopting a subject expert's tone or providing tailored advice when certain conditions are met (for example, suggesting contacting support if no search results are found).
258258

content/en/docs/appstore/use-content/platform-supported-content/modules/genai/conversational-ui.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,7 +248,6 @@ You may need to use the following classes when building a more complex custom pa
248248
| `layoutgrid--full-height` | To be added to any layoutgrid (1 row is supported) around the chat UI components |
249249
| `dataview--display-contents` | To be added to any dataview around chat components to prevent it from breaking the flex-flow on the page |
250250

251-
252251
### Token Monitor Snippets {#snippet-token-monitor}
253252

254253
A separate set of snippets has been made available to display and export token usage information in the running application. This is applicable for LLM connectors that follow the principles of [GenAI Commons](/appstore/modules/genai/commons/#token-usage) and as a result store token usage information. The following snippets can be added to (admin) pages independently from the conversation logic described in earlier sections.

content/en/docs/appstore/use-content/platform-supported-content/modules/snowflake/mendix-data-loader.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -48,13 +48,13 @@ Once the Mendix Data Loader is deployed, follow these steps to configure and use
4848
5. To view the status of your data source, check the **Details**.
4949
6. To view the configuration status, click the **Authentication Configuration** tab.
5050
7. To set up authentication, click **Edit**, and then provide the required information based on the selected authentication type:
51-
* For basic authentication, enter the following information:
51+
*For basic authentication, enter the following information:
5252
* **Username** – A username for basic authentication into the OData resource in your Mendix application
53-
* **Password** – A password for basic authentication into the OData resource in your Mendix application
53+
***Password** – A password for basic authentication into the OData resource in your Mendix application
5454
* For OAuth authentication, enter the following information:
55-
* **Client ID** – A client ID from your OAuth provider
55+
***Client ID** – A client ID from your OAuth provider
5656
* **Client Secret** – A secret associated with the client from your OAuth provider
57-
* **Token Endpoint** – An endpoint at which the token will be validated by your OAuth provider
57+
***Token Endpoint** – An endpoint at which the token will be validated by your OAuth provider
5858
* **Allowed Scopes** – Allowed and custom scopes configured on the client from your OAuth provider
5959
* **Access Token Validity** – Duration (in seconds) for which the access token is valid
6060
8. Click **Generate Script**.

content/en/docs/appstore/use-content/platform-supported-content/services/oidc-provider.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -592,4 +592,3 @@ For situations where the Centralized Authorization concept is used (see [Central
592592
These are set up in [Configuration of the OIDC Provider for Centralized Authorization with Scopes](#configure-scopes). Multiple scopes will be separated by spaces.
593593

594594
For example: `mx:app:userrole:53f5d6fa-6da9-4a71-b011-454ec052cce8 mx:app:userrole:6c5ea333-799c-4438-96fc-2528ced788e4`
595-

content/en/docs/catalog/register/automatically-registered-services.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ Once your services are registered in the Catalog, they become discoverable to ot
2626

2727
You can manage discoverability on a per-service basis, either from the curation pages or the service detail page. For more information, see the [Discoverable and Validated](/catalog/manage/curate/#discoverability) section of *Curate Registered Assets*.
2828

29-
3029
## Read More
3130

3231
* [Getting Started with the Catalog](/catalog/get-started/)

content/en/docs/deployment/private-cloud/private-cloud-license-manager.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,6 @@ For setting up Postgres with Azure workload identity, follow the guide in [Azure
9898

9999
To configure an SQL Server, refer to the [Azure azwi SQL setup](/developerportal/deploy/private-cloud-storage-plans/#walkthrough-azure-azwi).
100100

101-
102101
### Applying the Manifest
103102

104103
To apply the installation manifest to install the server in the Kubernetes namespace, use the following command:

0 commit comments

Comments
 (0)