Documentation improvements (#642)

* Documentation improvements

* More Markdown lint fixes

* Add golangci-lint to the pipeline

Fixes #361

Author: willianpaixao

.github/workflows/golangci-lint.yml

@@ -0,0 +1,12 @@
+name: golangci-lint
+
+on: push
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v2

.github/workflows/markdown-lint.yml

@@ -0,0 +1,12 @@
+name: Markdown lint
+
+on: push
+
+jobs:
+  markdown-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: avto-dev/markdown-lint@v1
+        with:
+          args: 'docs'

.gitignore

@@ -1,35 +1,31 @@
+!command/test-fixtures/**/*.tfstate
+!command/test-fixtures/**/.terraform/
+*.backup
+*.bak
 *.dll
 *.exe
+*.iml
+*.iml
+*.log
+*.test
+*~
+.*.swp
+./*.tfstate
 .DS_Store
+.envrc
+.idea
+.terraform/
+.vagrant/
+/pkg/
+Gitlab-license.txt
+bin/
 example.tf
+license/*
+modules-dev/
 terraform.tfplan
 terraform.tfstate
-bin/
-modules-dev/
-/pkg/
-website/.vagrant
 website/.bundle
+website/.vagrant
 website/build
 website/node_modules
-.vagrant/
-*.backup
-./*.tfstate
-.terraform/
-*.log
-*.bak
-*~
-.*.swp
-.idea
-*.iml
-*.test
-*.iml
-.envrc
-
 website/vendor
-
-# Test exclusions
-!command/test-fixtures/**/*.tfstate
-!command/test-fixtures/**/.terraform/
-
-license/*
-Gitlab-license.txt

.markdownlint.yml

@@ -0,0 +1,9 @@
+# Configuration for markdownlint
+# https://github.com/DavidAnson/markdownlint#configuration
+
+# Disabled Rules
+# https://github.com/DavidAnson/markdownlint/blob/master/doc/Rules.md
+MD013: false
+MD014: false
+MD034: false
+MD040: false

docs/data-sources/group.md

@@ -1,18 +1,18 @@
 # gitlab\_group
 
-Provides details about a specific group in the gitlab provider.
+Provide details about a specific group in the gitlab provider.
 
 ## Example Usage
 
-**By group's ID**
+### By group's ID
 
 ```hcl
 data "gitlab_group" "foo" {
   group_id = 123
 }
 ```
 
-**By group's full path**
+### By group's full path
 
 ```hcl
 data "gitlab_group" "foo" {
@@ -28,7 +28,7 @@ The following arguments are supported:
 
 * `full_path` - (Optional) The full path of the group.
 
-**Note**: exactly one of group_id or full_path must be provided.
+> **Note**: exactly one of group_id or full_path must be provided.
 
 ## Attributes Reference
 

docs/data-sources/group_membership.md

@@ -1,18 +1,18 @@
 # gitlab\_group\_membership
 
-Provides details about a list of group members in the gitlab provider. The results include id, username, name and more about the requested members.
+Provide details about a list of group members in the gitlab provider. The results include id, username, name and more about the requested members.
 
 ## Example Usage
 
-**By group's ID**
+### By group's ID
 
 ```hcl
 data "gitlab_group_membership" "example" {
   group_id = 123
 }
 ```
 
-**By group's full path**
+### By group's full path
 
 ```hcl
 data "gitlab_group_membership" "example" {
@@ -28,9 +28,9 @@ The following arguments are supported:
 
 * `full_path` - (Optional) The full path of the group.
 
-* `access_level` - (Optional) Only return members with the desidered access level. Acceptable values are: `guest`, `reporter`, `developer`, `maintainer`, `owner`.
+* `access_level` - (Optional) Only return members with the desired access level. Acceptable values are: `guest`, `reporter`, `developer`, `maintainer`, `owner`.
 
-**Note**: exactly one of group_id or full_path must be provided.
+> **Note**: exactly one of group_id or full_path must be provided.
 
 ## Attributes Reference
 
@@ -45,4 +45,3 @@ The following attributes are exported:
   * `web_url` - User's website URL.
   * `access_level` - One of five levels of access to the group.
   * `expires_at` - Expiration date for the group membership.
-

docs/data-sources/project.md

@@ -1,18 +1,18 @@
 # gitlab\_project
 
-Provides details about a specific project in the gitlab provider. The results include the name of the project, path, description, default branch, etc.
+Provide details about a specific project in the gitlab provider. The results include the name of the project, path, description, default branch, etc.
 
 ## Example Usage
 
 ```hcl
 data "gitlab_project" "example" {
-	id = 30
+  id = 30
 }
 ```
 
 ```hcl
 data "gitlab_project" "example" {
-	id = "foo/bar/baz"
+  id = "foo/bar/baz"
 }
 ```
 

docs/data-sources/projects.md

@@ -1,8 +1,8 @@
 # gitlab\_projects
 
-Provides details about a list of projects in the Gitlab provider. Listing all projects and group projects with [project filtering](https://docs.gitlab.com/ee/api/projects.html#list-user-projects) or [group project filtering](https://docs.gitlab.com/ee/api/groups.html#list-a-groups-projects) is supported.
+Provide details about a list of projects in the Gitlab provider. Listing all projects and group projects with [project filtering](https://docs.gitlab.com/ee/api/projects.html#list-user-projects) or [group project filtering](https://docs.gitlab.com/ee/api/groups.html#list-a-groups-projects) is supported.
 
-~> NOTE: This data source supports all available filters exposed by the `xanzy/go-gitlab` package, which might not expose all available filters exposed by the Gitlab APIs.   
+> **NOTE**: This data source supports all available filters exposed by the `xanzy/go-gitlab` package, which might not expose all available filters exposed by the Gitlab APIs.  
 
 ## Example Usage
 
@@ -74,7 +74,6 @@ The following arguments are supported:
 
 * `with_programming_language` - (Optional) Limit by projects which use the given programming language. Cannot be used with `group_id`.
 
-
 ## Attributes Reference
 
 The following attributes are exported:
@@ -193,7 +192,7 @@ Projects items have the following fields:
 
 The `owner` attribute exposes the following sub-attributes:
 
-~> NOTE: These sub-attributes are only populated if the Gitlab token used has an administrator scope.
+> **NOTE**: These sub-attributes are only populated if the Gitlab token used has an administrator scope.
 
 * `id`
 

docs/data-sources/users.md

@@ -1,8 +1,8 @@
 # gitlab\_users
 
-Provides details about a list of users in the gitlab provider. The results include id, username, email, name and more about the requested users. Users can also be sorted and filtered using several options.
+Provide details about a list of users in the gitlab provider. The results include id, username, email, name and more about the requested users. Users can also be sorted and filtered using several options.
 
-**NOTE**: Some of the available options require administrator privileges. Please visit [Gitlab API documentation][users_for_admins] for more information.
+**NOTE**: Some available options require administrator privileges. Please visit [Gitlab API documentation][users_for_admins] for more information.
 
 ## Example Usage
 
@@ -12,6 +12,10 @@ data "gitlab_users" "example" {
   order_by = "name"
   created_before = "2019-01-01"
 }
+
+data "gitlab_users" "example-two" {
+  search = "username"
+}
 ```
 
 ## Argument Reference
@@ -36,7 +40,6 @@ The following arguments are supported:
 
 * `created_after` - (Optional)  Search for users created after a specific date. (Requires administrator privileges)
 
-
 ## Attributes Reference
 
 The following attributes are exported:
@@ -56,19 +59,18 @@ The following attributes are exported:
   * `extern_uid` - The external UID of the user.
   * `provider` - The UID provider of the user.
   * `organization` - The organization of the user.
-  * `two_factor_enabled` - Whether user's two factor auth is enabled.
+  * `two_factor_enabled` - Whether user's two-factor auth is enabled.
   * `note` - The note associated to the user.
   * `avatar_url` - The avatar URL of the user.
   * `bio` - The bio of the user.
   * `location` - The location of the user.
   * `skype` - Skype username of the user.
-  * `linkedin` - Linkedin profile of the user.
+  * `linkedin` - LinkedIn profile of the user.
   * `twitter` - Twitter username of the user.
   * `website_url` - User's website URL.
   * `theme_id` - User's theme ID.
   * `color_scheme_id` - User's color scheme ID.
   * `last_sign_in_at` - Last user's sign-in date.
   * `current_sign_in_at` - Current user's sign-in date.
 
-
 [users_for_admins]: https://docs.gitlab.com/ce/api/users.html#for-admins

docs/resources/deploy_key.md

@@ -1,7 +1,6 @@
 # gitlab\_deploy\_key
 
-This resource allows you to create and manage deploy keys for your GitLab projects.
-
+This resource allows you to create and manage [deploy keys](https://docs.gitlab.com/ee/user/project/deploy_keys/) for your GitLab projects.
 
 ## Example Usage