Skip to content

Commit c559ca2

Browse files
Merge branch 'mendix:development' into development
2 parents c853f59 + 1eb68db commit c559ca2

File tree

52 files changed

+542
-288
lines changed

Some content is hidden

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

52 files changed

+542
-288
lines changed

assets/js/anchor.js

Lines changed: 51 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,54 @@
1-
/*
2-
* Copyright 2018 Google LLC
3-
Licensed under the Apache License, Version 2.0 (the "License");
4-
you may not use this file except in compliance with the License.
5-
You may obtain a copy of the License at
6-
https://www.apache.org/licenses/LICENSE-2.0
7-
Unless required by applicable law or agreed to in writing, software
8-
distributed under the License is distributed on an "AS IS" BASIS,
9-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10-
See the License for the specific language governing permissions and
11-
limitations under the License.
12-
*/
1+
'use strict';
132

14-
(function ($) {
15-
'use strict';
3+
document.addEventListener('DOMContentLoaded', () => {
4+
// Append anchor links to headings in Markdown
5+
const article = document.getElementsByTagName('main')[0];
6+
if (!article) {
7+
return;
8+
}
169

17-
// Headers' anchor link that shows on hover
18-
$(function () {
19-
// append anchor links to headings in markdown.
20-
var article = document.getElementsByTagName('main')[0];
21-
if (!article) {
22-
return;
23-
}
24-
var headings = article.querySelectorAll('h1, h2, h3, h4, h5, h6');
25-
headings.forEach(function (heading) {
26-
if (heading.id) {
27-
var a = document.createElement('a');
28-
// set visibility: hidden, not display: none to avoid layout change
29-
a.style.visibility = 'hidden';
30-
// [a11y] hide this from screen readers, etc..
31-
a.setAttribute('aria-hidden', 'true');
32-
// material insert_link icon in svg format
33-
a.innerHTML = ' <svg xmlns="http://www.w3.org/2000/svg" fill="currentColor" width="24" height="24" viewBox="0 0 24 24"><path d="M0 0h24v24H0z" fill="none"/><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/></svg>';
34-
a.href = '#' + heading.id;
35-
heading.insertAdjacentElement('beforeend', a);
36-
heading.addEventListener('mouseenter', function () {
37-
a.style.visibility = 'initial';
38-
});
39-
heading.addEventListener('mouseleave', function () {
40-
a.style.visibility = 'hidden';
41-
});
42-
}
43-
});
44-
});
10+
// Select all headings in the article
11+
const headings = article.querySelectorAll('h1, h2, h3, h4, h5, h6');
12+
headings.forEach((heading) => {
13+
if (heading.id) {
14+
const a = document.createElement('a');
15+
a.setAttribute('aria-hidden', 'true');
16+
a.classList.add('anchor-icon'); // Add anchor-icon class (_styles_project.scss)
17+
a.innerHTML = `<svg xmlns="http://www.w3.org/2000/svg" fill="var(--bs-body-color)" width="20" height="20" viewBox="0 0 32 32"><path d="M18.9001 7.22C20.5201 5.6 23.1601 5.6 24.7801 7.22C26.4001 8.84 26.4001 11.48 24.7801 13.1L20.4001 17.48L21.8101 18.89L26.1901 14.51C28.5901 12.11 28.5901 8.2 26.1901 5.8C23.7901 3.4 19.8801 3.4 17.4801 5.8L13.1001 10.18L14.5101 11.59L18.8901 7.21L18.9001 7.22Z"/><path d="M10.16 28C11.74 28 13.32 27.4 14.52 26.2L18.9 21.82L17.49 20.41L13.11 24.79C11.49 26.41 8.85002 26.41 7.23002 24.79C5.61002 23.17 5.61002 20.53 7.23002 18.91L11.61 14.53L10.2 13.12L5.82002 17.5C3.42002 19.9 3.42002 23.81 5.82002 26.21C7.02002 27.41 8.60002 28.01 10.18 28.01L10.16 28Z"/><path d="M9.44971 21.1336L21.124 9.45927L22.5383 10.8735L10.8639 22.5478L9.44971 21.1336Z"/></svg>`;
18+
a.href = '#' + heading.id;
4519

46-
}(jQuery));
20+
// Append anchor element to heading
21+
heading.appendChild(a);
22+
23+
// Show icon when hovering over heading
24+
heading.addEventListener('mouseenter', () => {
25+
a.style.display = 'inline-block';
26+
});
27+
28+
// Hide icon when mouse leaves heading
29+
heading.addEventListener('mouseleave', () => {
30+
a.style.display = 'none';
31+
});
32+
33+
// Initialize Bootstrap tooltip
34+
const tooltip = new bootstrap.Tooltip(a, {
35+
title: 'Copy link to clipboard',
36+
placement: 'right',
37+
trigger: 'hover focus'
38+
});
39+
40+
// Add on-click behavior
41+
a.addEventListener('click', (event) => {
42+
event.preventDefault(); // Prevent scrolling
43+
const href = a.href;
44+
navigator.clipboard.writeText(href); // Copy to clipboard
45+
window.history.pushState({}, document.title, href); // Update URL
46+
// Update tooltip text
47+
const tooltipInner = document.querySelector('div.tooltip-inner');
48+
if (tooltipInner) {
49+
tooltipInner.textContent = 'Copied!';
50+
}
51+
});
52+
}
53+
});
54+
});

assets/scss/_styles_project.scss

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,19 @@
100100
padding-bottom: 0px;
101101
}
102102

103+
// Anchor icon styling for anchor.js
104+
105+
.anchor-icon {
106+
display: none;
107+
padding: 0rem .3rem .1rem .3rem;
108+
margin: -.5rem 0rem -.5rem .3rem;
109+
border-radius: 4px;
110+
}
111+
112+
.anchor-icon:hover {
113+
background: $gray-light;
114+
}
115+
103116
// _code.scss - Code formatting
104117

105118
.td-content {
@@ -574,7 +587,6 @@ nav.foldable-nav {
574587
// _tables.scss - from https://github.com/twbs/bootstrap/blob/v4.6.2/scss/_tables.scss
575588

576589
.table {
577-
width: 90%; // NK - adjusted width to match rest of content
578590
margin-bottom: $spacer;
579591
color: $table-color;
580592
background-color: $table-bg; // Reset for nesting within parents with `background-color`.

assets/scss/_variables_project.scss

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,5 +165,8 @@ $navbar-dark-hover-color: rgba($white, 0.5) !default;
165165
$navbar-dark-active-color: $white !default;
166166
$navbar-dark-disabled-color: rgba($white, 0.25) !default;
167167

168+
// Tooltip
169+
$tooltip-bg: $secondary;
170+
168171
// The yiq lightness value that determines when the lightness of color changes from "dark" to "light".
169172
$yiq-contrasted-threshold: 200 !default;

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

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -951,22 +951,36 @@ To solve this issue, follow these steps:
951951

952952
After the status of the models changes to **Access Granted**, you can use it with the Amazon Bedrock connector.
953953

954-
### 5.2 Error code 404 - Resource Not Found
954+
### 5.3 Error code 403 - AccessDeniedException
955955

956-
When invoking a model the error code *404 - Resource Not Found* indicates that the targeted resource was not found.
956+
When invoking a model, the error code *403 - Access denied* indicates that you do not have access to the targeted resource.
957957

958-
#### 5.2.1 Cause
958+
#### 5.3.1 Cause
959959

960960
Possible root causes for this error include the following:
961961

962962
* You do not have access to the model in the specified AWS region.
963+
964+
#### 5.3.2 Solution
965+
966+
To solve this issue, ensure that you have selected an AWS Region where you have model access. You can see an overview of the models accessible to you in the AWS Management Console, in the [Model Access](https://us-west-2.console.aws.amazon.com/bedrock/home?#/modelaccess) section of your Amazon Bedrock environment.
967+
968+
### 5.4 Error code 404 - ResourceNotFoundException
969+
970+
When invoking a model, the error code *404 - Resource not found* indicates that the targeted resource was not found.
971+
972+
#### 5.4.1 Cause
973+
974+
Possible root causes for this error include the following:
975+
976+
* The model which you are trying to invoke is not available in your specified AWS region.
963977
* The model which you are trying to invoke is deprecated.
964978

965-
#### 5.2.2 Solution
979+
#### 5.4.2 Solution
966980

967981
To solve this issue, verify the following:
968982

969-
1. Ensure that you have selected an AWS Region where you have model access. You can see an overview of the models accessible to you in the AWS Management Console, in the [Model Access](https://us-west-2.console.aws.amazon.com/bedrock/home?region=us-west-2#/modelaccess) section of your Amazon Bedrock environment.
983+
1. Ensure that you have selected an AWS Region where the targeted model exists. You can see an overview of the models accessible to you in the AWS Management Console, on the [Overiew page](https://us-west-2.console.aws.amazon.com/bedrock/home?#/overview) of your Amazon Bedrock environment. Make sure the region specified in the AWS Console matches the region you have configured in Mendix.
970984
2. Ensure that the model that you have selected is not deprecated and that the *model-id* is currently available in Amazon Bedrock.
971985

972986
## 6 Appendix
@@ -1011,3 +1025,16 @@ The guardrail feature will allow you to:
10111025
The watermark detection feature will make it possible to tell if an image has been created using Amazon Titan.
10121026

10131027
More information about guardrails can be found in this [AWS blogpost](https://aws.amazon.com/blogs/aws/guardrails-for-amazon-bedrock-helps-implement-safeguards-customized-to-your-use-cases-and-responsible-ai-policies-preview/) and in the [AWS documentation](https://aws.amazon.com/en/bedrock/guardrails/).
1028+
1029+
#### 6.3 Advanced Prompts for Agents
1030+
1031+
By default, an agent is configured with the following base prompt templates, one for each step in the agent sequence:
1032+
1033+
* Pre-processing
1034+
* Orchestration
1035+
* Knowledge base response generation
1036+
* Post-processing
1037+
1038+
By customizing the prompt templates and modifying these configurations, you can fine-tune your agent's accuracy. Additionally, you can provide custom examples for a technique known as few-shot prompting. This involves providing labeled examples for specific tasks, which further enhances the model's performance in targeted areas. For more information about advanced prompts, see [Advanced prompts](https://docs.aws.amazon.com/bedrock/latest/userguide/advanced-prompts.html) in the AWS documentation.
1039+
1040+
You can also use placeholder variables in agent prompt templates. For example, in the orchestration prompt template, the *$prompt_session_attributes$* placeholder variable can be used to ingest the information from the `PromptSessionAttribute` entity into the prompt, if it was specified as part of the `InvokeAgentRequest`. For more information about placeholder variables available in agent prompt templates, see [Prompt placeholders](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-placeholders.html) in the AWS documentation.

content/en/docs/appstore/modules/document-generation.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The [PDF Document Generation](https://marketplace.mendix.com/link/component/2115
2222
### 1.2 Limitations
2323

2424
* Currently, PDF is the only supported document export format.
25-
* For deployment, currently we support [Mendix Public Cloud](/developerportal/deploy/mendix-cloud-deploy/), [Mendix for Private Cloud Connected](/developerportal/deploy/private-cloud/), and [On-Premises](/developerportal/deploy/on-premises-design/). Other deployment scenarios will be supported at a later stage.
25+
* For deployment, currently we support [Mendix Public Cloud](/developerportal/deploy/mendix-cloud-deploy/), [Mendix Cloud Dedicated](/developerportal/deploy/mendix-cloud-deploy/), [Mendix for Private Cloud Connected](/developerportal/deploy/private-cloud/), and [On-Premises](/developerportal/deploy/on-premises-design/). Other deployment scenarios will be supported at a later stage.
2626

2727
{{% alert color="info" %}}For all deployment types except for on-premises, we only support apps that allow bi-directional communication with the PDF Service in the Mendix Public Cloud.{{% /alert %}}
2828

@@ -66,6 +66,7 @@ Follow the instructions in [Using Marketplace Content](/appstore/overview/use-co
6666

6767
1. [Running on Mendix Cloud](#run-on-mendix-cloud) using the PDF service in the Mendix Public Platform. This option is available for apps that are deployed to the following environments:
6868
* [Mendix Public Cloud](/developerportal/deploy/mendix-cloud-deploy/)
69+
* [Mendix Cloud Dedicated](/developerportal/deploy/mendix-cloud-deploy/)
6970
* [Mendix for Private Cloud Connected](/developerportal/deploy/private-cloud/)
7071

7172
2. [Running On-Premises](#run-on-premises) using a local version of the PDF service. This option is available for apps that are deployed to the following environments:
@@ -96,7 +97,7 @@ To allow the module to send and receive document generation requests on your Men
9697

9798
1. Enable the DocGen request handler.
9899

99-
{{% alert color="info" %}}This step is only for licensed apps on the Mendix Public Cloud. If your app is deployed on [Mendix for Private Cloud Connected](/developerportal/deploy/private-cloud/), skip this step and make sure that the */docgen/* path is accessible.{{% /alert %}}
100+
{{% alert color="info" %}}This step is only for licensed apps on the Mendix Public Cloud or Mendix Cloud Dedicated. If your app is deployed on [Mendix for Private Cloud Connected](/developerportal/deploy/private-cloud/), skip this step and make sure that the */docgen/* path is accessible.{{% /alert %}}
100101

101102
2. Register your app environments.
102103

@@ -108,7 +109,7 @@ The steps for each procedure are described in the sections below.
108109

109110
1. Make sure that you have configured the **DocumentGeneration** module as described in the [Configuration](#configuration) section.
110111

111-
2. Make sure that you have the application [deployed to Mendix Public Cloud](/developerportal/deploy/mendix-cloud-deploy/#deploy-app-mendix-cloud).
112+
2. Make sure that you have the application [deployed to the desired Mendix Cloud](/developerportal/deploy/mendix-cloud-deploy/#deploy-app-mendix-cloud).
112113

113114
3. To allow the module to send and receive document generation requests in your Mendix Cloud environments, enable the DocGen request handler as follows:
114115

@@ -361,6 +362,7 @@ In case you encounter any issues while [registering your app environment](#regis
361362
| **Invalid Developer Credentials** | "Invalid developer credentials" | The developer information as provided in the **Email** and **API key** fields is incorrect. | Verify that the provided email address in the **Email** field matches the username in your Mendix developer profile, and also that the API key that is being used is correct and still active. |
362363
| **Invalid App** | <ul><li>"Invalid app"</li></ul><ul><li>"App not found for the given user"</li></ul> | The provided apple ID is either incorrect or the developer (based on the **Email** and **API key** fields) does not have access to this app. | Verify that the **App ID** field is correct, and also that the developer account corresponding to the details entered in the **Email** and **API key** fields has access to the given app. |
363364
| **Invalid Application URL** | "Application URL does not match any of the environment URLs" | The app corresponding to the **App ID** field does not contain any environment that matches the URL given in the **Application URL** field. | Verify that the **App ID** and **Application URL** fields are correct. |
365+
| **Invalid Deployment Type** | <ul><li>"Application should be deployed on Mendix Public Cloud"</li></ul><ul><li>"Deployment type should be Mendix Public Cloud"</li></ul> | The provided **Application URL** is either incorrect or the chosen **Deployment type** is incorrect for this app. | Verify that the entered **Application URL** is correct and that you have chosen the correct **Deployment type**. |
364366
| **Unable to Reach App** | <ul><li>"Domain verification failed, unable to reach app"</li></ul><ul><li>"Domain verification failed, unable to reach verification endpoint"</li></ul><ul><li>"Domain verification failed, verification endpoint inactive" </li></ul>| The cloud service was unable to reach your app. | Verify that you enabled the `ASu_DocumentGeneration_Initialize` after startup microflow and also allowed access to the DocGen request handler. For more information, see [Enabling the DocGen Request Handler](#enable-docgen). |
365367
| **Invalid Token** | "Domain verification failed, invalid token" | The cloud service was able to reach your app, but could not verify that this app is currently trying to register. | Verify that the application URL matches the current environment. |
366368
| **Other Errors** |<ul><li>"Project verification failed"</li></ul><ul><li>"Domain verification failed, invalid response from verification endpoint"</li></ul><ul><li>"Domain verification failed for unknown reason"</li></ul> | An unexpected error occurred. | Verify that your app was not restarted by someone else during the registration process. If not, submit a ticket in the Mendix Support Portal. |
@@ -395,7 +397,7 @@ We recommend that you temporarily set the log level of the `DocumentGeneration`
395397

396398
#### 6.2.3 Cloud Service Errors
397399

398-
In case you encounter the message "Unable to generate document, service response code: 401" in the logs of your cloud environment, the request was rejected by the document generation service. This could be caused by the following reasons:
400+
In case you encounter the message "Unable to generate document for request `<requestId>`, service response code: 401" in the logs of your cloud environment, the request was rejected by the document generation service. This could be caused by the following reasons:
399401

400402
* The scheduled event **SE_AccessToken_Refresh** is not enabled, which caused the registration to expire. Enable the scheduled event and [register](#register-app) the affected app environment again.
401403
* The URL of the app environment does not match the URL that was provided during registration. This could be the case when you requested a change to the URL of your app, or after restoring a database backup from one environment to another. [Register](#register-app) the affected app environment (or environments) again.

content/en/docs/appstore/modules/mobile-sso.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This module has the following limitations:
3838

3939
* Mendix sessions in the mobile app do not time out.
4040
* Mobile SSO module does not support any other protocol except OIDC.
41-
* It doesn not support IdPs that lack Custom callback URLs, such as Facebook.
41+
* IdPs that lack support for Custom callback URLs, such as Facebook, are not supported.
4242
* Private use URI Schemes as per [RFC8252, section 7.1](https://datatracker.ietf.org/doc/html/rfc8252#section-7.1) are not used.
4343
* Approximately 5% of sign in attempts for the iOS app are unsuccessful, resulting in an error message indicating failure to sign in. However, a subsequent attempt usually leads to successful sign in.
4444

content/en/docs/community-tools/contribute-to-mendix-docs/indentation-spacing-test.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Paragraph text here.
2424

2525
Another paragraph here.
2626

27-
## 1 Indents and Spacing
27+
## 1 Indents and Spacing 123456 12345678
2828

2929
See [Section Spacing Tests](#spacing) for multiple examples of spacing.
3030

content/en/docs/developerportal/deploy/mendix-cloud-deploy/environments-details.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ The **Environment Details** page shows information about the selected environmen
2424
In the **General** tab, you can find the following information about your environment:
2525

2626
* **Status**
27-
* {{% icon name="checkmark-circle" color="green" %}} – the application in this environment is running
28-
* {{% icon name="subtract-circle" color="gray" %}} – no application has been started yet in this environment, or it has been turned off
29-
* {{% icon name="remove-circle" color="red" %}} – the application in this environment is unstable and probably not usable anymore
27+
* {{% icon name="checkmark-circle-filled" color="green" %}} – the application in this environment is running
28+
* {{% icon name="subtract-circle-filled" color="gray" %}} – no application has been started yet in this environment, or it has been turned off
29+
* {{% icon name="remove-circle-filled" color="red" %}} – the application in this environment is unstable and probably not usable anymore
3030
* **Running since** – the date the app was started, if it is running
3131
* **Name** – the type of environment (Acceptance, Production, Test, or the name of a [flexible environment](/developerportal/deploy/mendix-cloud-deploy/#flexible-environments)); for more information, see the [Naming of Environments](#naming) section below
3232
* **Url** – the URL of the app

0 commit comments

Comments
 (0)