Manually add descriptions to schemas that could not be auto-generated

Handcrafted changes to schema descriptions and examples

Author: armsnyder

examples/provider/provider.tf

@@ -0,0 +1,42 @@
+# Configure the GitLab Provider
+provider "gitlab" {
+    token = var.gitlab_token
+}
+
+# Add a project owned by the user
+resource "gitlab_project" "sample_project" {
+    name = "example"
+}
+
+# Add a hook to the project
+resource "gitlab_project_hook" "sample_project_hook" {
+    project = gitlab_project.sample_project.id
+    url = "https://example.com/project_hook"
+}
+
+# Add a variable to the project
+resource "gitlab_project_variable" "sample_project_variable" {
+    project = gitlab_project.sample_project.id
+    key = "project_variable_key"
+    value = "project_variable_value"
+}
+
+# Add a deploy key to the project
+resource "gitlab_deploy_key" "sample_deploy_key" {
+    project = gitlab_project.sample_project.id
+    title = "terraform example"
+    key = "ssh-rsa AAAA..."
+}
+
+# Add a group
+resource "gitlab_group" "sample_group" {
+    name = "example"
+    path = "example"
+    description = "An example group"
+}
+
+# Add a project to the group - example/example
+resource "gitlab_project" "sample_group_project" {
+    name = "example"
+    namespace_id = gitlab_group.sample_group.id
+}

examples/resources/gitlab_group_badge/import.sh

@@ -0,0 +1,2 @@
+# GitLab group badges can be imported using an id made up of `{group_id}:{badge_id}`, e.g.
+terraform import gitlab_group_badge.foo 1:3

examples/resources/gitlab_group_custom_attribute/import.sh

@@ -1,2 +1,2 @@
-# You can import a group custom attribute using the following id pattern:
-terraform import gitlab_group_custom_attribute.attr <group-id>:<key>
+# You can import a group custom attribute using the an id made up of `{group-id}:{key}`, e.g.
+terraform import gitlab_group_custom_attribute.attr 42:location

examples/resources/gitlab_instance_cluster/import.sh

@@ -0,0 +1,2 @@
+# GitLab instance clusters can be imported using a `clusterid`, e.g.
+terraform import gitlab_instance_cluster.bar 123

examples/resources/gitlab_project_badge/import.sh

@@ -0,0 +1,2 @@
+# GitLab project badges can be imported using an id made up of `{project_id}:{badge_id}`, e.g.
+terraform import gitlab_project_badge.foo 1:3

examples/resources/gitlab_project_custom_attribute/import.sh

@@ -1,2 +1,2 @@
-# You can import a project custom attribute using the following id pattern:
-terraform import gitlab_project_custom_attribute.attr <project-id>:<key>
+# You can import a project custom attribute using an id made up of `{project-id}:{key}`, e.g.
+terraform import gitlab_project_custom_attribute.attr 42:location

examples/resources/gitlab_project_mirror/import.sh

@@ -0,0 +1,2 @@
+# GitLab project mirror can be imported using an id made up of `project_id:mirror_id`, e.g.
+terraform import gitlab_project_mirror.foo "12345:1337"

examples/resources/gitlab_repository_file/import.sh

@@ -1,2 +1,2 @@
-# A Repository File can be imported using the following id pattern, e.g.
-terraform import gitlab_repository_file.this <project-id>:<branch-name>:<file-path>
+# A Repository File can be imported using an id made up of `<project-id>:<branch-name>:<file-path>`, e.g.
+terraform import gitlab_repository_file.this 1:main:foo/bar.txt

examples/resources/gitlab_service_jira/import.sh

@@ -0,0 +1,2 @@
+# You can import a service_jira state using the project ID, e.g.
+terraform import gitlab_service_jira.jira 1

examples/resources/gitlab_service_microsoft_teams/import.sh

@@ -0,0 +1,2 @@
+# You can import a service_microsoft_teams state using the project ID, e.g.
+terraform import gitlab_service_microsoft_teams.teams 1