Merge pull request #12 from smutel/ImproveDocs

Improve docs

README.md

@@ -37,6 +37,13 @@ $ make build
 
 ## Installing the provider
 
+---
+**NOTE**
+
+Before changing the version of the provider, please remove the temporary folder `.terraform` and `~/.terraform.d`.
+
+---
+
 ### Automatic installation from Terraform 0.13
 
 ```hcl
@@ -50,17 +57,22 @@ terraform {
 }
 ```
 
-### Manual installation
+### Manual installation
+
+You can install the provider manually in your global terraform provider folder.
+
+```sh
+$ export NETBOX_PROVIDER_VERSION=1.0.0
+$ mkdir -p ~/.terraform.d/plugins/registry.terraform.io/smutel/netbox/${NETBOX_PROVIDER_VERSION}/linux_amd64
+$ cp terraform-provider-netbox_v${NETBOX_PROVIDER_VERSION} ~/.terraform.d/plugins/registry.terraform.io/smutel/netbox/${NETBOX_PROVIDER_VERSION}/linux_amd64/terraform-provider-netbox_v${NETBOX_PROVIDER_VERSION}
+```
 
-You can install the provider manually in your global terraform provider folder 
-or you can also use the makefile to install the provider in your local provider folder:
+### Manual installation (to test the compiled version = version 0.0.1)
 
 ```bash
 $ make localinstall
-==> Creating folder terraform.d/plugins/linux_amd64
-mkdir -p ~/.terraform.d/plugins/linux_amd64
+==> Creating folder ~/.terraform.d/plugins/registry.terraform.io/smutel/netbox/0.0.1/linux_amd64
 ==> Installing provider in this folder
-cp terraform-provider-netbox ~/.terraform.d/plugins/linux_amd64
 ```
 
 ## Using the provider

docs/index.md

@@ -4,7 +4,8 @@ Terraform provider for [Netbox.](https://netbox.readthedocs.io/en/stable/)
 
 ## Compatibility with Netbox
 
-Version 0.x.x => Netbox 2.8.x
+Version 0.x.y => Netbox 2.8  
+Version 1.x.y => Netbox 2.9  
 
 ## Example Usage
 

docs/resources/ipam_ip_addresses.md

@@ -30,6 +30,7 @@ The following arguments are supported:
 * ``status`` - (Optional) The status among container, active, reserved, deprecated (active by default).
 * ``tenant_id`` - (Optional) ID of the tenant where this object is attached.
 * ``vrf_id`` - (Optional) The ID of the vrf attached to this object.
+
 The ``tag`` block supports:
 * ``name`` - (Required) Name of the existing tag to associate with this resource.
 * ``slug`` - (Required) Slug of the existing tag to associate with this resource.

docs/resources/ipam_prefix.md

@@ -32,6 +32,7 @@ The following arguments are supported:
 * ``tenant_id`` - (Optional) ID of the tenant where this object is attached.
 * ``vlan_id`` - (Optional) ID of the vlan where this object is attached.
 * ``vrf_id`` - (Optional) The ID of the vrf attached to this object.
+
 The ``tag`` block supports:
 * ``name`` - (Required) Name of the existing tag to associate with this resource.
 * ``slug`` - (Required) Slug of the existing tag to associate with this resource.

docs/resources/ipam_vlan.md

@@ -32,6 +32,7 @@ The following arguments are supported:
 * ``status`` - (Optional) The status among container, active, reserved, deprecated (active by default).
 * ``tenant_id`` - (Optional) ID of the tenant where this object is attached.
 * ``vlan_id`` - (Required) The ID of this vlan (vlan tag).
+
 The ``tag`` block supports:
 * ``name`` - (Required) Name of the existing tag to associate with this resource.
 * ``slug`` - (Required) Slug of the existing tag to associate with this resource.

docs/resources/tenancy_tenant.md

@@ -27,6 +27,7 @@ The following arguments are supported:
 * ``tenant_group_id`` - (Optional) ID of the group where this object is located.
 * ``name`` - (Required) The name for this object.
 * ``slug`` - (Required) The slug for this object.
+
 The ``tag`` block supports:
 * ``name`` - (Required) Name of the existing tag to associate with this resource.
 * ``slug`` - (Required) Slug of the existing tag to associate with this resource.