Skip to content

Commit d433cca

Browse files
Merge pull request #11142 from mendix/lint-docs
[Auto] Lint docs
2 parents cf84d11 + 4fdf9bb commit d433cca

33 files changed

Lines changed: 363 additions & 371 deletions

File tree

content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ The Documentation group maintains guidelines on terminology, grammar, formatting
1111

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

14-
Our language conventions are based on American English.
14+
Our language conventions are based on American English.

content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/grammar-formatting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -539,4 +539,4 @@ Format example URLs (those not linking to Mendix or third-party sites) with Mark
539539

540540
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*.
541541

542-
> Save the file. Gulp rebuilds the code in the console as soon as you save the file.
542+
> Save the file. Gulp rebuilds the code in the console as soon as you save the file.

content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/product-naming-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -497,4 +497,4 @@ You can shorten this to "visual builder", but do not capitalize "visual builder"
497497

498498
### Workflow Engine
499499

500-
Capitalize.
500+
Capitalize.

content/en/docs/community-tools/contribute-to-mendix-docs/style-guide/terminology.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -550,4 +550,4 @@ Do not capitalize.
550550
551551
## X-axis & Y-axis
552552

553-
Capitalize "X" and "Y".
553+
Capitalize "X" and "Y".

content/en/docs/deployment/docker-deploy/docker-pad.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ To build a Docker image from the Portable Package, perform the following steps:
9393
# Set the start script to the Mendix Runtime execute command
9494
CMD ["./bin/start", "etc/Default"]
9595
```
96+
9697
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.
9798
9899
3. Build the Docker image by using the following command: `docker build -t <your-image-name>:<tag> -f build/docker/Dockerfile`, where:

content/en/docs/deployment/general/pad/_index.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,8 @@ To run your app locally, perform the following steps:
5555
* For Windows, run the command `set M2EE_ADMIN_PASS=<your password>`
5656
* For Linux, run the command `export M2EE_ADMIN_PASS=<your password>`
5757

58-
{{% alert color="info" %}}
59-
The Mendix admin port can be used to fetch metrics and other runtime data from an app. It requires a password for security reasons.
60-
{{% /alert %}}
58+
{{% alert color="info" %}}The Mendix admin port can be used to fetch metrics and other runtime data from an app. It requires a password for security reasons.
59+
{{% /alert %}}
6160

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

@@ -69,7 +68,6 @@ The Mendix admin port can be used to fetch metrics and other runtime data from a
6968
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.
7069
{{% /alert %}}
7170

72-
7371
### Deploying to a Self-Hosted Environment
7472

7573
For more information about deploying to a self-hosted environment, refer to the following topics:

content/en/docs/deployment/general/pad/pad-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,4 +283,4 @@ runtime.params {
283283
# Type: String
284284
# ClientCertificates = ""
285285
}
286-
```
286+
```

content/en/docs/deployment/mendix-cloud-deploy/behavior-of-app.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@ Therefore, do not assume that an established WebSocket connection will remain op
6161
* Implement robust reconnection logic to gracefully handle connectivity loss and automatically reestablish dropped connections.
6262
* 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.
6363
64-
6564
## Move to Kubernetes
6665
6766
* Only [supported Mendix versions](/releasenotes/studio-pro/lts-mts/) are able to move to Kubernetes.

content/en/docs/deployment/on-premises-design/cloud-foundry/cloud-foundry-deploy-pad.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,15 @@ To deploy your app to Cloud Foundry, perform the following steps:
3737

3838
4. Add the following content to the file:
3939

40-
```yaml
41-
applications:
42-
- name: <the name of your app>
43-
path: <the path where you saved your .zip file>
44-
memory:
45-
buildpacks:
46-
services:
47-
env:
48-
```
49-
40+
```yaml
41+
applications:
42+
- name: <the name of your app>
43+
path: <the path where you saved your .zip file>
44+
memory:
45+
buildpacks:
46+
services:
47+
env:
48+
```
49+
5050
5. Run the `cf push` command.
51-
6. Verify that the Mendix app has started successfully.
51+
6. Verify that the Mendix app has started successfully.

content/en/docs/deployment/on-premises-design/linux/linux-pad.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,9 @@ To deploy your app to Linux, perform the following steps:
5252
* For Debian/Ubuntu-based systems: `sudo apt install temurin-21-jdk -y`
5353
* For RHEL/CentOS-based systems: `sudo yum install temurin-21-jdk -y` or `sudo dnf install temurin-21-jdk -y`
5454
55-
If your application requires it, you can change the Java version on vendor as needed, for example, `openjdk-21-jdk` or `java-21-amazon-corretto`.
55+
If your application requires it, you can change the Java version on vendor as needed, for example, `openjdk-21-jdk` or `java-21-amazon-corretto`.
5656
57-
{{% alert color="info" %}}
58-
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.
59-
{{% /alert %}}
57+
{{% alert color="info" %}} 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 %}}
6058
6159
4. Verify that Java is correctly installed by running the following command: `java -version`.
6260
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.

0 commit comments

Comments
 (0)