From 696ecb05d8796540dc21d62dce930c4a2c2d8246 Mon Sep 17 00:00:00 2001
From: Pavel Boldyrev <627562+bpg@users.noreply.github.com>
Date: Fri, 17 Mar 2023 21:31:19 -0400
Subject: [PATCH] chore(docs): Minor documentation Improvements (#266)

* add port to endpoint + examples to the root doc

* clarify disk `interface` values
---
 docs/index.md                            |  8 +++++---
 docs/resources/virtual_environment_vm.md | 10 ++++++----
 2 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/docs/index.md b/docs/index.md
index 2fd46219..fd378189 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -18,7 +18,7 @@ Use the navigation to the left to read about the available resources.
 ```terraform
 provider "proxmox" {
   virtual_environment {
-    endpoint = "https://10.0.0.2"
+    endpoint = "https://10.0.0.2:8006/"
     username = "root@pam"
     password = "the-password-set-during-installation-of-proxmox-ve"
     insecure = true
@@ -83,7 +83,8 @@ Proxmox `provider` block:
 - `virtual_environment` - (Optional) The Proxmox Virtual Environment
   configuration.
   - `endpoint` - (Required) The endpoint for the Proxmox Virtual Environment
-    API (can also be sourced from `PROXMOX_VE_ENDPOINT`).
+    API (can also be sourced from `PROXMOX_VE_ENDPOINT`). Usually this is
+    `https://<your-cluster-endpoint>:8006/`.
   - `insecure` - (Optional) Whether to skip the TLS verification step (can
     also be sourced from `PROXMOX_VE_INSECURE`). If omitted, defaults
     to `false`.
@@ -92,4 +93,5 @@ Proxmox `provider` block:
   - `password` - (Required) The password for the Proxmox Virtual Environment
     API (can also be sourced from `PROXMOX_VE_PASSWORD`).
   - `username` - (Required) The username and realm for the Proxmox Virtual
-    Environment API (can also be sourced from `PROXMOX_VE_USERNAME`).
+    Environment API (can also be sourced from `PROXMOX_VE_USERNAME`). For 
+    example, `root@pam`.
diff --git a/docs/resources/virtual_environment_vm.md b/docs/resources/virtual_environment_vm.md
index f14beb55..5c79d43e 100644
--- a/docs/resources/virtual_environment_vm.md
+++ b/docs/resources/virtual_environment_vm.md
@@ -205,8 +205,8 @@ output "ubuntu_vm_public_key" {
         - `phenom` - AMD Phenom (2010).
         - `qemu32`/`qemu64` - QEMU Virtual CPU version 2.5+ (32 & 64 bit
           variants).
-        - `custom-<model>` - Custom CPU model. All `custom-<model>` values should be
-          defined in `/etc/pve/virtual-guest/cpu-models.conf` file.
+        - `custom-<model>` - Custom CPU model. All `custom-<model>` values
+          should be defined in `/etc/pve/virtual-guest/cpu-models.conf` file.
     - `units` - (Optional) The CPU units (defaults to `1024`).
 - `description` - (Optional) The description.
 - `disk` - (Optional) A disk (multiple blocks supported).
@@ -222,8 +222,10 @@ output "ubuntu_vm_public_key" {
     - `file_id` - (Optional) The file ID for a disk image (experimental -
       might cause high CPU utilization during import, especially with large
       disk images).
-    - `interface` - (Required) The disk interface for Proxmox, currently scsi,
-      sata and virtio are supported.
+    - `interface` - (Required) The disk interface for Proxmox, currently `scsi`,
+      `sata` and `virtio` interfaces are supported. Append the disk index at
+      the end, for example, `virtio0` for the first virtio disk, `virtio1` for
+      the second, etc.
     - `iothread` - (Optional) Whether to use iothreads for this disk (defaults
       to `false`).
     - `size` - (Optional) The disk size in gigabytes (defaults to `8`).