Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ The Documentation group maintains guidelines on terminology, grammar, formatting

The tone of the Mendix documentation is conversational, relaxed, and always straight-forward. The tone reflects the Documentation group's values.

Our language conventions are based on American English.
Our language conventions are based on American English.
Original file line number Diff line number Diff line change
Expand Up @@ -539,4 +539,4 @@ Format example URLs (those not linking to Mendix or third-party sites) with Mark

Use present tense. The present tense is often easier to read and understand than the past or future tense. For more information, see [Verb Tense](https://docs.microsoft.com/en-us/style-guide/grammar/verbs#verb-tense) in the *Microsoft Style Guide*.

> Save the file. Gulp rebuilds the code in the console as soon as you save the file.
> Save the file. Gulp rebuilds the code in the console as soon as you save the file.
Original file line number Diff line number Diff line change
Expand Up @@ -497,4 +497,4 @@ You can shorten this to "visual builder", but do not capitalize "visual builder"

### Workflow Engine

Capitalize.
Capitalize.
Original file line number Diff line number Diff line change
Expand Up @@ -550,4 +550,4 @@ Do not capitalize.

## X-axis & Y-axis

Capitalize "X" and "Y".
Capitalize "X" and "Y".
1 change: 1 addition & 0 deletions content/en/docs/deployment/docker-deploy/docker-pad.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ To build a Docker image from the Portable Package, perform the following steps:
# Set the start script to the Mendix Runtime execute command
CMD ["./bin/start", "etc/Default"]
```

You must create this Dockerfile yourself and place it alongside the application files generated by the Portable App Distribution. The `COPY` commands in the example above assume that the `app`, `bin`, `etc`, and `lib` directories are in the same location as your Dockerfile.

3. Build the Docker image by using the following command: `docker build -t <your-image-name>:<tag> -f build/docker/Dockerfile`, where:
Expand Down
3 changes: 1 addition & 2 deletions content/en/docs/deployment/general/pad/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ To run your app locally, perform the following steps:
The Mendix admin port can be used to fetch metrics and other runtime data from an app. It requires a password for security reasons.
{{% /alert %}}

3. Run the app by using one of the following commands:
1. Run the app by using one of the following commands:

* For Windows, run the command `<your folder location>\bin\start.bat`
* For Windows Powershell, run the command `<your folder location>\bin\start.ps1`
Expand All @@ -69,7 +69,6 @@ The Mendix admin port can be used to fetch metrics and other runtime data from a
On Linux, if the ZIP was extracted on Windows, the +x flag is not preserved. Windows does not have the executability bit. You need to run the command `chmod +x ./bin/start` first.
{{% /alert %}}


### Deploying to a Self-Hosted Environment

For more information about deploying to a self-hosted environment, refer to the following topics:
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/deployment/general/pad/pad-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,4 +283,4 @@ runtime.params {
# Type: String
# ClientCertificates = ""
}
```
```
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ Therefore, do not assume that an established WebSocket connection will remain op
* Implement robust reconnection logic to gracefully handle connectivity loss and automatically reestablish dropped connections.
* For WebSocket connections, a specific client always communicates with the same application instance. However, different connections, such as those from multiple browsers or after a page refresh, may be routed to different application instances.


## Move to Kubernetes

* Only [supported Mendix versions](/releasenotes/studio-pro/lts-mts/) are able to move to Kubernetes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ applications:
env:
```

5. Run the `cf push` command.
6. Verify that the Mendix app has started successfully.
1. Run the `cf push` command.
2. Verify that the Mendix app has started successfully.
12 changes: 6 additions & 6 deletions content/en/docs/deployment/on-premises-design/linux/linux-pad.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ If your application requires it, you can change the Java version on vendor as ne
Your Portable App Distribution only requires a Java Runtime Environment (JRE) to run, but it is often recommended to install a full JDK as it includes the JRE and development tools.
{{% /alert %}}

4. Verify that Java is correctly installed by running the following command: `java -version`.
5. Upload the Portable App Distribution .zip file to a location where your Linux server can access it by using one of the following options, depending on the location and configuration of your Linux machine.
1. Verify that Java is correctly installed by running the following command: `java -version`.
2. Upload the Portable App Distribution .zip file to a location where your Linux server can access it by using one of the following options, depending on the location and configuration of your Linux machine.

* For Azure Blob Storage (often done as part of a CI/CD pipeline): `az storage blob upload --account-name <your storage account name> --container-name <your container name> --name <your app>.zip --file <your project folder>/build/distributions/your-app.zip --auth-mode login`

Expand All @@ -77,7 +77,7 @@ Your Portable App Distribution only requires a Java Runtime Environment (JRE) to

* From a public URL using `wget`: `wget https://<path to your file>.zip`

6. Download the .zip file onto your Linux server by using one of the following options, depending on the location and configuration of your Linux machine.
3. Download the .zip file onto your Linux server by using one of the following options, depending on the location and configuration of your Linux machine.

* For Azure Blob Storage: `az storage blob download --account-name <your storage account name> --container-name <your container name> --name <your app>.zip --file /home/<your user name>/<your app>.zip --auth-mode login`

Expand All @@ -95,8 +95,8 @@ Your Portable App Distribution only requires a Java Runtime Environment (JRE) to

You can also retrieve the files using `wget`.

7. Extract the .zip file by running the following command: `unzip <your app>.zip -d <your desired directory>`.
8. Navigate into the extracted directory and execute the start script by running the following command:
4. Extract the .zip file by running the following command: `unzip <your app>.zip -d <your desired directory>`.
5. Navigate into the extracted directory and execute the start script by running the following command:

```text
cd your-desired-directory
Expand All @@ -105,7 +105,7 @@ Your Portable App Distribution only requires a Java Runtime Environment (JRE) to

The `bin/start` script is a common convention for Portable App Distributions using the Default configuration. If your application uses a different configuration, start script, or command, adjust accordingly.

9. Verify that the application is running by opening the following URL in your browser: `http://<public IP of your Linux instance>:8080`.
6. Verify that the application is running by opening the following URL in your browser: `http://<public IP of your Linux instance>:8080`.

`8080` is the default port. If your application is configured to run on a different port, adjust accordingly.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,24 +84,24 @@ To install the solution, perform the following steps:
Keep in mind that changing the ingress type resets the value of all fields in this tab.
{{% /alert %}}

12. In the **Registry** tab, specify your network ingress settings. For more information about the available options, see [Registry Configuration](/developerportal/deploy/private-cloud-registry/).
1. In the **Registry** tab, specify your network ingress settings. For more information about the available options, see [Registry Configuration](/developerportal/deploy/private-cloud-registry/).

{{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/helm-chart-wizard6.png" >}}

{{% alert color="info" %}}
Keep in mind that changing the registry type resets the value of all fields in this tab.
{{% /alert %}}

13. Optional: In the **Proxy** tab, specify a proxy server.
1. Optional: In the **Proxy** tab, specify a proxy server.

{{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/helm-chart-wizard7.png" >}}

14. Optional: If your servers use a self-signed certificate, in the **Custom TLS** tab, configure custom TLS so that the self-signed certificate is accepted.
2. Optional: If your servers use a self-signed certificate, in the **Custom TLS** tab, configure custom TLS so that the self-signed certificate is accepted.

{{< figure src="/attachments/deployment/private-cloud/private-cloud-cluster/helm-chart-wizard8.png" >}}

15. Click **Generate & Download** to generate the yaml file with the configurations that you provided.
16. Run the following commands:
3. Click **Generate & Download** to generate the yaml file with the configurations that you provided.
4. Run the following commands:

1. Install the required [Custom Resource Definitions](/developerportal/deploy/private-cloud-technical-appendix-01/#custom-resources) by running `kubectl apply -f mx-privatecloud-operator-crd/crds/`.
2. Install Mendix on Kubernetes by running `helm install --createnamespace -n <your namespace> -f <yaml file name> <release name> mx-privatecloud-operator-installer`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ If you want to use specific resources, you should instead expose a new endpoint
9. Click **Back** to return to the **Details** page.
10. Click the **Ingestion Configuration** tab to set up your ingestion destination table.
11. Click **Create** to start setting up the Ingestion Configuration.
* **Target Database** – Name of the database for data ingestion
***Target Database** – Name of the database for data ingestion
* **Target Schema** – Target schema where all data will be ingested
12. Click **Save**.
13. Click the **Data Ingestion** tab, where you can start your data ingestion or set up a schedule.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -312,8 +312,8 @@ Snowflake Cortex Analyst is now generally available. For more information, refer

* Make sure that you have access to Cortex Analyst. For more information, refer to the [Snowflake Cortex Analyst documentation](https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-analyst).
* Create a semantic model, semantic model view, or inline semantic model for Cortex Analyst. For more information, refer to:
* [Creating Semantic Models for Snowflake Cortex Analyst](https://developers.snowflake.com/solution/creating-semantic-models-for-snowflakes-cortex-analyst/)
* [Using Semantic Model Views](https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-analyst#understanding-semantic-views)
* [Creating Semantic Models for Snowflake Cortex Analyst](https://developers.snowflake.com/solution/creating-semantic-models-for-snowflakes-cortex-analyst/)
* [Using Semantic Model Views](https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-analyst#understanding-semantic-views)
* Set up one of the following supported authentication methods for Cortex Analyst:
* OAUTH
* KEYPAIR_JWT
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,28 +11,28 @@ The [Markdown Viewer](https://marketplace.mendix.com/link/component/230248/) wid

The widget does the following:

- Displays markdown-formatted text as rendered HTML, supporting headings, bold, italic, lists, links, images, tables, code blocks, blockquotes, and horizontal rules
- Applies typographic enhancements such as smart quotes, em dashes, en dashes, and ellipses
- Automatically converts URLs in the text to clickable links
- Shows a loading indicator while the data source is being retrieved
* Displays markdown-formatted text as rendered HTML, supporting headings, bold, italic, lists, links, images, tables, code blocks, blockquotes, and horizontal rules
* Applies typographic enhancements such as smart quotes, em dashes, en dashes, and ellipses
* Automatically converts URLs in the text to clickable links
* Shows a loading indicator while the data source is being retrieved

### Typical Use Cases

This widget is often used in use cases like:

- Displaying user-authored markdown content such as knowledge base articles or notes
- Rendering formatted text stored in a database attribute
- Showing `README.md`-style documentation within a Mendix application
* Displaying user-authored markdown content such as knowledge base articles or notes
* Rendering formatted text stored in a database attribute
* Showing `README.md`-style documentation within a Mendix application

### Features

This widget leverages the following features:

- Standard markdown syntax rendering, including headings, emphasis, lists, links, images, tables, code blocks, blockquotes, and horizontal rules
- Typographic replacements (smart quotes, em dashes, en dashes, ellipses)
- Automatic URL-to-link conversion (linkification)
- Offline capable
- Conditional visibility support
* Standard markdown syntax rendering, including headings, emphasis, lists, links, images, tables, code blocks, blockquotes, and horizontal rules
* Typographic replacements (smart quotes, em dashes, en dashes, ellipses)
* Automatic URL-to-link conversion (linkification)
* Offline capable
* Conditional visibility support

## Configuration

Expand All @@ -47,27 +47,27 @@ Use an unlimited string data type for the **Value attribute** to avoid truncatio

Optionally, you can configure the widget further:

- Navigate to the **Label** section to add a label for the widget
- Navigate to the **Conditional visibility** section to control when the widget is displayed
* Navigate to the **Label** section to add a label for the widget
* Navigate to the **Conditional visibility** section to control when the widget is displayed

## Styling

The widget renders its content inside a container with the `widget-markdown` CSS class. The following default styles are applied:

- **Tables** — rendered with borders, padding, and left-aligned text. Header cells have a light gray background
- **Images** — render at a maximum of 35% of the container width by default
- **Horizontal rules** — span the full width of the container
* **Tables** — rendered with borders, padding, and left-aligned text. Header cells have a light gray background
* **Images** — render at a maximum of 35% of the container width by default
* **Horizontal rules** — span the full width of the container

You can override these styles by targeting the `.widget-markdown` class in your custom SCSS or theme.

## Limitations

This widget has the following limitations:

- The widget is read-only, and does not provide editing or input capabilities
- Code blocks render as plain monospace text without syntax highlighting
- Custom HTML tags within markdown content are not supported
* The widget is read-only, and does not provide editing or input capabilities
* Code blocks render as plain monospace text without syntax highlighting
* Custom HTML tags within markdown content are not supported

## Read More

- [markdown-it](https://github.com/markdown-it/markdown-it): the markdown parsing library used by this widget
* [markdown-it](https://github.com/markdown-it/markdown-it): the markdown parsing library used by this widget
Original file line number Diff line number Diff line change
Expand Up @@ -225,4 +225,4 @@ Users must generate their own PAT to work with Azure DevOps by doing the followi
4. On the Microsoft login screen, input you Azure user credentials to verify and authorize the app.
5. Wait for the PAT and Azure user email to be displayed on the **Service Credentials** page in Private Mendix Platform.

{{< figure src="/attachments/private-platform/pmp-vc5.png" alt="Version Control Settings for Azure DevOps" class="no-border" >}}
{{< figure src="/attachments/private-platform/pmp-vc5.png" alt="Version Control Settings for Azure DevOps" class="no-border" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ To understand how updates to your Mendix PWA are handled, you need to understand
1. **Registration** — In this step the browser downloads the service worker file. If the code contains syntax errors, registration fails and the service worker is discarded.
2. **Installation** — During this phase, the service worker typically caches static assets your PWA needs to function offline. If all assets are successfully pre-cached, the installation succeeds. If installation fails, the service worker is discarded.
* Once installed:
- It becomes activated immediately if no other service worker is currently controlling the page.
- If there is already an active service worker, the new one will be installed but enters a **Waiting** state. The **Waiting** state, ensures that updates to your application are delivered smoothly and without interrupting your users' current interactions.
* It becomes activated immediately if no other service worker is currently controlling the page.
* If there is already an active service worker, the new one will be installed but enters a **Waiting** state. The **Waiting** state, ensures that updates to your application are delivered smoothly and without interrupting your users' current interactions.
3. **Activation** — Once installed, the service worker enters the **Activating** state, and then becomes **Activated**. An **Activated** service worker takes control of pages within its scope (meaning it is ready to intercept requests).
4. **Redundant** — A service worker can become redundant if a new version replaces it, or if it fails to install.

Expand Down Expand Up @@ -112,7 +112,7 @@ export async function JS_ListenForPWAUpdates() {
}
```

2. **Create a JavaScript Action to activate the new service worker** — When the user confirms the update, use the Client API `skipWaiting()` to activate the new service worker:
1. **Create a JavaScript Action to activate the new service worker** — When the user confirms the update, use the Client API `skipWaiting()` to activate the new service worker:

```javascript
import { skipWaiting } from "mx-api/pwa";
Expand All @@ -134,5 +134,5 @@ export async function JS_ActivatePWAUpdate() {
}
```

3. **Notifying users** — To not interrupt users during critical operations, Mendix recommends notifying them when an update becomes available. For example, you can implement a nanoflow that prompts users to confirm the update when a new version is detected. If the user confirms, the nanoflow can call `JS_ActivatePWAUpdate` to update. This nanoflow can be passed as a parameter to `JS_ListenForPWAUpdates`, which will invoke it when an update is detected.
4. **Reload the Application** — Trigger a reload, or ask users to reload all open tabs or windows to ensure the application loads with the newly activated service worker.
1. **Notifying users** — To not interrupt users during critical operations, Mendix recommends notifying them when an update becomes available. For example, you can implement a nanoflow that prompts users to confirm the update when a new version is detected. If the user confirms, the nanoflow can call `JS_ActivatePWAUpdate` to update. This nanoflow can be passed as a parameter to `JS_ListenForPWAUpdates`, which will invoke it when an update is detected.
2. **Reload the Application** — Trigger a reload, or ask users to reload all open tabs or windows to ensure the application loads with the newly activated service worker.
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,9 @@ On Windows, PWA Wrapper can prepare the iOS bundle but not complete the final si

On Windows, use the same steps 1 through 7 as in [Steps for iOS on macOS](#steps-on-mac), then continue as follows:

8. Open the output folder and locate the portable signing ZIP.
9. Copy the portable signing ZIP to a Mac.
10. Complete the final signing step on macOS as described in [Complete Signing on macOS](/refguide/mobile/pwa-wrapper/sign-pwa-wrapper-apps/#complete-signing-on-macos) in *Sign PWA Wrapper Apps*.
1. Open the output folder and locate the portable signing ZIP.
2. Copy the portable signing ZIP to a Mac.
3. Complete the final signing step on macOS as described in [Complete Signing on macOS](/refguide/mobile/pwa-wrapper/sign-pwa-wrapper-apps/#complete-signing-on-macos) in *Sign PWA Wrapper Apps*.

### iOS Notes

Expand Down
Loading