From 704cafdf4f87d83ee6e95ca3297ffc8e4f4efbe5 Mon Sep 17 00:00:00 2001 From: Claus Matzinger Date: Mon, 26 Aug 2024 12:17:55 +0200 Subject: [PATCH] Documentation adjustments (#265) * docs: removed deprecation notice --- coralogix/resource_coralogix_tco_policies_logs.go | 8 ++++---- coralogix/resource_coralogix_tco_policies_traces.go | 4 +--- docs/data-sources/tco_policies_logs.md | 4 ++-- docs/data-sources/tco_policies_traces.md | 8 +++++--- docs/resources/tco_policies_logs.md | 4 ++-- docs/resources/tco_policies_traces.md | 12 +++++++++--- 6 files changed, 23 insertions(+), 17 deletions(-) diff --git a/coralogix/resource_coralogix_tco_policies_logs.go b/coralogix/resource_coralogix_tco_policies_logs.go index 5cd7ebbd..8f9f69b1 100644 --- a/coralogix/resource_coralogix_tco_policies_logs.go +++ b/coralogix/resource_coralogix_tco_policies_logs.go @@ -1,11 +1,11 @@ // Copyright 2024 Coralogix Ltd. -// +// // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at -// +// // https://www.apache.org/licenses/LICENSE-2.0 -// +// // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -240,7 +240,7 @@ func (r *TCOPoliciesLogsResource) Schema(_ context.Context, _ resource.SchemaReq Required: true, }, }, - MarkdownDescription: "Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api .", + MarkdownDescription: "Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api.", } } diff --git a/coralogix/resource_coralogix_tco_policies_traces.go b/coralogix/resource_coralogix_tco_policies_traces.go index ce018b89..07066248 100644 --- a/coralogix/resource_coralogix_tco_policies_traces.go +++ b/coralogix/resource_coralogix_tco_policies_traces.go @@ -267,9 +267,7 @@ func (r *TCOPoliciesTracesResource) Schema(_ context.Context, _ resource.SchemaR Required: true, }, }, - MarkdownDescription: "Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api ." + - "Please note that this resource is deprecated. Please use the `coralogix_tco_policies_traces` resource instead.", - DeprecationMessage: "This resource is deprecated. Please use the `coralogix_tco_policies_traces` resource instead.", + MarkdownDescription: "Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api.", } } diff --git a/docs/data-sources/tco_policies_logs.md b/docs/data-sources/tco_policies_logs.md index a2da781c..6b32db7e 100644 --- a/docs/data-sources/tco_policies_logs.md +++ b/docs/data-sources/tco_policies_logs.md @@ -3,12 +3,12 @@ page_title: "coralogix_tco_policies_logs Data Source - terraform-provider-coralogix" subcategory: "" description: |- - Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api . + Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. --- # coralogix_tco_policies_logs (Data Source) -Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api . +Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. ## Example Usage diff --git a/docs/data-sources/tco_policies_traces.md b/docs/data-sources/tco_policies_traces.md index 3b6096be..c7fb678b 100644 --- a/docs/data-sources/tco_policies_traces.md +++ b/docs/data-sources/tco_policies_traces.md @@ -3,12 +3,13 @@ page_title: "coralogix_tco_policies_traces Data Source - terraform-provider-coralogix" subcategory: "" description: |- - Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api .Please note that this resource is deprecated. Please use the coralogix_tco_policies_traces resource instead. + Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. --- # coralogix_tco_policies_traces (Data Source) -Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api .Please note that this resource is deprecated. Please use the `coralogix_tco_policies_traces` resource instead. +Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. + ## Example Usage @@ -23,6 +24,7 @@ data "coralogix_tco_policies_traces" "example" { ### Read-Only +- `id` (String) This field can be ignored - `policies` (Attributes List) (see [below for nested schema](#nestedatt--policies)) @@ -85,4 +87,4 @@ Read-Only: Read-Only: - `names` (Set of String) -- `rule_type` (String) +- `rule_type` (String) \ No newline at end of file diff --git a/docs/resources/tco_policies_logs.md b/docs/resources/tco_policies_logs.md index df804a94..7e001249 100644 --- a/docs/resources/tco_policies_logs.md +++ b/docs/resources/tco_policies_logs.md @@ -4,12 +4,12 @@ page_title: "coralogix_tco_policies_logs Resource - terraform-provider-coralogix" subcategory: "" -description: "Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api . +description: "Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. --- # coralogix_tco_policies_logs (Resource) -Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api . +Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. **Please note!** - This resource will override all the existing policies with the new ones (even those who were managed outside terraform). diff --git a/docs/resources/tco_policies_traces.md b/docs/resources/tco_policies_traces.md index 727163a1..a063e56e 100644 --- a/docs/resources/tco_policies_traces.md +++ b/docs/resources/tco_policies_traces.md @@ -2,14 +2,15 @@ # generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "coralogix_tco_policies_traces Resource - terraform-provider-coralogix" subcategory: "" -description: "Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api .Please note that this resource is deprecated. Please use the coralogix_tco_policies_traces resource instead. +description: |- + Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. --- # coralogix_tco_policies_traces (Resource) -Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api .Please note that this resource is deprecated. Please use the `coralogix_tco_policies_traces` resource instead. +Coralogix TCO-Policies-List. For more information - https://coralogix.com/docs/tco-optimizer-api. + -**Please note!** - This resource will override all the existing policies with the new ones (even those who were managed outside terraform). ## Example Usage @@ -79,6 +80,10 @@ resource "coralogix_tco_policies_traces" "tco_policies" { - `policies` (Attributes List) (see [below for nested schema](#nestedatt--policies)) +### Read-Only + +- `id` (String) This field can be ignored + ### Nested Schema for `policies` @@ -163,6 +168,7 @@ Optional: - `rule_type` (String) ## Import + ```sh terraform import coralogix_tco_policies_traces.example "" ```