docs: add Cloud Avenue documentation links (#39)

orange-cloudavenue · Feb 10, 2023 · 469be32 · 469be32
1 parent 4c0c63f
commit 469be32
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 7 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -12,6 +12,7 @@ The provider needs to be configured with the proper credentials before it can be
 
 Documentation regarding Data Sources and Resources can be found in the sidebar to the left.
 
+ -> Note : If you need more information about Cloud Avenue, please visit [Cloud Avenue documentation](https://wiki.cloudavenue.orange-business.com/w/index.php/Accueil).
 ## Authentication
 
 Cloud Avenue support authentication with username, password and organization.

diff --git a/docs/resources/vcda_ip.md b/docs/resources/vcda_ip.md
@@ -3,12 +3,12 @@
 page_title: "cloudavenue_vcda_ip Resource - cloudavenue"
 subcategory: ""
 description: |-
-  VCDa resource permit to declare or remove your On Premise IP address for DRaaS Service.
+  VCDa resource permit to declare or remove your On Premise IP address for DRaaS Service. -> Note: For more information, please refer to the Cloud Avenue DRaaS documentation https://wiki.cloudavenue.orange-business.com/w/index.php/DRaaS_avec_VCDA.
 ---
 
 # cloudavenue_vcda_ip (Resource)
 
-VCDa resource permit to declare or remove your On Premise IP address for DRaaS Service.
+VCDa resource permit to declare or remove your On Premise IP address for DRaaS Service. -> Note: For more information, please refer to the [Cloud Avenue DRaaS documentation](https://wiki.cloudavenue.orange-business.com/w/index.php/DRaaS_avec_VCDA).
 
 ## Example Usage
 

diff --git a/docs/resources/vdc.md b/docs/resources/vdc.md
@@ -3,12 +3,12 @@
 page_title: "cloudavenue_vdc Resource - cloudavenue"
 subcategory: ""
 description: |-
-  Provides a Cloud Avenue Organization VDC resource. This can be used to create, update and delete an Organization VDC.
+  Provides a Cloud Avenue Organization VDC resource. This can be used to create, update and delete an Organization VDC. -> Note: For more information about Organization VDC, please refer to the Cloud Avenue documentation https://wiki.cloudavenue.orange-business.com/w/index.php/Datacenter_virtuel.
 ---
 
 # cloudavenue_vdc (Resource)
 
-Provides a Cloud Avenue Organization VDC resource. This can be used to create, update and delete an Organization VDC.
+Provides a Cloud Avenue Organization VDC resource. This can be used to create, update and delete an Organization VDC. -> Note: For more information about Organization VDC, please refer to the [Cloud Avenue documentation](https://wiki.cloudavenue.orange-business.com/w/index.php/Datacenter_virtuel).
 
 ## Example Usage
 

diff --git a/internal/provider/vcda_ip_resource.go b/internal/provider/vcda_ip_resource.go
@@ -46,7 +46,8 @@ func (r *vcdaIPResource) Metadata(_ context.Context, req resource.MetadataReques
 // Schema defines the schema for the resource.
 func (r *vcdaIPResource) Schema(_ context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
-		MarkdownDescription: "VCDa resource permit to declare or remove your On Premise IP address for DRaaS Service.",
+		MarkdownDescription: "VCDa resource permit to declare or remove your On Premise IP address for DRaaS Service." +
+			" -> Note: For more information, please refer to the [Cloud Avenue DRaaS documentation](https://wiki.cloudavenue.orange-business.com/w/index.php/DRaaS_avec_VCDA).",
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{
 				Computed: true,

diff --git a/internal/provider/vdc_resource.go b/internal/provider/vdc_resource.go
@@ -70,7 +70,8 @@ func (r *vdcResource) Metadata(_ context.Context, req resource.MetadataRequest,
 // Schema defines the schema for the resource.
 func (r *vdcResource) Schema(ctx context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
 	resp.Schema = schema.Schema{
-		MarkdownDescription: "Provides a Cloud Avenue Organization VDC resource. This can be used to create, update and delete an Organization VDC.",
+		MarkdownDescription: "Provides a Cloud Avenue Organization VDC resource. This can be used to create, update and delete an Organization VDC." +
+			" -> Note: For more information about Organization VDC, please refer to the [Cloud Avenue documentation](https://wiki.cloudavenue.orange-business.com/w/index.php/Datacenter_virtuel).",
 		Attributes: map[string]schema.Attribute{
 			"timeouts": timeouts.Attributes(ctx, timeouts.Opts{
 				Create: true,
@@ -101,7 +102,7 @@ func (r *vdcResource) Schema(ctx context.Context, _ resource.SchemaRequest, resp
 			"cpu_speed_in_mhz": schema.Float64Attribute{
 				Required: true,
 				MarkdownDescription: "Specifies the clock frequency, in Mhz, for any virtual CPU that is allocated to a VM.\n" +
-					"It must be at least 1200.",
+					"It must be at least 1200.\n",
 				Validators: []validator.Float64{
 					float64validator.AtLeast(1200),
 				},

diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -12,6 +12,7 @@ The provider needs to be configured with the proper credentials before it can be
 
 Documentation regarding Data Sources and Resources can be found in the sidebar to the left.
 
+ -> Note : If you need more information about Cloud Avenue, please visit [Cloud Avenue documentation](https://wiki.cloudavenue.orange-business.com/w/index.php/Accueil).
 ## Authentication
 
 Cloud Avenue support authentication with username, password and organization.