Fix markdown lint issues in docs and Makefile

matifali · matifali · commit 3b396d333142 · 2024-12-11T16:46:29.000Z
- Quote glob patterns in Makefile to handle whitespace.
- Add alt text to images for better accessibility.
- Specify language for code blocks for syntax highlighting.
diff --git a/Makefile b/Makefile
@@ -499,7 +499,7 @@ lint/helm:
 lint/markdown:
 	cd site
 	../scripts/pnpm_install.sh
-	pnpm exec markdownlint-cli2 --fix ../docs/**/*.md
+	pnpm exec markdownlint-cli2 --fix "../docs/**/*.md"
 .PHONY: lint/markdown
 
 # All files generated by the database should be added here, and this can be used
diff --git a/docs/install/cloud/azure-vm.md b/docs/install/cloud/azure-vm.md
@@ -12,7 +12,7 @@ This guide assumes you have full administrator privileges on Azure.
 From the Azure Portal, navigate to the Virtual Machines Dashboard. Click Create,
 and select creating a new Azure Virtual machine .
 
-<img src="../../images/platforms/azure/azure1.jpg">
+<img src="../../images/platforms/azure/azure1.jpg" alt="Azure VM creation page">
 
 This will bring you to the `Create a virtual machine` page. Select the
 subscription group of your choice, or create one if necessary.
@@ -22,26 +22,26 @@ of your choice. Change the region to something more appropriate for your current
 location. For this tutorial, we will use the base selection of the Ubuntu Gen2
 Image and keep the rest of the base settings for this image the same.
 
-<img src="../../images/platforms/azure/azure2.png">
+<img src="../../images/platforms/azure/azure2.png" alt="Azure VM instance details">
 
-<img src="../../images/platforms/azure/azure3.png">
+<img src="../../images/platforms/azure/azure3.png" alt="Azure VM size selection">
 
 Up next, under `Inbound port rules` modify the Select `inbound ports` to also
 take in `HTTPS` and `HTTP`.
 
-<img src="../../images/platforms/azure/azure4.png">
+<img src="../../images/platforms/azure/azure4.png" alt="Azure VM inbound port rules">
 
 The set up for the image is complete at this stage. Click `Review and Create` -
 review the information and click `Create`. A popup will appear asking you to
 download the key pair for the server. Click
 `Download private key and create resource` and place it into a folder of your
 choice on your local system.
 
-<img src="../../images/platforms/azure/azure5.png">
+<img src="../../images/platforms/azure/azure5.png" alt="Azure VM key pair generation">
 
 Click `Return to create a virtual machine`. Your VM will start up!
 
-<img src="../../images/platforms/azure/azure6.png">
+<img src="../../images/platforms/azure/azure6.png" alt="Azure VM deployment complete">
 
 Click `Go to resource` in the virtual machine and copy the public IP address.
 You will need it to SSH into the virtual machine via your local machine.
@@ -100,12 +100,12 @@ First, run `coder template init` to create your first template. You’ll be give
 a list of possible templates to use. This tutorial will show you how to set up
 your Coder instance to create a Linux based machine on Azure.
 
-<img src="../../images/platforms/azure/azure9.png">
+<img src="../../images/platforms/azure/azure9.png" alt="Coder CLI template init">
 
 Press `enter` to select `Develop in Linux on Azure` template. This will return
 the following:
 
-<img src="../../images/platforms/azure/azure10.png">
+<img src="../../images/platforms/azure/azure10.png" alt="Coder CLI template init">
 
 To get started using the Azure template, install the Azure CLI by following the
 instructions
diff --git a/docs/user-guides/workspace-access/emacs-tramp.md b/docs/user-guides/workspace-access/emacs-tramp.md
@@ -7,7 +7,7 @@ editing operations on a remote server.
 
 To connect to your workspace first run:
 
-```
+```shell
 coder config-ssh
 ```
 
diff --git a/docs/user-guides/workspace-access/jetbrains.md b/docs/user-guides/workspace-access/jetbrains.md
@@ -378,14 +378,18 @@ Fleet can connect to a Coder workspace by following these steps.
 
 1. [Install Fleet](https://www.jetbrains.com/fleet/download)
 2. Install Coder CLI
+
    ```shell
    curl -L https://coder.com/install.sh | sh
    ```
+
 3. Login and configure Coder SSH.
+
    ```shell
    coder login coder.example.com
    coder config-ssh
    ```
+
 4. Connect via SSH with the Host set to `coder.workspace-name`
    ![Fleet Connect to Coder](../../images/fleet/ssh-connect-to-coder.png)
 
diff --git a/docs/user-guides/workspace-access/port-forwarding.md b/docs/user-guides/workspace-access/port-forwarding.md
@@ -141,7 +141,7 @@ protocol configuration for each shared port individually.
 You can also access any port on the workspace and can configure the port
 protocol manually by appending a `s` to the port in the URL.
 
-```
+```console
 # Uses HTTP
 https://33295--agent--workspace--user--apps.example.com/
 # Uses HTTPS
diff --git a/examples/examples.gen.json b/examples/examples.gen.json
@@ -1,4 +1,3 @@
-// Code generated by examplegen. DO NOT EDIT.
 [
 	{
 		"id": "aws-devcontainer",

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-// Code generated by examplegen. DO NOT EDIT.`
`2`	`1`	`[`
`3`	`2`	`{`
`4`	`3`	`"id": "aws-devcontainer",`