Merge pull request #1323 from Tinyblargon/#1287

Fix broken link and fromat markdown

Author: Tinyblargon

docs/guides/developer.md

@@ -1,17 +1,19 @@
-# Overview
+# Developer Guide
+
 This guide aims to help developers who are new to this project so more people
 can help investigate any problems they may run into.
 
-# Compilation
+## Compilation
+
 Instructions on how to compile the provider, and cause terraform to use that
 newly compiled executable, see the
-[installation guide](https://github.com/Telmate/terraform-provider-proxmox/blob/new_developer_setup/docs/guides/installation.md#compile-the-executables-with-go).
+[installation guide](./installation.md#compile-the-executables-with-go).
 
 You may want to specify the namespace and specific path to the plugin to make
 sure terraform is getting the correct executable. If you are using the default
 example domain as your namespace, it'd look like this:
 
-```
+```hcl
 terraform {
   required_providers {
     proxmox = {
@@ -26,15 +28,15 @@ terraform {
 
 After changing that, you'll need to update and upgrade your terraform files:
 
-```
+```bash
 terraform get -update
 terraform init -upgrade
 ```
 
 And finally, you'll want to check to make sure you only see the v1.0.0 entry
 when you look at the providers that terraform reports about.
 
-```
+```bash
 terraform version
 ```
 
@@ -44,11 +46,13 @@ repeatedly, you'll need to know that the hash of the executable is stored in
 provisioner or just remove the file entirely before running the usual
 terraform get/init commands listed above.
 
-# Debugging
+## Debugging
+
 Instructions on how to enable debug logging are located
 [here](https://registry.terraform.io/providers/Telmate/proxmox/latest/docs#pm_log_enable).
 
-# Going deeper
+## Going deeper
+
 Much of the code for the provider is not actually in this repo. It's in a
 library repo called proxmox-api-go. When you build the provider, the build
 system will check out a specific commit of that repo to get the code.
@@ -58,7 +62,7 @@ This is controlled by [go.sum](https://github.com/Telmate/terraform-provider-pro
 The convention seems to be `Version-Date-CommitHash`. As an example, the
 following was commit `31826f2fdc39` that was checked in on 2023-12-07:
 
-```
+```go.mod
 github.com/Telmate/proxmox-api-go v0.0.0-20231207182448-31826f2fdc39 h1:0MvktdAFWIcc9F4IwQls2Em1F9z2LUZR1fSVm1PkKfM=
 github.com/Telmate/proxmox-api-go v0.0.0-20231207182448-31826f2fdc39/go.mod h1:xOwyTd8uC2IiYfmjwCVU2fTTVToFCm9yxJzn4cd7rPw=
 ```
@@ -68,7 +72,7 @@ statements), you'll want to tell the Go compiler to look in a local directory
 for your modified library instead of getting it from github. To do this, you
 can add the following line to the end of go.mod:
 
-```
+```go.mod
 replace "github.com/Telmate/proxmox-api-go" => "../proxmox-api-go"
 ```
 

docs/guides/installation.md

@@ -1,4 +1,8 @@
-# Automatic Registry Installation
+# Installation
+
+This document describes how to install the Terraform provider.
+
+## Automatic Registry Installation
 
 To install this provider, copy and paste this code into your Terraform configuration (include a version tag).
 
@@ -19,23 +23,23 @@ provider "proxmox" {
 
 Then, run
 
-```shell
-$ terraform init
+```bash
+terraform init
 ```
 
-# Manual Build & Install
+## Manual Build & Install
 
 When developing this provider, it's useful to bootstrap a development as quick as possible. You can use
 the [Proxmox VE vagrant VM](https://github.com/rgl/proxmox-ve) project for instance. Check out
 the [examples](../../examples/vagrant_example.tf) for a `main.tf` to use.
 
-## How to get terraform to recognize third party provider
+### How to get terraform to recognize third party provider
 
 Third-party plugins can be manually installed into the user plugins directory, located
 at `%APPDATA%\terraform.d\plugins` on Windows and `~/.terraform.d/plugins` on other systems. Plugins come with
 executables that have to be placed in the plugin directory.
 
-## Compile the executables with Go
+### Compile the executables with Go
 
 First, clone this repo and cd into the repo's root.
 
@@ -49,48 +53,45 @@ you want an automated way to do it, look at go.yml in the root of this repo.
 
 Then to compile the provider:
 
-```shell
+```bash
 make
 ```
 
 The executable will be in the `./bin` directory.
 
-## Copy executables to plugin directory (Terraform >=0.13)
+### Copy executables to plugin directory (Terraform >=0.13)
 
 As of Terraform v0.13, locally-installed, third-party plugins
-must [conform to a new filesystem layout](https://github.com/hashicorp/terraform/blob/guide-v0.13-beta/draft-upgrade-guide.md#new-filesystem-layout-for-local-copies-of-providers)
-.
+must [conform to a new filesystem layout](https://github.com/hashicorp/terraform/blob/guide-v0.13-beta/draft-upgrade-guide.md#new-filesystem-layout-for-local-copies-of-providers).
 
 > Terraform assumes that a provider without an explicit source address belongs to the "hashicorp" namespace on registry.terraform.io, which is not true for your in-house provider. Instead, you can use any domain name under your control to establish a virtual source registry to serve as a separate namespace for your local use.
 
 Use the format: [host.domain]/telmate/proxmox/[version]/[arch].
 
 In our case, we will use `registry.example.com` as our virtual source registry in the following examples.
 
-```shell
+```bash
 # Uncomment for macOS
 # PLUGIN_ARCH=darwin_amd64
 
-$ PLUGIN_ARCH=linux_amd64
+PLUGIN_ARCH=linux_amd64
 
 # Create the directory holding the newly built Terraform plugins
-$ mkdir -p ~/.terraform.d/plugins/registry.example.com/telmate/proxmox/1.0.0/${PLUGIN_ARCH}
+mkdir -p ~/.terraform.d/plugins/registry.example.com/telmate/proxmox/1.0.0/${PLUGIN_ARCH}
 ```
 
 Then, copy the executables to the directory you just created. You could also use the `make local-dev-install` target.
-it's important to note that you aren't required to use a semver, and if you don't, then the path must be altered
-accordingly.
+It's important to note that you aren't required to use a semver, and if you don't, then the path must be altered accordingly.
 
-```shell
-$ cp bin/terraform-provider-proxmox ~/.terraform.d/plugins/registry.example.com/telmate/proxmox/1.0.0/${PLUGIN_ARCH}/
-$ ls -al ~/.terraform.d/plugins/registry.example.com/telmate/proxmox/1.0.0/${PLUGIN_ARCH}/
+```bash
+cp bin/terraform-provider-proxmox ~/.terraform.d/plugins/registry.example.com/telmate/proxmox/1.0.0/${PLUGIN_ARCH}/
+ls -al ~/.terraform.d/plugins/registry.example.com/telmate/proxmox/1.0.0/${PLUGIN_ARCH}/
 -rwxrwxr-x 1 user user 20352759 Feb 22 21:51 terraform-provider-proxmox_v1.0.0*
 ```
 
 Add the source to your project's `main.tf` like so:
 
-```
-$ cat main.tf
+```hcl
 terraform {
   required_providers {
     proxmox = {
@@ -100,16 +101,15 @@ terraform {
   }
   required_version = ">= 0.14"
 }
-
-[...]
+# omitted for brevity
 ```
 
 ## Copy executables to plugin directory (Terraform <0.13)
 
 You need to copy these executables to the ~/.terraform.d directory which will also need to have a `plugins` directory
 created.
 
-```shell
+```bash
 mkdir -p ~/.terraform.d/plugins
 cp -f bin/terraform-provider-proxmox ~/.terraform.d/plugins
 ```
@@ -118,8 +118,8 @@ cp -f bin/terraform-provider-proxmox ~/.terraform.d/plugins
 
 Initialize Terraform so that it installs the new plugins:
 
-```
-$ terraform init
+```bash
+terraform init
 ```
 
 You should see the following marking the successful plugin installation: