From c14b7ebe1d524783badf299cb4e146168011729e Mon Sep 17 00:00:00 2001 From: Pavel Boldyrev <627562+bpg@users.noreply.github.com> Date: Tue, 9 Apr 2024 22:07:22 -0400 Subject: [PATCH] chore(docs): minor documentation updates (#1200) Signed-off-by: Pavel Boldyrev <627562+bpg@users.noreply.github.com> --- .github/PULL_REQUEST_TEMPLATE.md | 2 +- README.md | 1 + docs/resources/virtual_environment_file.md | 10 +++++----- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b43280da..2ebc088f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,7 +4,7 @@ Please mark the following items with an [x] if they apply to your PR. Leave the [ ] if they are not applicable, or if you have not completed the item. ---> - [ ] I have added / updated documentation in `/docs` for any user-facing features or additions. -- [ ] I have added / updated templates in `/example` for any new or updated resources / data sources. +- [ ] I have added / updated acceptance tests in `/fwprovider/tests` for any new or updated resources / data sources. - [ ] I have ran `make example` to verify that the change works as expected. **Note:** The resource with this content type uses SSH access to the node. You might need to configure the [`ssh` option in the `provider` section](../index.md#node-ip-address-used-for-ssh-connection). +-> The resource with this content type uses SSH access to the node. You might need to configure the [`ssh` option in the `provider` section](../index.md#node-ip-address-used-for-ssh-connection). ```terraform resource "proxmox_virtual_environment_file" "backup" { @@ -29,7 +29,7 @@ resource "proxmox_virtual_environment_file" "backup" { ### Images -**Consider using `proxmox_virtual_environment_download_file` resource instead. Using this resource for images is less efficient (requires to transfer uploaded image to node) though still supported.** +-> Consider using `proxmox_virtual_environment_download_file` resource instead. Using this resource for images is less efficient (requires to transfer uploaded image to node) though still supported. ```terraform resource "proxmox_virtual_environment_file" "ubuntu_container_template" { @@ -45,9 +45,9 @@ resource "proxmox_virtual_environment_file" "ubuntu_container_template" { ### Snippets --> **Note:** Snippets are not enabled by default in new Proxmox installations. You need to enable them in the 'Datacenter>Storage' section of the proxmox interface before first using this resource. +-> Snippets are not enabled by default in new Proxmox installations. You need to enable them in the 'Datacenter>Storage' section of the proxmox interface before first using this resource. --> **Note:** The resource with this content type uses SSH access to the node. You might need to configure the [`ssh` option in the `provider` section](../index.md#node-ip-address-used-for-ssh-connection). +-> The resource with this content type uses SSH access to the node. You might need to configure the [`ssh` option in the `provider` section](../index.md#node-ip-address-used-for-ssh-connection). ```terraform resource "proxmox_virtual_environment_file" "cloud_config" { @@ -82,7 +82,7 @@ EOF ### Container Template (`vztmpl`) -**Consider using `proxmox_virtual_environment_download_file` resource instead. Using this resource for container images is less efficient (requires to transfer uploaded image to node) though still supported.** +-> Consider using `proxmox_virtual_environment_download_file` resource instead. Using this resource for container images is less efficient (requires to transfer uploaded image to node) though still supported. ```terraform resource "proxmox_virtual_environment_file" "ubuntu_container_template" {