mendix / docs

Mendix documentation repository
https://docs.mendix.com
Creative Commons Attribution 4.0 International
137 stars 704 forks source link

[Auto] Lint docs #7972

Closed github-actions[bot] closed 3 days ago

github-actions[bot] commented 5 days ago

markdownlint-cli2 v0.13.0 (markdownlint v0.34.0) Finding: content/en/docs/*/.md Linting: 3467 file(s) Summary: 34 error(s) content/en/docs/apidocs-mxsdk/apidocs/extensibility-api/create-menu-extension.md:26:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 3; Style: 1/1/1] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:94:1 MD029/ol-prefix Ordered list item prefix [Expected: 21; Actual: 22; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:95:1 MD029/ol-prefix Ordered list item prefix [Expected: 22; Actual: 23; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:96:1 MD029/ol-prefix Ordered list item prefix [Expected: 23; Actual: 24; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:103:1 MD029/ol-prefix Ordered list item prefix [Expected: 24; Actual: 25; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:104:1 MD029/ol-prefix Ordered list item prefix [Expected: 25; Actual: 26; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:105:1 MD029/ol-prefix Ordered list item prefix [Expected: 26; Actual: 27; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:109:1 MD029/ol-prefix Ordered list item prefix [Expected: 27; Actual: 28; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:110:1 MD029/ol-prefix Ordered list item prefix [Expected: 28; Actual: 29; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:111:1 MD029/ol-prefix Ordered list item prefix [Expected: 29; Actual: 30; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:115:1 MD029/ol-prefix Ordered list item prefix [Expected: 30; Actual: 31; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:119:1 MD029/ol-prefix Ordered list item prefix [Expected: 31; Actual: 32; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:120:1 MD029/ol-prefix Ordered list item prefix [Expected: 32; Actual: 33; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:121:1 MD029/ol-prefix Ordered list item prefix [Expected: 33; Actual: 34; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:126:1 MD029/ol-prefix Ordered list item prefix [Expected: 34; Actual: 35; Style: 1/2/3] content/en/docs/appstore/use-content/modules/aws/aws-textract.md:127:1 MD029/ol-prefix Ordered list item prefix [Expected: 35; Actual: 36; Style: 1/2/3] content/en/docs/appstore/use-content/modules/genai/genai-commons.md:50 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h4; Actual: h5] content/en/docs/appstore/use-content/modules/genai/genai-commons.md:392 MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h5; Actual: h6] content/en/docs/community-tools/mendix-community.md:221:1 MD029/ol-prefix Ordered list item prefix [Expected: 4; Actual: 5; Style: 1/2/3] content/en/docs/community-tools/mendix-community.md:334:1 MD029/ol-prefix Ordered list item prefix [Expected: 4; Actual: 5; Style: 1/2/3] content/en/docs/developerportal/deploy/private-cloud/private-cloud-cluster/private-cloud-storage-plans.md:459 MD046/code-block-style Code block style [Expected: fenced; Actual: indented] content/en/docs/developerportal/deploy/private-cloud/private-cloud-cluster/private-cloud-storage-plans.md:485:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 4; Style: 1/2/3] content/en/docs/developerportal/deploy/private-cloud/private-cloud-cluster/private-cloud-storage-plans.md:487:1 MD029/ol-prefix Ordered list item prefix [Expected: 2; Actual: 5; Style: 1/2/3] content/en/docs/developerportal/deploy/private-cloud/private-cloud-cluster/private-cloud-storage-plans.md:676 MD046/code-block-style Code block style [Expected: fenced; Actual: indented] content/en/docs/developerportal/deploy/private-cloud/private-cloud-cluster/private-cloud-storage-plans.md:720:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 4; Style: 1/2/3] content/en/docs/developerportal/deploy/private-cloud/private-cloud-cluster/private-cloud-storage-plans.md:722:1 MD029/ol-prefix Ordered list item prefix [Expected: 2; Actual: 5; Style: 1/2/3] content/en/docs/developerportal/deploy/private-cloud/private-cloud-cluster/private-cloud-storage-plans.md:728:1 MD029/ol-prefix Ordered list item prefix [Expected: 3; Actual: 6; Style: 1/2/3] content/en/docs/developerportal/deploy/private-cloud/private-cloud-cluster/private-cloud-storage-plans.md:1712:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 4; Style: 1/1/1] content/en/docs/developerportal/deploy/private-cloud/private-cloud-cluster/private-cloud-storage-plans.md:2283:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 4; Style: 1/2/3] content/en/docs/developerportal/deploy/private-cloud/private-cloud-cluster/private-cloud-storage-plans.md:2292:1 MD029/ol-prefix Ordered list item prefix [Expected: 2; Actual: 5; Style: 1/2/3] content/en/docs/howto/integration/use-a-client-certificate.md:84:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 6; Style: 1/1/1] content/en/docs/howto8/integration/use-a-client-certificate.md:81:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 6; Style: 1/1/1] content/en/docs/howto9/integration/use-a-client-certificate.md:80:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 6; Style: 1/1/1] content/en/docs/releasenotes/developer-portal/_index.md:43 MD024/no-duplicate-heading Multiple headings with the same content [Context: "### Improvements"]

MarkvanMents commented 5 days ago

Please can you review the issues above and indicate they are done by checking the file in the list below:

katarzyna-koltun-mx commented 4 days ago

@MarkvanMents not sure how to deal with the following - the error is because of an alert above the step, but if I indent the alert, its formatting will break in the output. Other than that, all corrected.

content/en/docs/howto8/integration/use-a-client-certificate.md:81:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 6; Style: 1/1/1] content/en/docs/howto9/integration/use-a-client-certificate.md:80:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 6; Style: 1/1/1]

MarkvanMents commented 3 days ago

@MarkvanMents not sure how to deal with the following - the error is because of an alert above the step, but if I indent the alert, its formatting will break in the output. Other than that, all corrected.

content/en/docs/howto8/integration/use-a-client-certificate.md:81:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 6; Style: 1/1/1] content/en/docs/howto9/integration/use-a-client-certificate.md:80:1 MD029/ol-prefix Ordered list item prefix [Expected: 1; Actual: 6; Style: 1/1/1]

Hi @katarzyna-koltun-mx There were a couple of missing spaces which meant that it didn't see the beginning of the list. Neither did Hugo and the section looks like this in production: image

I've added the spaces in this commit and now it looks OK and the linter is happy: https://github.com/mendix/docs/pull/7972/commits/96d6c305b22c0fbac8ab58f145d6470526ee8538