chore: update docs (#111)

## Description

<!-- **Please link some issue here describing what you are trying to achieve.**

In case there is no issue present for your PR, please consider creating one.
At least please give us some description what you are trying to achieve and why your change is needed. -->

relates to #1234

## Checklist

- [ ] Issue was linked above
- [ ] Code format was applied: `make fmt`
- [ ] Examples were added / adjusted (see `examples/` directory)
- [x] Docs are up-to-date: `make generate-docs` (will be checked by CI)
- [ ] Unit tests got implemented or updated
- [ ] Acceptance tests got implemented or updated (see e.g. [here](f5f99d1709/stackit/internal/services/dns/dns_acc_test.go))
- [x] Unit tests are passing: `make test` (will be checked by CI)
- [x] No linter issues: `make lint` (will be checked by CI)

Co-authored-by: Marcel S. Henselin <marcel.henselin@stackit.cloud>
Reviewed-on: #111

docs/data-sources/sqlserverflexbeta_flavor.md

@@ -0,0 +1,54 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "stackitprivatepreview_sqlserverflexbeta_flavor Data Source - stackitprivatepreview"
+subcategory: ""
+description: |-
+  
+---
+
+# stackitprivatepreview_sqlserverflexbeta_flavor (Data Source)
+
+
+
+## Example Usage
+
+```terraform
+data "stackitprivatepreview_sqlserverflexbeta_flavor" "flavor" {
+  project_id    = var.project_id
+  region        = var.region
+  cpu           = 4
+  ram           = 16
+  node_type     = "Single"
+  storage_class = "premium-perf2-stackit"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `cpu` (Number) The cpu count of the instance.
+- `node_type` (String) defines the nodeType it can be either single or HA
+- `project_id` (String) The project ID of the flavor.
+- `ram` (Number) The memory of the instance in Gibibyte.
+- `region` (String) The region of the flavor.
+- `storage_class` (String) The memory of the instance in Gibibyte.
+
+### Read-Only
+
+- `description` (String) The flavor description.
+- `flavor_id` (String) The id of the instance flavor.
+- `id` (String) The id of the instance flavor.
+- `max_gb` (Number) maximum storage which can be ordered for the flavor in Gigabyte.
+- `min_gb` (Number) minimum storage which is required to order in Gigabyte.
+- `storage_classes` (Attributes List) maximum storage which can be ordered for the flavor in Gigabyte. (see [below for nested schema](#nestedatt--storage_classes))
+
+<a id="nestedatt--storage_classes"></a>
+### Nested Schema for `storage_classes`
+
+Read-Only:
+
+- `class` (String)
+- `max_io_per_sec` (Number)
+- `max_through_in_mb` (Number)

examples/resources/stackitprivatepreview_postgresflexalpha_instance/resource.tf

@@ -1,3 +1,30 @@
+# NOTE: flavor handling will change in future
+# V2 compatible flavor usage (example without encryption)
+resource "stackitprivatepreview_postgresflexalpha_instance" "example-instance" {
+  project_id      = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  name            = "example-instance"
+  acl             = ["XXX.XXX.XXX.X/XX", "XX.XXX.XX.X/XX"]
+  backup_schedule = "0 0 * * *"
+  retention_days  = 30
+  flavor = {
+    cpu = 2
+    ram = 4
+  }
+  replicas = 1
+  storage = {
+    performance_class = "premium-perf2-stackit"
+    size              = 10
+  }
+  network = {
+    acl          = ["XXX.XXX.XXX.X/XX", "XX.XXX.XX.X/XX"]
+    access_scope = "PUBLIC"
+  }
+  version = 17
+}
+
+# future use of flavor (implemented in V3 API)
+# first determine flavor and then use the flavor_id
+
 resource "stackitprivatepreview_postgresflexalpha_instance" "example-instance" {
   project_id      = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
   name            = "example-instance"

examples/resources/stackitprivatepreview_sqlserverflexbeta_instance/resource.tf

@@ -1,3 +1,28 @@
+# NOTE: flavor handling will change in future
+# V2 compatible flavor usage
+resource "stackitprivatepreview_sqlserverflexbeta_instance" "instance" {
+  project_id      = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  name            = "example-instance"
+  backup_schedule = "0 3 * * *"
+  retention_days  = 31
+  flavor = {
+    cpu = 2
+    ram = 4
+  }
+  storage = {
+    class = "premium-perf2-stackit"
+    size  = 50
+  }
+  version = 2022
+  network = {
+    acl          = ["XXX.XXX.XXX.X/XX", "XX.XXX.XX.X/XX"]
+    access_scope = "SNA"
+  }
+}
+
+# future use of flavor (implemented in V3 API)
+# first determine flavor and then use the flavor_id
+
 # without encryption and SNA
 resource "stackitprivatepreview_sqlserverflexbeta_instance" "instance" {
   project_id      = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

generator/cmd/docCmd.go

@@ -172,12 +172,12 @@ func workDocs() error {
 			case "data-sources":
 				dataSources[matches[0][1]] = append(dataSources[matches[0][1]], ResItem{
 					ItemName: matches[0][2],
-					ItemLink: fmt.Sprintf("docs/%s/%s", entry.Name(), matches[0][0]),
+					ItemLink: fmt.Sprintf("/docs/docs/%s/%s", entry.Name(), matches[0][0]),
 				})
 			case "resources":
 				resources[matches[0][1]] = append(resources[matches[0][1]], ResItem{
 					ItemName: matches[0][2],
-					ItemLink: fmt.Sprintf("docs/%s/%s", entry.Name(), matches[0][0]),
+					ItemLink: fmt.Sprintf("/docs/docs/%s/%s", entry.Name(), matches[0][0]),
 				})
 			default:
 				return fmt.Errorf("this should never have happened")