Merge pull request #852 from timofurrer/feature/master-to-main

Improve provider documentation

Author: timofurrer

.github/terraform_logo.svg

@@ -7,7 +7,7 @@ on:
   push:
     branches:
       - main
-      - master
+
   # For removing the merge-conflict label.
   pull_request_target:
     types: [synchronize]

.github/workflows/pr-check-conflicts.yml

@@ -1,16 +1,17 @@
-<img src="https://www.datocms-assets.com/2885/1629941242-logo-terraform-main.svg" width="600px">
+<a href="https://terraform.io">
+    <img src=".github/terraform_logo.svg" alt="Terraform logo" title="Terraform" align="right" height="50" />
+</a>
 
 # Terraform Provider for Gitlab
 
-- [Documentation](https://www.terraform.io/docs/providers/gitlab/index.html)
-- [![Gitter chat](https://badges.gitter.im/hashicorp-terraform/Lobby.png)](https://gitter.im/hashicorp-terraform/Lobby)
-- Mailing list: [Google Groups](http://groups.google.com/group/terraform-tool)
-- Build status: [![Tests](https://github.com/gitlabhq/terraform-provider-gitlab/actions/workflows/push.yml/badge.svg)](https://github.com/gitlabhq/terraform-provider-gitlab/actions/workflows/push.yml)
+[![Tests](https://github.com/gitlabhq/terraform-provider-gitlab/actions/workflows/push.yml/badge.svg)](https://github.com/gitlabhq/terraform-provider-gitlab/actions/workflows/push.yml)
 
-## Requirements
+- [Documentation](https://www.terraform.io/docs/providers/gitlab/index.html)
+- [Issues](https://github.com/gitlabhq/terraform-provider-gitlab/issues)
 
--	[Terraform](https://www.terraform.io/downloads.html) >= 0.12.x
+The Terraform Gitlab Provider is a plugin for Terraform that allows for the full lifecycle management of
+GitLab resources, like users, groups and projects.
 
 ## Contributing
 
-Check out the [CONTRIBUTING.md](/CONTRIBUTING.md) guide for tips on how to contribute and develop the provider.
+Check out the [CONTRIBUTING.md](/CONTRIBUTING.md) guide for tips on how to contribute and develop the provider.

README.md

@@ -1,14 +1,17 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
-page_title: "gitlab Provider"
+page_title: "GitLab Provider"
 subcategory: ""
 description: |-
-  
+  Terraform Provider for GitLab
 ---
 
-# gitlab Provider
+Use the GitLab provider to interact with GitLab resources, like
+users, groups, projects and more. You must configure the provider with
+the proper credentials before you can use it.
 
+Use the navigation to the left to read about the valid data sources and resources.
 
+This provider requires at least [Terraform 0.12](https://www.terraform.io/downloads.html).
 
 ## Example Usage
 

docs/index.md

@@ -0,0 +1,20 @@
+---
+page_title: "GitLab Provider"
+subcategory: ""
+description: |-
+  Terraform Provider for GitLab
+---
+
+Use the GitLab provider to interact with GitLab resources, like
+users, groups, projects and more. You must configure the provider with
+the proper credentials before you can use it.
+
+Use the navigation to the left to read about the valid data sources and resources.
+
+This provider requires at least [Terraform 0.12](https://www.terraform.io/downloads.html).
+
+## Example Usage
+
+{{tffile "examples/provider/provider.tf"}}
+
+{{ .SchemaMarkdown | trimspace }}