chore(docs): Update README.md (#442)

* chore(docs): update gems

* chore(docs): update README.md

README.md

@@ -10,33 +10,28 @@
 
 A Terraform Provider which adds support for Proxmox solutions.
 
-This repository is a fork of <https://github.com/danitso/terraform-provider-proxmox>
+This repository is a fork
-with several critical fixes to unblock VM deployment in Proxmox v7.0, and several
+of <https://github.com/danitso/terraform-provider-proxmox>
-other enhancements.
+which is no longer maintained.
 
-## Compatibility Matrix
+## Compatibility promise
 
-| Proxmox version | Provider version |
+This provider is compatible with the latest version of Proxmox VE (currently
-| --------------- | ---------------- |
+8.0). While it may work with older 7.x versions, it is not guaranteed to do so.
-| 6.x             | \<= 0.4.4        |
+
-| 7.x             | \>= 0.4.5        |
+While provider is on version 0.x, it is not guaranteed to be backwards
+compatible with all previous minor versions. However, we will try to keep the
+backwards compatibility between provider versions as much as possible.
 
 ## Requirements
 
 - [Terraform](https://www.terraform.io/downloads.html) 1.2+
 - [Go](https://golang.org/doc/install) 1.20+ (to build the provider plugin)
-- [GoReleaser](https://goreleaser.com/install/) v1.15+ (to build the provider plugin)
-
-## Table of Contents
-
-- [Building the provider](#building-the-provider)
-- [Using the provider](#using-the-provider)
-- [Testing the provider](#testing-the-provider)
-- [Known issues](#known-issues)
 
 ## Building the provider
 
-- Clone the repository to `$GOPATH/src/github.com/bpg/terraform-provider-proxmox`:
+- Clone the repository
+  to `$GOPATH/src/github.com/bpg/terraform-provider-proxmox`:
 
   ```sh
   mkdir -p "${GOPATH}/src/github.com/bpg"
@@ -53,7 +48,8 @@ other enhancements.
 
 ## Using the provider
 
-You can find the latest release and its documentation in the [Terraform Registry](https://registry.terraform.io/providers/bpg/proxmox/latest).
+You can find the latest release and its documentation in
+the [Terraform Registry](https://registry.terraform.io/providers/bpg/proxmox/latest).
 
 ## Testing the provider
 
@@ -68,8 +64,8 @@ Tests are limited to regression tests, ensuring backwards compatibility.
 ## Deploying the example resources
 
 There are number of TF examples in the `examples` directory, which can be used
-to deploy a Container, VM, or other Proxmox resources on your test Proxmox cluster.
+to deploy a Container, VM, or other Proxmox resources on your test Proxmox
-The following assumptions are made about the test Proxmox cluster:
+cluster. The following assumptions are made about the test Proxmox cluster:
 
 - It has one node named `pve`
 - The node has local storages named `local` and `local-lvm`
@@ -84,6 +80,15 @@ virtual_environment_endpoint = "https://<your-cluster-endpoint>:8006/"
 
 Then run `make example` to deploy the example resources.
 
+## Future work
+
+The provider is using the
+legacy [Terraform SDKv2](https://developer.hashicorp.com/terraform/plugin/sdkv2),
+which is considered legacy and is in maintenance mode.
+The work has started to migrate the provider to the
+new [Terraform Plugin Framework](https://www.terraform.io/docs/extend/plugin-sdk.html),
+with aim to release it as a new major version **1.0**.
+
 ## Known issues
 
 ### Disk images cannot be imported by non-PAM accounts

docs/Gemfile.lock

@@ -1,12 +1,12 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.0.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-    addressable (2.8.1)
+    addressable (2.8.4)
       public_suffix (>= 2.0.2, < 6.0)
     coffee-script (2.4.1)
       coffee-script-source
@@ -15,8 +15,8 @@ GEM
     colorator (1.1.0)
     commonmarker (0.23.9)
     concurrent-ruby (1.2.2)
-    dnsruby (1.61.9)
+    dnsruby (1.70.0)
-      simpleidn (~> 0.1)
+      simpleidn (~> 0.2.1)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
@@ -25,7 +25,7 @@ GEM
     eventmachine (1.2.7)
     eventmachine (1.2.7-x64-mingw32)
     execjs (2.8.1)
-    faraday (2.7.4)
+    faraday (2.7.10)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.2)
@@ -88,7 +88,7 @@ GEM
       activesupport (>= 2)
       nokogiri (>= 1.4)
     http_parser.rb (0.8.0)
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     jekyll (3.9.3)
       addressable (~> 2.4)
@@ -198,7 +198,7 @@ GEM
       gemoji (~> 3.0)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    just-the-docs (0.4.1)
+    just-the-docs (0.5.4)
       jekyll (>= 3.8.5)
       jekyll-seo-tag (>= 2.0)
       rake (>= 12.3.1)
@@ -211,14 +211,14 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     mercenary (0.3.6)
-    mini_portile2 (2.8.1)
+    mini_portile2 (2.8.4)
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.18.0)
+    minitest (5.19.0)
-    nokogiri (1.14.3)
+    nokogiri (1.15.3)
-      mini_portile2 (~> 2.8.0)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
     octokit (4.25.1)
       faraday (>= 1, < 3)
@@ -226,7 +226,7 @@ GEM
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (4.0.7)
-    racc (1.6.2)
+    racc (1.7.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
@@ -252,7 +252,7 @@ GEM
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    tzinfo-data (1.2022.7)
+    tzinfo-data (1.2023.3)
       tzinfo (>= 1.0.0)
     unf (0.1.4)
       unf_ext
@@ -277,4 +277,4 @@ DEPENDENCIES
   webrick (~> 1.7)
 
 BUNDLED WITH
-   2.4.13
+   2.4.17