chore: add docs to lint target, ensure they pass (#79)

### what

- add `lint-docs` to the `lint` target
- move workaround for making them pass linting

### why

getting `lint-docs` to pass with generated docs

### testing

n/a

### docs

n/a

Author: albertodonato

.github/workflows/ci.yaml

@@ -87,8 +87,6 @@ jobs:
 
       - name: Lint
         run: |
-          # XXX workaround for https://github.com/hashicorp/terraform-plugin-docs/issues/445
-          sed -i '/^subcategory:/d' docs/index.md
           just lint-docs
 
   lint-copyright:

docs/index.md

@@ -1,7 +1,6 @@
 ---
 # generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "stacklet Provider"
-subcategory: ""
 description: |-
   This provider interacts with Stacklet's cloud governance platform.
   It allows managing resources like accounts, account groups, policy collections, bindings and so on.

justfile

@@ -16,7 +16,7 @@ format-go:
     go fmt ./...    
 
 # Run linters
-lint: lint-go lint-tf lint-copyright
+lint: lint-go lint-tf lint-docs lint-copyright
 
 # Run linters for terraform
 lint-tf:
@@ -28,11 +28,11 @@ lint-go:
     go vet {{ package }}
     golangci-lint run --fix
 
-# Run checker for generated docs
+# Run linter for generated docs
 lint-docs:
     env -C tools go generate -run=validate-docs
 
-# Run checker for copyright headers
+# Run linter for copyright headers
 lint-copyright:
     env -C tools go generate -run=validate-copyright
 
@@ -51,12 +51,14 @@ test-record testname:
 # Generate provider documentation
 docs:
     env -C tools go generate -run=generate-docs
+    # XXX workaround for https://github.com/hashicorp/terraform-plugin-docs/issues/445
+    sed -i '/^subcategory:/d' docs/index.md
 
 # Add copyright headers
 copyright:
     env -C tools go generate -run=generate-copyright
 
-# Update go dependencies
+# Update golang dependencies
 update-deps-go:
     go get -u ./...
     go mod tidy