Skip to content

Commit 6956186

Browse files
Run markdownlint-cli2 on docs to find (and correct) linting errors.
1 parent 3403af0 commit 6956186

34 files changed

Lines changed: 291 additions & 292 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: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ To run your app locally, perform the following steps:
5959
The Mendix admin port can be used to fetch metrics and other runtime data from an app. It requires a password for security reasons.
6060
{{% /alert %}}
6161

62-
3. Run the app by using one of the following commands:
62+
1. Run the app by using one of the following commands:
6363

6464
* For Windows, run the command `<your folder location>\bin\start.bat`
6565
* For Windows Powershell, run the command `<your folder location>\bin\start.ps1`
@@ -69,7 +69,6 @@ The Mendix admin port can be used to fetch metrics and other runtime data from a
6969
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.
7070
{{% /alert %}}
7171

72-
7372
### Deploying to a Self-Hosted Environment
7473

7574
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: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,5 +47,5 @@ applications:
4747
env:
4848
```
4949
50-
5. Run the `cf push` command.
51-
6. Verify that the Mendix app has started successfully.
50+
1. Run the `cf push` command.
51+
2. Verify that the Mendix app has started successfully.

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ If your application requires it, you can change the Java version on vendor as ne
5858
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.
5959
{{% /alert %}}
6060
61-
4. Verify that Java is correctly installed by running the following command: `java -version`.
62-
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.
61+
1. Verify that Java is correctly installed by running the following command: `java -version`.
62+
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.
6363
6464
* 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`
6565
@@ -77,7 +77,7 @@ Your Portable App Distribution only requires a Java Runtime Environment (JRE) to
7777
7878
* From a public URL using `wget`: `wget https://<path to your file>.zip`
7979
80-
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.
80+
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.
8181
8282
* 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`
8383
@@ -95,8 +95,8 @@ Your Portable App Distribution only requires a Java Runtime Environment (JRE) to
9595
9696
You can also retrieve the files using `wget`.
9797
98-
7. Extract the .zip file by running the following command: `unzip <your app>.zip -d <your desired directory>`.
99-
8. Navigate into the extracted directory and execute the start script by running the following command:
98+
4. Extract the .zip file by running the following command: `unzip <your app>.zip -d <your desired directory>`.
99+
5. Navigate into the extracted directory and execute the start script by running the following command:
100100
101101
```text
102102
cd your-desired-directory
@@ -105,7 +105,7 @@ Your Portable App Distribution only requires a Java Runtime Environment (JRE) to
105105
106106
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.
107107
108-
9. Verify that the application is running by opening the following URL in your browser: `http://<public IP of your Linux instance>:8080`.
108+
6. Verify that the application is running by opening the following URL in your browser: `http://<public IP of your Linux instance>:8080`.
109109
110110
`8080` is the default port. If your application is configured to run on a different port, adjust accordingly.
111111

0 commit comments

Comments
 (0)