Docs improvements, release prep (#53)

* 1. Documentation improvements, removed limitations that were already implemented 2. Changed versions to release * 1. Fixes for documentation and release --------- Co-authored-by: Kaspar-Metsa <[email protected]>
Axual · Dec 12, 2024 · 55ea578 · 55ea578
1 parent 7f801c8
commit 55ea578
Show file tree

Hide file tree

Showing 9 changed files with 10 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,8 +3,9 @@
 All notable changes to this project will be documented in this file.
 
 ## [master](https://github.com/Axual/terraform-provider-axual/blob/master) - TBR
+## [2.4.2](https://github.com/Axual/terraform-provider-axual/releases/tag/v2.4.2) - 2024-12-12
 * Added `Instance` data source.
-* Added error handling for environment, group and topic datasources.
+* Added error handling for environment, group and topic data sources.
 * Added AVRO schema support to Topic data source.
 * Refactored running acceptance tests to be simpler.
 

diff --git a/docs/data-sources/topic.md b/docs/data-sources/topic.md
@@ -3,9 +3,6 @@ page_title: "Data Source: axual_topic"
 ---
 Use this data source to get an axual topic in Self-Service, you can reference it by name.
 
-## Limitations
-- Axual Terraform Provider does not currently support AVRO key type and AVRO value type for data source. For resource AVRO is supported. AVRO key and value type will be supported in the future for data source.
-
 ## Example Usage
 
 ```hcl

diff --git a/docs/index.md b/docs/index.md
@@ -11,7 +11,7 @@ terraform {
   required_providers {
     axual = {
       source  = "Axual/axual"
-      version = "2.4.1"
+      version = "2.4.2"
     }
   }
 }

diff --git a/docs/resources/application_principal.md b/docs/resources/application_principal.md
@@ -5,8 +5,10 @@ An Application Principal is a security principal (certificate or comparable) tha
 ## Limitations
 - Axual Terraform Provider only support these authentication methods:
 	- SSL (MUTUAL TLS) as a Certificate(PEM). To use it please provide a string with PEM certificate as `principal` property.
+		- Read more: https://docs.axual.io/axual/2024.3/self-service/application-management.html#ssl-application-principals
 	- SASL (OAUTHBEARER) as a Custom Principal that specifies the ID referenced in URI and tokens. To use it please provide a string with PEM certificate as principal property. For example, `my-client`.
-- Read more: https://docs.axual.io/axual/2024.2/self-service/application-management.html#configuring-application-securityauthentication
+		- Read more: https://docs.axual.io/axual/2024.3/self-service/application-management.html#application-custom-principal
+- We currently do not support these authentication methods SASL(scram-sha-256) nor SASL(scram-sha-512) authentication methods, both are planned to be supported soon.
 
 ## Security
 - If using Application Principal for a Connector application private key is required.

diff --git a/docs/resources/environment.md b/docs/resources/environment.md
@@ -30,8 +30,6 @@ Environments are used typically to support the application lifecycle, as it is m
 
 - `id` (String) Environment unique identifier
 
- - Public Environments cannot be deleted
-
 ## Example Usage
 
 ```hcl

diff --git a/examples/axual/provider.tf b/examples/axual/provider.tf
@@ -2,7 +2,7 @@ terraform {
   required_providers {
     axual = {
       source  = "Axual/axual"
-      version = "2.4.1"
+      version = "2.4.2"
     }
   }
 }

diff --git a/templates/data-sources/topic.md.tmpl b/templates/data-sources/topic.md.tmpl
@@ -3,9 +3,6 @@ page_title: "Data Source: axual_topic"
 ---
 Use this data source to get an axual topic in Self-Service, you can reference it by name.
 
-## Limitations
-- Axual Terraform Provider does not currently support AVRO key type and AVRO value type for data source. For resource AVRO is supported. AVRO key and value type will be supported in the future for data source.
-
 ## Example Usage
 
 ```hcl

diff --git a/templates/resources/application_principal.md.tmpl b/templates/resources/application_principal.md.tmpl
@@ -5,8 +5,10 @@
 ## Limitations
 - Axual Terraform Provider only support these authentication methods:
 	- SSL (MUTUAL TLS) as a Certificate(PEM). To use it please provide a string with PEM certificate as `principal` property.
+		- Read more: https://docs.axual.io/axual/2024.3/self-service/application-management.html#ssl-application-principals
 	- SASL (OAUTHBEARER) as a Custom Principal that specifies the ID referenced in URI and tokens. To use it please provide a string with PEM certificate as principal property. For example, `my-client`.
-- Read more: https://docs.axual.io/axual/2024.2/self-service/application-management.html#configuring-application-securityauthentication
+		- Read more: https://docs.axual.io/axual/2024.3/self-service/application-management.html#application-custom-principal
+- We currently do not support these authentication methods SASL(scram-sha-256) nor SASL(scram-sha-512) authentication methods, both are planned to be supported soon.
 
 ## Security
 - If using Application Principal for a Connector application private key is required.

diff --git a/templates/resources/environment.md.tmpl b/templates/resources/environment.md.tmpl
@@ -7,8 +7,6 @@
 
 {{ .SchemaMarkdown | trimspace }}
 
- - Public Environments cannot be deleted
-
 ## Example Usage
 
 ```hcl
-Original file line number
+Diff line change
@@ Expand Up @@
     - `id` (String) Environment unique identifier
-     - Public Environments cannot be deleted
     ## Example Usage
     ```hcl
@@ Expand Down @@