Skip to content

Commit

Permalink
Documentation adjustments (#265)
Browse files Browse the repository at this point in the history
* docs: removed deprecation notice
  • Loading branch information
celaus authored Aug 26, 2024
1 parent a2fea89 commit 704cafd
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 17 deletions.
8 changes: 4 additions & 4 deletions coralogix/resource_coralogix_tco_policies_logs.go
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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.",
}
}

Expand Down
4 changes: 1 addition & 3 deletions coralogix/resource_coralogix_tco_policies_traces.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.",
}
}

Expand Down
4 changes: 2 additions & 2 deletions docs/data-sources/tco_policies_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 5 additions & 3 deletions docs/data-sources/tco_policies_traces.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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))

<a id="nestedatt--policies"></a>
Expand Down Expand Up @@ -85,4 +87,4 @@ Read-Only:
Read-Only:

- `names` (Set of String)
- `rule_type` (String)
- `rule_type` (String)
4 changes: 2 additions & 2 deletions docs/resources/tco_policies_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
12 changes: 9 additions & 3 deletions docs/resources/tco_policies_traces.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

<a id="nestedatt--policies"></a>
### Nested Schema for `policies`

Expand Down Expand Up @@ -163,6 +168,7 @@ Optional:
- `rule_type` (String)

## Import

```sh
terraform import coralogix_tco_policies_traces.example ""
```
Expand Down

0 comments on commit 704cafd

Please sign in to comment.