From d9903dbbfe4ccdd3e0a4821d5f072ab61d6814d1 Mon Sep 17 00:00:00 2001 From: NatasaKralj <83953175+NatasaKralj@users.noreply.github.com> Date: Sun, 1 Dec 2024 20:13:14 +0000 Subject: [PATCH 1/2] Run markdownlint-cli2 on docs to find (and correct) linting errors. --- .../connector-guide-best-practices.md | 1 - .../create-content/create-modules/_index.md | 6 +-- .../appstore/create-content/create-widgets.md | 2 +- .../guidelines-content-creators.md | 38 +++++++++---------- .../modules/aws/amazon-bedrock.md | 2 +- .../modules/genai/conversational-ui.md | 1 - .../modules/snowflake/mendix-data-loader.md | 8 ++-- .../services/oidc-provider.md | 1 - .../automatically-registered-services.md | 1 - .../private-cloud-license-manager.md | 1 - .../integrate-with-jira.md | 2 +- .../configuration/pmp-configure-k8s.md | 1 + .../app/app-settings/configuration.md | 1 - .../import-a-large-excel-file.md | 2 +- .../integration/use-extensions/_index.md | 2 +- .../releasenotes/control-center/_index.md | 2 +- .../releasenotes/developer-portal/_index.md | 6 +-- .../marketplace/general-marketplace.md | 8 ++-- .../metamodel/metamodel-10/metamodel-10.17.md | 11 +++++- .../docs/releasenotes/studio-pro/10/10.12.md | 2 +- .../docs/releasenotes/studio-pro/10/10.13.md | 1 - .../docs/releasenotes/studio-pro/10/10.16.md | 6 +-- .../docs/releasenotes/studio-pro/10/10.17.md | 2 +- .../docs/releasenotes/studio-pro/10/10.6.md | 4 +- 24 files changed, 59 insertions(+), 52 deletions(-) diff --git a/content/en/docs/appstore/create-content/create-connectors/connector-guide-best-practices.md b/content/en/docs/appstore/create-content/create-connectors/connector-guide-best-practices.md index c699a5731a3..0ef94c5315b 100644 --- a/content/en/docs/appstore/create-content/create-connectors/connector-guide-best-practices.md +++ b/content/en/docs/appstore/create-content/create-connectors/connector-guide-best-practices.md @@ -431,7 +431,6 @@ When calling a REST service, you can run into an error. This can be one of two t 1. Error with a response 2. Error without a response - 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. 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. diff --git a/content/en/docs/appstore/create-content/create-modules/_index.md b/content/en/docs/appstore/create-content/create-modules/_index.md index ed9a78a2920..fc9550c2893 100644 --- a/content/en/docs/appstore/create-content/create-modules/_index.md +++ b/content/en/docs/appstore/create-content/create-modules/_index.md @@ -16,8 +16,8 @@ The guidelines to develop modules and submit them to the Marketplace as as follo * For Java dependencies, follow the following guidelines: - * 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. - * 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`). + * 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. + * 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`). {{< figure src="/attachments/appstore/submit-content/userlibBlankFiles_boxed.jpg" width="400" >}} @@ -35,4 +35,4 @@ The guidelines to develop modules and submit them to the Marketplace as as follo * 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). -* The module must include the English language. \ No newline at end of file +* The module must include the English language. diff --git a/content/en/docs/appstore/create-content/create-widgets.md b/content/en/docs/appstore/create-content/create-widgets.md index 5e57547e54a..33a8316bd78 100644 --- a/content/en/docs/appstore/create-content/create-widgets.md +++ b/content/en/docs/appstore/create-content/create-widgets.md @@ -17,4 +17,4 @@ The guidelines to develop widgets submit them to the Marketplace as as follows: * A function should contain at most 200 lines of code. * A function should only do one thing and do it properly. * Use hooks and functional components over class components. -* Create test pages for mobile when content is made for mobile platforms. \ No newline at end of file +* Create test pages for mobile when content is made for mobile platforms. diff --git a/content/en/docs/appstore/create-content/guidelines-content-creators.md b/content/en/docs/appstore/create-content/guidelines-content-creators.md index 8ae4d7102eb..2ddef06ad9a 100644 --- a/content/en/docs/appstore/create-content/guidelines-content-creators.md +++ b/content/en/docs/appstore/create-content/guidelines-content-creators.md @@ -87,9 +87,9 @@ If you have created own product specific terms and conditions, you must host the 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: -- Copyright information and license conditions +* Copyright information and license conditions -- IP usage, which covers a list of OSS/commercial licenses used +* IP usage, which covers a list of OSS/commercial licenses used Below is a declaration template you can use for terms & conditions. @@ -97,9 +97,9 @@ If your product is not licensed as an open-source component and you would like t | ------------------------- | ------------ | -------------------------------------------- | ------- | | 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 | -- Export control -- Data Privacy, including data processing agreement, as necessary -- Customer Service Level Agreement (SLA) +* Export control +* Data Privacy, including data processing agreement, as necessary +* Customer Service Level Agreement (SLA) #### Data Privacy @@ -237,21 +237,21 @@ Follow your description by adding information on how the product solves the prob The requirements for the product description are as follows: -* There is no limit on the characters in the description. -* 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. +* There is no limit on the characters in the description. +* 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. Below are some tips that can help you write a proper product description: -* The product description should cover answers to the key questions that developers have when they look for content. +* The product description should cover answers to the key questions that developers have when they look for content. -* 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. +* 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. -* 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. -* 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.  +* 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. +* 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.  -* 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. +* 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. -* 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. +* 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. ### Screenshots and Assets @@ -289,12 +289,12 @@ Any products listed on Mendix Marketplace must meet the following requirements: To provide the best level of support to customers of the product. Mendix recommends that you do the following: -- Set up a Service Level Agreement (SLA). For inspiration, consider the Mendix SLA as one example. -- 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. -- Continuously monitor customer satisfaction with both the product itself and the support you are providing. -- The support team should have a direct line of communication with the engineering team delivering the product as second- or third-line support. -- Put internal procedures in place to manage changes, incidents, and escalations. -- Make a status page like status.mendix.com available for all customers. +* Set up a Service Level Agreement (SLA). For inspiration, consider the Mendix SLA as one example. +* 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. +* Continuously monitor customer satisfaction with both the product itself and the support you are providing. +* The support team should have a direct line of communication with the engineering team delivering the product as second- or third-line support. +* Put internal procedures in place to manage changes, incidents, and escalations. +* Make a status page like status.mendix.com available for all customers. {{% alert color="info" %}} 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. diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/aws/amazon-bedrock.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/aws/amazon-bedrock.md index 5a99e36b3e0..fce63be6c70 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/aws/amazon-bedrock.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/aws/amazon-bedrock.md @@ -252,7 +252,7 @@ The input and output for this service are shown in the table below: 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. - ##### Prompt Template {#PromptTemplate} +##### Prompt Template {#PromptTemplate} 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). diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/conversational-ui.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/conversational-ui.md index d089c5a20ab..a8627603d92 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/conversational-ui.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/genai/conversational-ui.md @@ -248,7 +248,6 @@ You may need to use the following classes when building a more complex custom pa | `layoutgrid--full-height` | To be added to any layoutgrid (1 row is supported) around the chat UI components | | `dataview--display-contents` | To be added to any dataview around chat components to prevent it from breaking the flex-flow on the page | - ### Token Monitor Snippets {#snippet-token-monitor} 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. diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/snowflake/mendix-data-loader.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/snowflake/mendix-data-loader.md index 42ab0d811fc..bde171efb61 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/snowflake/mendix-data-loader.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/snowflake/mendix-data-loader.md @@ -48,13 +48,13 @@ Once the Mendix Data Loader is deployed, follow these steps to configure and use 5. To view the status of your data source, check the **Details**. 6. To view the configuration status, click the **Authentication Configuration** tab. 7. To set up authentication, click **Edit**, and then provide the required information based on the selected authentication type: - * For basic authentication, enter the following information: + *For basic authentication, enter the following information: * **Username** – A username for basic authentication into the OData resource in your Mendix application - * **Password** – A password for basic authentication into the OData resource in your Mendix application + ***Password** – A password for basic authentication into the OData resource in your Mendix application * For OAuth authentication, enter the following information: - * **Client ID** – A client ID from your OAuth provider + ***Client ID** – A client ID from your OAuth provider * **Client Secret** – A secret associated with the client from your OAuth provider - * **Token Endpoint** – An endpoint at which the token will be validated by your OAuth provider + ***Token Endpoint** – An endpoint at which the token will be validated by your OAuth provider * **Allowed Scopes** – Allowed and custom scopes configured on the client from your OAuth provider * **Access Token Validity** – Duration (in seconds) for which the access token is valid 8. Click **Generate Script**. diff --git a/content/en/docs/appstore/use-content/platform-supported-content/services/oidc-provider.md b/content/en/docs/appstore/use-content/platform-supported-content/services/oidc-provider.md index 3d9e5899efc..a33b4242030 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/services/oidc-provider.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/services/oidc-provider.md @@ -592,4 +592,3 @@ For situations where the Centralized Authorization concept is used (see [Central These are set up in [Configuration of the OIDC Provider for Centralized Authorization with Scopes](#configure-scopes). Multiple scopes will be separated by spaces. For example: `mx:app:userrole:53f5d6fa-6da9-4a71-b011-454ec052cce8 mx:app:userrole:6c5ea333-799c-4438-96fc-2528ced788e4` - diff --git a/content/en/docs/catalog/register/automatically-registered-services.md b/content/en/docs/catalog/register/automatically-registered-services.md index ad62e336de2..0cf9d09cb01 100644 --- a/content/en/docs/catalog/register/automatically-registered-services.md +++ b/content/en/docs/catalog/register/automatically-registered-services.md @@ -26,7 +26,6 @@ Once your services are registered in the Catalog, they become discoverable to ot 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*. - ## Read More * [Getting Started with the Catalog](/catalog/get-started/) diff --git a/content/en/docs/deployment/private-cloud/private-cloud-license-manager.md b/content/en/docs/deployment/private-cloud/private-cloud-license-manager.md index 8b47cb1c479..5fb1ea9d505 100644 --- a/content/en/docs/deployment/private-cloud/private-cloud-license-manager.md +++ b/content/en/docs/deployment/private-cloud/private-cloud-license-manager.md @@ -98,7 +98,6 @@ For setting up Postgres with Azure workload identity, follow the guide in [Azure To configure an SQL Server, refer to the [Azure azwi SQL setup](/developerportal/deploy/private-cloud-storage-plans/#walkthrough-azure-azwi). - ### Applying the Manifest To apply the installation manifest to install the server in the Kubernetes namespace, use the following command: diff --git a/content/en/docs/developerportal/portfolio-management/integrate-with-jira.md b/content/en/docs/developerportal/portfolio-management/integrate-with-jira.md index 2c2bbe8422e..071f9e493ee 100644 --- a/content/en/docs/developerportal/portfolio-management/integrate-with-jira.md +++ b/content/en/docs/developerportal/portfolio-management/integrate-with-jira.md @@ -144,4 +144,4 @@ If you already have [linked epics from the Jira project to an initiative](/devel {{< figure src="/attachments/developerportal/portfolio-management/integrate-with-jira/warning-jira-project-unlink.png" >}} -4. Click **Unlink** to confirm your action. \ No newline at end of file +4. Click **Unlink** to confirm your action. diff --git a/content/en/docs/private-platform/configuration/pmp-configure-k8s.md b/content/en/docs/private-platform/configuration/pmp-configure-k8s.md index 30765e83a54..30f8fa3a358 100644 --- a/content/en/docs/private-platform/configuration/pmp-configure-k8s.md +++ b/content/en/docs/private-platform/configuration/pmp-configure-k8s.md @@ -190,6 +190,7 @@ The settings in this section configure the storage for build output artifacts. namespace: {pmp-namespace} # The namespace where Private Mendix Platform is installed azure.workload.identity/client-id: {client-id} ``` + 5. Add **customPodLabels** to the Mendix Operator to label the Private Mendix Platform pod with the proper configuration. This configuration allows Private Mendix Platform to get build artifacts from Azure Storage Blob. ```text diff --git a/content/en/docs/refguide/modeling/app-explorer/app/app-settings/configuration.md b/content/en/docs/refguide/modeling/app-explorer/app/app-settings/configuration.md index 86cc25438c4..898f0dfc5d8 100644 --- a/content/en/docs/refguide/modeling/app-explorer/app/app-settings/configuration.md +++ b/content/en/docs/refguide/modeling/app-explorer/app/app-settings/configuration.md @@ -94,7 +94,6 @@ The following headers are considered special and are handled a bit differently f * `Content-Security-Policy`, this is only returned for HTML responses and responses for which it is added using `response.addContentSecurityPolicyHeader()`. Additionally, a `{{ NONCE }}` template variable can be used, which be replaced when the response is sent back by the value returned from `response.getNonce`. - ## An Example Say you have an app which calls an API. In the `GetData` module of your app you have a constant `API_ENDPOINT` which points to this endpoint and has the default value `https://example.com/usefulendpoint`. diff --git a/content/en/docs/refguide/modeling/integration/use-excel-documents/import-a-large-excel-file.md b/content/en/docs/refguide/modeling/integration/use-excel-documents/import-a-large-excel-file.md index 4b53845bb14..e11fccea9d9 100644 --- a/content/en/docs/refguide/modeling/integration/use-excel-documents/import-a-large-excel-file.md +++ b/content/en/docs/refguide/modeling/integration/use-excel-documents/import-a-large-excel-file.md @@ -162,4 +162,4 @@ To create entity in your domain model using an Excel sheet, follow these steps: 6. After reviewing the preview, click **Create Entity** and a non-persistable entity (NPE) is created in your domain model. {{< figure src="/attachments/howto/integration/importing-excel-documents/import-a-large-excel-file/create-entity-using-excel-input.png" class="no-border" >}} - You can change the name of the entity or change its persistence later, if necessary. \ No newline at end of file + You can change the name of the entity or change its persistence later, if necessary. diff --git a/content/en/docs/refguide/modeling/integration/use-extensions/_index.md b/content/en/docs/refguide/modeling/integration/use-extensions/_index.md index 620331aa1ca..cc9902a2e18 100644 --- a/content/en/docs/refguide/modeling/integration/use-extensions/_index.md +++ b/content/en/docs/refguide/modeling/integration/use-extensions/_index.md @@ -36,4 +36,4 @@ Documents available for this topic: * [Mendix Event Broker](/appstore/services/event-broker/) * [Import Data from File](/refguide/import-data-from-file/) * [External Database Connector](/appstore/modules/external-database-connector/) -* [Query External Database](/refguide/query-external-database/) \ No newline at end of file +* [Query External Database](/refguide/query-external-database/) diff --git a/content/en/docs/releasenotes/control-center/_index.md b/content/en/docs/releasenotes/control-center/_index.md index e8865fc5b24..7966cde1677 100644 --- a/content/en/docs/releasenotes/control-center/_index.md +++ b/content/en/docs/releasenotes/control-center/_index.md @@ -24,7 +24,7 @@ To see the current status of the Mendix Control Center, see [Mendix Status](http #### New Features -- Mendix Admins can now centrally manage cloud permissions through the Control Center for apps deployed in the Mendix Cloud. This enhancement provides greater oversight over user roles and actions within different environments. This feature is available to companies that use [Company Roles](/control-center/roles-and-permissions/). +* Mendix Admins can now centrally manage cloud permissions through the Control Center for apps deployed in the Mendix Cloud. This enhancement provides greater oversight over user roles and actions within different environments. This feature is available to companies that use [Company Roles](/control-center/roles-and-permissions/). ### October 31, 2024 diff --git a/content/en/docs/releasenotes/developer-portal/_index.md b/content/en/docs/releasenotes/developer-portal/_index.md index aad151e4cf9..e0249238e5a 100644 --- a/content/en/docs/releasenotes/developer-portal/_index.md +++ b/content/en/docs/releasenotes/developer-portal/_index.md @@ -30,9 +30,9 @@ To see the current status of the Mendix Portal, see [Mendix Status](https://stat #### Improvements * We have improved [Mini Surveys](/developerportal/app-insights/mini-surveys/) as follows: - * Mini Surveys now features an updated onboarding flow that guides you step by step through the installation process. - * You no longer need to restart your application to switch surveys, as we have changed the module to use the survey location instead of linking it to a survey ID. - * We have simplified the process of creating a new survey by introducing a wizard that walks you through each step. + * Mini Surveys now features an updated onboarding flow that guides you step by step through the installation process. + * You no longer need to restart your application to switch surveys, as we have changed the module to use the survey location instead of linking it to a survey ID. + * We have simplified the process of creating a new survey by introducing a wizard that walks you through each step. ### November 7, 2024 diff --git a/content/en/docs/releasenotes/marketplace/general-marketplace.md b/content/en/docs/releasenotes/marketplace/general-marketplace.md index bde7338c351..eb2b8177b04 100644 --- a/content/en/docs/releasenotes/marketplace/general-marketplace.md +++ b/content/en/docs/releasenotes/marketplace/general-marketplace.md @@ -23,6 +23,7 @@ These release notes cover changes made to the [Mendix Marketplace](/appstore/). * The **Releases** tab on the component details page now includes two search bars, enabling you to search by release notes and Mendix versions. #### Improvements + * Videos previously located on the **Documentation** tab have been moved to the **Overview** tab on the component details page. * If you click **Start with App** on a component details page of a starter app, you will start the Create App flow. @@ -33,10 +34,11 @@ These release notes cover changes made to the [Mendix Marketplace](/appstore/). ### September 26, 2024 #### New Features + * We added several new features to the Marketplace home page: - - You can now search for marketplace content by component name or company name, and apply relevant filters. - - Filters can now be easily cleared. - - Pagination has been introduced for search results, making navigation more streamlined. + * You can now search for marketplace content by component name or company name, and apply relevant filters. + * Filters can now be easily cleared. + * Pagination has been introduced for search results, making navigation more streamlined. ### June 27, 2024 diff --git a/content/en/docs/releasenotes/sdk/metamodel/metamodel-10/metamodel-10.17.md b/content/en/docs/releasenotes/sdk/metamodel/metamodel-10/metamodel-10.17.md index 81688e4bd45..cdef499711d 100644 --- a/content/en/docs/releasenotes/sdk/metamodel/metamodel-10/metamodel-10.17.md +++ b/content/en/docs/releasenotes/sdk/metamodel/metamodel-10/metamodel-10.17.md @@ -9,37 +9,46 @@ weight: 83 ### Microflows #### MicroflowParameterObject (Element) + * We introduced the `isRequired` property. * We introduced the `defaultValue` property. #### RestOperationCallAction (Element) + * We introduced the `baseUrlParameterMapping` property. Info: "To store parameter for base url." #### RestParameterMapping (Element) + * We introduced this element. Info: "To configure body variable for REST Request." ### REST #### ConsumedRestService (ModelUnit) + * We introduced the `baseUrlParameter` property. Info: "Base url parameter." #### RestParameter (Element) + * We introduced this element. Info: "REST Document level parameter for base url." ### Pages #### Page (ModelUnit) + * We introduced the `variables` property. #### PageVariable (Element) + * We introduced the `localVariable` property. #### LocalVariable (Element) + * We introduced this element. #### Snippet (ModelUnit) -* We introduced the `variables` property. +* We introduced the `variables` property. #### BoundaryEvent (Element) + * We introduced the `isInterrupting` property. diff --git a/content/en/docs/releasenotes/studio-pro/10/10.12.md b/content/en/docs/releasenotes/studio-pro/10/10.12.md index ffac1836854..70f382736b3 100644 --- a/content/en/docs/releasenotes/studio-pro/10/10.12.md +++ b/content/en/docs/releasenotes/studio-pro/10/10.12.md @@ -57,7 +57,7 @@ This is the [MTS](/releasenotes/studio-pro/lts-mts/#mts) version 10 release for ### Known Issues * Line endings in CSS files are not being handled properly, so when using [Revert All Changes](/refguide/using-version-control-in-studio-pro/) or performing other version-control operations, CSS files appear in the [Changes on Disk](/refguide/version-control-menu/#show-changes) dialog box. - * Workaround: For details, see [this section](/refguide/troubleshoot-version-control-issues/#css-error) in *Troubleshooting Version Control*. + * Workaround: For details, see [this section](/refguide/troubleshoot-version-control-issues/#css-error) in *Troubleshooting Version Control*. * A finished parallel split path that is removed from a running workflow instance wrongly leads to a versioning conflict. Please note that "path" was called "branch" in earlier versions. * There is a positioning error in the logic editors when you are dragging a large element, such as a loop, into a sequence flow, it overlaps with the existing elements. * Studio Pro on Mac loads user settings from the previous version of the application. diff --git a/content/en/docs/releasenotes/studio-pro/10/10.13.md b/content/en/docs/releasenotes/studio-pro/10/10.13.md index 2784d8960d8..f827a889c2d 100644 --- a/content/en/docs/releasenotes/studio-pro/10/10.13.md +++ b/content/en/docs/releasenotes/studio-pro/10/10.13.md @@ -48,7 +48,6 @@ We added a new experimental conversational interface in Maia for the users to de * To launch the domain model generation interface, the user needs to open an empty domain model and click **Generate Domain Model** at its toolbar. If the domain model is not empty, the button will be disabled. * If the user closes the attached domain model, the domain model generation session within Maia will also close. - For more information on this new Maia feature, see [Domain Model Generator](/refguide/domain-model-generator/). #### Other New Features diff --git a/content/en/docs/releasenotes/studio-pro/10/10.16.md b/content/en/docs/releasenotes/studio-pro/10/10.16.md index db91b9c3d2e..24c9a4ba053 100644 --- a/content/en/docs/releasenotes/studio-pro/10/10.16.md +++ b/content/en/docs/releasenotes/studio-pro/10/10.16.md @@ -23,11 +23,11 @@ weight: 84 ### Known Issues * A finished parallel split path that is removed from a running workflow instance wrongly leads to a versioning conflict. Please note that "path" was called "branch" in earlier versions. - * Fixed in [10.17.0](/releasenotes/studio-pro/10.17/#fix-finished-parallel-split). + * Fixed in [10.17.0](/releasenotes/studio-pro/10.17/#fix-finished-parallel-split). * There is a positioning error in the logic editors when you are dragging a large element, such as a loop, into a sequence flow, it overlaps with the existing elements. - * Fixed in [10.17.0](/releasenotes/studio-pro/10.17/#fix-positioning-error). + * Fixed in [10.17.0](/releasenotes/studio-pro/10.17/#fix-positioning-error). * Line endings in CSS files are not being handled properly, so when using [Revert All Changes](/refguide/using-version-control-in-studio-pro/) or performing other version-control operations, CSS files appear in the [Changes on Disk](/refguide/version-control-menu/#show-changes) dialog box. - * Workaround: For details, see [this section](/refguide/troubleshoot-version-control-issues/#css-error) in *Troubleshooting Version Control*. + * Workaround: For details, see [this section](/refguide/troubleshoot-version-control-issues/#css-error) in *Troubleshooting Version Control*. ## 10.16.0 {#10160} diff --git a/content/en/docs/releasenotes/studio-pro/10/10.17.md b/content/en/docs/releasenotes/studio-pro/10/10.17.md index ceb587a6824..b0005c20907 100644 --- a/content/en/docs/releasenotes/studio-pro/10/10.17.md +++ b/content/en/docs/releasenotes/studio-pro/10/10.17.md @@ -100,4 +100,4 @@ We added Japanese, Chinese, Korean, and German translations of the Studio Pro in ### Known Issues * Line endings in CSS files are not being handled properly, so when using [Revert All Changes](/refguide/using-version-control-in-studio-pro/) or performing other version-control operations, CSS files appear in the [Changes on Disk](/refguide/version-control-menu/#show-changes) dialog box. - * Workaround: For details, see [this section](/refguide/troubleshoot-version-control-issues/#css-error) in *Troubleshooting Version Control*. + * Workaround: For details, see [this section](/refguide/troubleshoot-version-control-issues/#css-error) in *Troubleshooting Version Control*. diff --git a/content/en/docs/releasenotes/studio-pro/10/10.6.md b/content/en/docs/releasenotes/studio-pro/10/10.6.md index 8894575467c..a7cfc1c2425 100644 --- a/content/en/docs/releasenotes/studio-pro/10/10.6.md +++ b/content/en/docs/releasenotes/studio-pro/10/10.6.md @@ -27,7 +27,8 @@ This is the [MTS](/releasenotes/studio-pro/lts-mts/#mts) version 10 release for ### Fixes -- We fixed an issue where a data validation error triggered on a rollback or a delete. We now remove data validation errors for objects that are rolled back or deleted. Any validation errors that you generate manually using a [validation feedback](/refguide/validation-feedback/) action will also be removed when an object is rolled back or deleted. (Ticket 192090) +* We fixed an issue where a data validation error triggered on a rollback or a delete. We now remove data validation errors for objects that are rolled back or deleted. Any validation errors that you generate manually using a [validation feedback](/refguide/validation-feedback/) action will also be removed when an object is rolled back or deleted. (Ticket 192090) + * We fixed an issue in the Dojo client where a microflow using **Close all pages** activity followed by an **Open page** activity failed to open the page in specific situations after using the browser’s back button. (Ticket 229707) * We fixed an issue where scheduled events stopped being rescheduled after database connection issues occurred. (Ticket 230873) * We fixed an issue where a service worker in a PWA cached the *index.html*. This caused issues when a *new index.html* was generated, for instance, when migrating an application from the Dojo to the React client. @@ -572,6 +573,7 @@ We introduced an alternative for WebSQL with this release. After upgrading to th * Fixed in [10.17.0](/releasenotes/studio-pro/10.17/#fix-positioning-error). * Line endings in CSS files are not being handled properly, so when using [Revert All Changes](/refguide/using-version-control-in-studio-pro/) or performing other version-control operations, CSS files appear in the [Changes on Disk](/refguide/version-control-menu/#show-changes) dialog box. * Workaround: For details, see [this section](/refguide/troubleshoot-version-control-issues/#css-error) in *Troubleshooting Version Control*. + ## 10.6.3 {#1063} **Release date: February 2, 2024** From 4e8494038e137ae2c724b9a5272e76c7f1c3e97e Mon Sep 17 00:00:00 2001 From: Mark van Ments Date: Mon, 30 Dec 2024 15:08:49 +0100 Subject: [PATCH 2/2] Respond to linting errors --- .../create-content/create-modules/_index.md | 1 + .../modules/snowflake/mendix-data-loader.md | 28 +++++++++++-------- .../initiatives-overview/_index.md | 4 +-- .../integrate-with-jira.md | 12 ++++---- .../en/docs/refguide/installation/install.md | 4 +-- .../use-the-external-database-connector.md | 2 +- .../en/docs/support/submit-support-request.md | 5 ++-- 7 files changed, 31 insertions(+), 25 deletions(-) diff --git a/content/en/docs/appstore/create-content/create-modules/_index.md b/content/en/docs/appstore/create-content/create-modules/_index.md index fc9550c2893..3dea02ee986 100644 --- a/content/en/docs/appstore/create-content/create-modules/_index.md +++ b/content/en/docs/appstore/create-content/create-modules/_index.md @@ -17,6 +17,7 @@ The guidelines to develop modules and submit them to the Marketplace as as follo * For Java dependencies, follow the following guidelines: * 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. + * 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`). {{< figure src="/attachments/appstore/submit-content/userlibBlankFiles_boxed.jpg" width="400" >}} diff --git a/content/en/docs/appstore/use-content/platform-supported-content/modules/snowflake/mendix-data-loader.md b/content/en/docs/appstore/use-content/platform-supported-content/modules/snowflake/mendix-data-loader.md index bde171efb61..7463556df7d 100644 --- a/content/en/docs/appstore/use-content/platform-supported-content/modules/snowflake/mendix-data-loader.md +++ b/content/en/docs/appstore/use-content/platform-supported-content/modules/snowflake/mendix-data-loader.md @@ -48,15 +48,21 @@ Once the Mendix Data Loader is deployed, follow these steps to configure and use 5. To view the status of your data source, check the **Details**. 6. To view the configuration status, click the **Authentication Configuration** tab. 7. To set up authentication, click **Edit**, and then provide the required information based on the selected authentication type: - *For basic authentication, enter the following information: - * **Username** – A username for basic authentication into the OData resource in your Mendix application - ***Password** – A password for basic authentication into the OData resource in your Mendix application - * For OAuth authentication, enter the following information: - ***Client ID** – A client ID from your OAuth provider - * **Client Secret** – A secret associated with the client from your OAuth provider - ***Token Endpoint** – An endpoint at which the token will be validated by your OAuth provider - * **Allowed Scopes** – Allowed and custom scopes configured on the client from your OAuth provider - * **Access Token Validity** – Duration (in seconds) for which the access token is valid + + [//]: # () + + * For basic authentication, enter the following information: + * **Username** – A username for basic authentication into the OData resource in your Mendix application + * **Password** – A password for basic authentication into the OData resource in your Mendix application + * For OAuth authentication, enter the following information: + * **Client ID** – A client ID from your OAuth provider + * **Client Secret** – A secret associated with the client from your OAuth provider + * **Token Endpoint** – An endpoint at which the token will be validated by your OAuth provider + * **Allowed Scopes** – Allowed and custom scopes configured on the client from your OAuth provider + * **Access Token Validity** – Duration (in seconds) for which the access token is valid + + [//]: # () + 8. Click **Generate Script**. 9. Click **Back** to return to the **Details** page. 10. Click the **Ingestion Configuration** tab to set up your ingestion destination table. @@ -77,7 +83,7 @@ Once the Mendix Data Loader is deployed, follow these steps to configure and use 16. Click **Schedule Ingestion Task**. 17. To view the created task, go to the **Task Management** tab, where you can monitor performed ingestion jobs, suspend or enable the task, or drop it. Currently, only one ingestion task can exist at a time. 18. Grant the application **USAGE** privilege on a warehouse to enable scheduling of data ingestions. All data ingestions use the same warehouse. - You are now redirected to the **Details** page, where you can see the status of the last three ingestionse. + You are now redirected to the **Details** page, where you can see the status of the last three ingestions. 19. To view the ingested data, access the schema specified in the target database within your Snowflake environment. The ingested data is stored in the target schema of the specified target database, created by the Mendix Data Loader application. This target schema serves as a staging area. After each ingestion, copy the tables from the target schema to the desired database and schema that you want to use to store the ingested data. @@ -125,7 +131,7 @@ Additionally, you may need to verify custom claims specific to your OAuth provid ## Setting up the App Client in your OAuth Provider -When setting up the OAuth provider to be able to use it with the Mendix Data Loader, you must specify aredirect URL in order for the authorization server to redirect the user back to the application. The redirect URL from your Snowflake environment has the following format: +When setting up the OAuth provider to be able to use it with the Mendix Data Loader, you must specify a redirect URL in order for the authorization server to redirect the user back to the application. The redirect URL from your Snowflake environment has the following format: ``` https://apps-api.c1...app.snowflake.com/oauth/complete-secret diff --git a/content/en/docs/developerportal/portfolio-management/initiatives-overview/_index.md b/content/en/docs/developerportal/portfolio-management/initiatives-overview/_index.md index 1c70ec8b8b8..6615502dea3 100644 --- a/content/en/docs/developerportal/portfolio-management/initiatives-overview/_index.md +++ b/content/en/docs/developerportal/portfolio-management/initiatives-overview/_index.md @@ -151,8 +151,8 @@ Only Portfolio Managers and Contributors from the same company as the portfolio 1. Make sure that [you have linked the Jira project to your portfolio](/developerportal/portfolio-management/integrate-with-jira/#link-jira-project). 2. At the bottom of the **Epics** section, click **+ Add Jira Epics**. -2. Select the Jira project to which the epics belong. -3. Select the Jira epics. You can search by its full key or summary. +3. Select the Jira project to which the epics belong. +4. Select the Jira epics. You can search by its full key or summary. 5. Click **Add** to link the selected epics to the initiative. 6. If you need to link epics in other Jira projects to this initiative, repeat the steps from 2 to 5, until you link all the epics. You can link up to a maximum of 20 Jira epics per initiative. diff --git a/content/en/docs/developerportal/portfolio-management/integrate-with-jira.md b/content/en/docs/developerportal/portfolio-management/integrate-with-jira.md index 071f9e493ee..a7d3232df82 100644 --- a/content/en/docs/developerportal/portfolio-management/integrate-with-jira.md +++ b/content/en/docs/developerportal/portfolio-management/integrate-with-jira.md @@ -62,19 +62,19 @@ To connect your portfolio to Jira, follow these steps: * **Account**: This is the login name (the email address) of a user on the Jira platform with project access rights. * **API Token**: This is a valid API token issued by the Jira platform and assigned to the above-mentioned account. For more information on how to get this API token, see [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). -5. Click **Next**. -6. Select the Jira projects you want to link to your portfolio. You can link up to a maximum of 20 Jira projects per portfolio. +7. Click **Next**. +8. Select the Jira projects you want to link to your portfolio. You can link up to a maximum of 20 Jira projects per portfolio. {{< figure src="/attachments/developerportal/portfolio-management/integrate-with-jira/jira-configuration-wizard-page-3.png" >}} -7. Click **Save**. +9. Click **Save**. Once the configuration is completed, your portfolio is connected to Jira, and you can see the following: {{< figure src="/attachments/developerportal/portfolio-management/integrate-with-jira/jira-integration-linked-projects.png" >}} * A card with the details of your Jira integration and the **Edit Configuration** button, which enables you to [edit the current configuration of the integration](#edit-configuration). -* A list with the Jira projects that are linked to this portfolio, which contains the folllowing items: +* A list with the Jira projects that are linked to this portfolio, which contains the following items: * Project icon – This is the icon of the linked Jira project. * **Name** – This is the name of the linked Jira project. @@ -99,7 +99,7 @@ If you want to edit your existing Jira configuration, for example to rotate the ## Deleting Jira Configuration {{% alert color="warning" %}} -If you already have [linked Jira projects](#link-jira-project) to the portoflio, after you delete the Jira configuration, the linked Jira projects will be unlinked from the portfolio automatically. +If you already have [linked Jira projects](#link-jira-project) to the portfolio, after you delete the Jira configuration, the linked Jira projects will be unlinked from the portfolio automatically. {{% /alert %}} To delete a configuration, do the following steps: @@ -144,4 +144,4 @@ If you already have [linked epics from the Jira project to an initiative](/devel {{< figure src="/attachments/developerportal/portfolio-management/integrate-with-jira/warning-jira-project-unlink.png" >}} -4. Click **Unlink** to confirm your action. +5. Click **Unlink** to confirm your action. diff --git a/content/en/docs/refguide/installation/install.md b/content/en/docs/refguide/installation/install.md index c713b69133a..45c592caeef 100644 --- a/content/en/docs/refguide/installation/install.md +++ b/content/en/docs/refguide/installation/install.md @@ -89,7 +89,7 @@ The Mendix Studio Pro installation experience includes all the tools and framewo It is possible to prepare the prerequisite installers beforehand so the setup process can pick them up instead of downloading them from the remote location. Follow these steps to prepare the installers: -5. Rename the following dependencies: +1. Rename the following dependencies: * Rename the Visual C++ Redistributable for Visual Studio 2019 (x64) executable (for example, *VC_redist.x64.exe*) to*vcredist2019_x64.exe* * Rename the `latest` executable to *mendix_native_mobile_builder.exe* * Rename the *Git-{version}-64-bit.exe* executable to *git_for_windows_installer.exe* @@ -101,7 +101,7 @@ It is possible to prepare the prerequisite installers beforehand so the setup pr * For Studio Pro versions 10.11.0 and above, rename the Java Development Kit 21 (x64) *msi* (for example, *OpenJDK21U-jdk_x64_windows_hotspot_21.0.4_7.msi*) to *adoptiumjdk_21_x64.msi* * Do not rename the Microsoft Edge WebView2 Evergreen Runtime installer *MicrosoftEdgeWebview2Setup.exe*; keep it as is -6. Run the installer as described in the [Installing Mendix Studio Pro](#install) section above. +2. Run the installer as described in the [Installing Mendix Studio Pro](#install) section above. If an error occurs during JDK installation, try the following: diff --git a/content/en/docs/refguide/modeling/integration/use-extensions/use-the-external-database-connector.md b/content/en/docs/refguide/modeling/integration/use-extensions/use-the-external-database-connector.md index d1c6967846c..8c4acc6f22e 100644 --- a/content/en/docs/refguide/modeling/integration/use-extensions/use-the-external-database-connector.md +++ b/content/en/docs/refguide/modeling/integration/use-extensions/use-the-external-database-connector.md @@ -153,7 +153,7 @@ Do the following: b. If **Update Entity** is selected, you can see changes that will be made to the existing entity. Click **Update Entity** to save the query and the changes made to the entity in the domain model. - {{< figure src="/attachments/refguide/modeling/integration/use-the-external-database-connector/5b.png" width="600" >}} + {{< figure src="/attachments/refguide/modeling/integration/use-the-external-database-connector/5b.png" width="600" >}} ## Call Stored Procedure diff --git a/content/en/docs/support/submit-support-request.md b/content/en/docs/support/submit-support-request.md index 66a1d9b6f6f..d9c63327954 100644 --- a/content/en/docs/support/submit-support-request.md +++ b/content/en/docs/support/submit-support-request.md @@ -90,9 +90,8 @@ To submit a request with Mendix Support, follow these steps: 6. Fill in the other fields for the issue type you selected, including [Priority](#request-priority). 7. Optionally, enable the check box that grants Mendix Support permission to access your logs for the purpose of diagnosing and troubleshooting the issue. -{{% alert color="info" %}} -Although not required, granting this permission is highly recommended because it greatly enhances Mendix Support's ability to assist you effectively. Without it, diagnosing and resolving any issues you encounter may be challenging, potentially impacting the level of support that Mendix Support can provide. Any logs collected are strictly used for providing help on your ticket and are handled with the utmost care. -{{% /alert %}} + {{% alert color="info" %}}Although not required, granting this permission is highly recommended because it greatly enhances Mendix Support's ability to assist you effectively. Without it, diagnosing and resolving any issues you encounter may be challenging, potentially impacting the level of support that Mendix Support can provide. Any logs collected are strictly used for providing help on your ticket and are handled with the utmost care. + {{% /alert %}} 8. Make sure all your attachments have finished uploading before clicking **Next**.