TF Plugin Docs - migrating to new structure (#2470)

Co-authored-by: Aleksandr Rybolovlev <[email protected]>

Author: sheneska

.changelog/2470.txt

@@ -0,0 +1,3 @@
+```release-note:doc
+Migrate legacy structure to new tfplugindocs template structure
+```

.github/workflows/checkers-and-linters.yml

@@ -36,5 +36,5 @@ jobs:
         make vet
     - name: Run linters
       run: |
-        make website-lint
+        make docs-lint
         make tests-lint

.github/workflows/markdown-link-check.yaml

@@ -8,7 +8,7 @@ on:
     branches:
       - main
     paths:
-      - 'website/docs/**'
+      - 'docs/**'
   workflow_dispatch:
 
 jobs:
@@ -24,7 +24,7 @@ jobs:
           base-branch: main
           config-file: '.github/workflows/markdown.links.config.json'
           file-extension: '.markdown'
-          folder-path: 'website/docs'
+          folder-path: 'docs'
           use-verbose-mode: yes
           use-quiet-mode: yes
           max-depth: 2

.github/workflows/markdown.links.config.json

@@ -18,15 +18,15 @@
         },
         {
             "pattern": "^/docs/providers/kubernetes/",
-            "replacement": "file:///github/workspace/website/docs/"
+            "replacement": "file:///github/workspace/docs/"
         },
         {
             "pattern": "^(getting-started).html.markdown(#.*)?$",
-            "replacement": "file:///github/workspace/website/docs/guides/$1.html.md$2"
+            "replacement": "file:///github/workspace/docs/guides/$1.html.md$2"
         },
         {
-            "pattern": "^file:///github/workspace/website/docs/guides/(.*)\\.markdown(#.*)?$",
-            "replacement": "file:///github/workspace/website/docs/guides/$1.md$2"
+            "pattern": "^file:///github/workspace/docs/guides/(.*)\\.markdown(#.*)?$",
+            "replacement": "file:///github/workspace/docs/guides/$1.md$2"
         }
     ]
 }

.markdownlinkcheck.json

@@ -18,15 +18,15 @@
         },
         {
             "pattern": "^/docs/providers/kubernetes/",
-            "replacement": "file:///github/workspace/website/docs/"
+            "replacement": "file:///github/workspace/docs/"
         },
         {
             "pattern": "^(getting-started).html.markdown(#.*)?$",
-            "replacement": "file:///github/workspace/website/docs/guides/$1.html.md$2"
+            "replacement": "file:///github/workspace/docs/guides/$1.html.md$2"
         },
         {
-            "pattern": "^file:///github/workspace/website/docs/guides/(.*)\\.markdown(#.*)?$",
-            "replacement": "file:///github/workspace/website/docs/guides/$1.md$2"
+            "pattern": "^file:///github/workspace/docs/guides/(.*)\\.markdown(#.*)?$",
+            "replacement": "file:///github/workspace/docs/guides/$1.md$2"
         }
     ]
 }

GNUmakefile

@@ -3,7 +3,6 @@
 PROVIDER_DIR := $(abspath $(lastword $(dir $(MAKEFILE_LIST))))
 TEST         := "$(PROVIDER_DIR)/kubernetes"
 GOFMT_FILES  := $$(find $(PROVIDER_DIR) -name '*.go')
-WEBSITE_REPO := github.com/hashicorp/terraform-website
 PKG_NAME     := kubernetes
 OS_ARCH      := $(shell go env GOOS)_$(shell go env GOARCH)
 TF_PROV_DOCS := $(PWD)/kubernetes/test-infra/tfproviderdocs
@@ -24,7 +23,7 @@ PARALLEL_RUNS?=8
 
 default: build
 
-all: build depscheck fmtcheck test testacc test-compile tests-lint tests-lint-fix tools vet website-lint website-lint-fix
+all: build depscheck fmtcheck test testacc test-compile tests-lint tests-lint-fix tools vet docs-lint docs-lint-fix
 
 build: fmtcheck
 	go install
@@ -125,8 +124,8 @@ vet:
 
 # The docker command and run options may be overridden using env variables DOCKER and DOCKER_RUN_OPTS.
 # Example:
-#   DOCKER="podman --cgroup-manager=cgroupfs" make website-lint
-#   DOCKER_RUN_OPTS="--userns=keep-id" make website-lint
+#   DOCKER="podman --cgroup-manager=cgroupfs" make docs-lint
+#   DOCKER_RUN_OPTS="--userns=keep-id" make docs-lint
 #   This option is needed for systems using SELinux and rootless containers.
 #   DOCKER_VOLUME_OPTS="rw,Z"
 # For more info, see https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label
@@ -140,40 +139,40 @@ ifeq ($(.SHELLSTATUS),0)
 DOCKER_VOLUME_OPTS="rw,Z"
 endif
 
-website-lint: tools
+docs-lint: tools
 	@echo "==> Checking website against linters..."
-	@misspell -error -source=text ./website || (echo; \
+	@misspell -error -source=text ./docs || (echo; \
 		echo "Unexpected mispelling found in website files."; \
-		echo "To automatically fix the misspelling, run 'make website-lint-fix' and commit the changes."; \
+		echo "To automatically fix the misspelling, run 'make docs-lint-fix' and commit the changes."; \
 		exit 1)
 	@echo "==> Running markdownlint-cli using DOCKER='$(DOCKER)', DOCKER_RUN_OPTS='$(DOCKER_RUN_OPTS)' and DOCKER_VOLUME_OPTS='$(DOCKER_VOLUME_OPTS)'"
-	@$(DOCKER) run $(DOCKER_RUN_OPTS) -v $(PROVIDER_DIR):/workspace:$(DOCKER_VOLUME_OPTS) -w /workspace 06kellyjac/markdownlint-cli ./website || (echo; \
+	@$(DOCKER) run $(DOCKER_RUN_OPTS) -v $(PROVIDER_DIR):/workspace:$(DOCKER_VOLUME_OPTS) -w /workspace 06kellyjac/markdownlint-cli ./docs || (echo; \
 		echo "Unexpected issues found in website Markdown files."; \
-		echo "To apply any automatic fixes, run 'make website-lint-fix' and commit the changes."; \
+		echo "To apply any automatic fixes, run 'make docs-lint-fix' and commit the changes."; \
 		exit 1)
 	@echo "==> Running terrafmt diff..."
-	@terrafmt diff ./website --check --pattern '*.markdown' --quiet || (echo; \
+	@terrafmt diff ./docs --check --pattern '*.markdown' --quiet || (echo; \
 		echo "Unexpected differences in website HCL formatting."; \
-		echo "To see the full differences, run: terrafmt diff ./website --pattern '*.markdown'"; \
-		echo "To automatically fix the formatting, run 'make website-lint-fix' and commit the changes."; \
+		echo "To see the full differences, run: terrafmt diff ./docs --pattern '*.markdown'"; \
+		echo "To automatically fix the formatting, run 'make docs-lint-fix' and commit the changes."; \
 		exit 1)
 	@echo "==> Statically compiling provider for tfproviderdocs..."
 	@env CGO_ENABLED=0 GOOS=$$(go env GOOS) GOARCH=$$(go env GOARCH) go build -a -o $(TF_PROV_DOCS)/terraform-provider-kubernetes
 	@echo "==> Getting provider schema for tfproviderdocs..."
-		@$(DOCKER) run $(DOCKER_RUN_OPTS) -v $(TF_PROV_DOCS):/workspace:$(DOCKER_VOLUME_OPTS) -w /workspace hashicorp/terraform:0.12.29 init
-		@$(DOCKER) run $(DOCKER_RUN_OPTS) -v $(TF_PROV_DOCS):/workspace:$(DOCKER_VOLUME_OPTS) -w /workspace hashicorp/terraform:0.12.29 providers schema -json > $(TF_PROV_DOCS)/schema.json
+		@$(DOCKER) run $(DOCKER_RUN_OPTS) -v $(TF_PROV_DOCS):/workspace:$(DOCKER_VOLUME_OPTS) -w /workspace hashicorp/terraform:1.8.2 init
+		@$(DOCKER) run $(DOCKER_RUN_OPTS) -v $(TF_PROV_DOCS):/workspace:$(DOCKER_VOLUME_OPTS) -w /workspace hashicorp/terraform:1.8.2 providers schema -json > $(TF_PROV_DOCS)/schema.json
 	@echo "==> Running tfproviderdocs..."
 	@tfproviderdocs check -providers-schema-json $(TF_PROV_DOCS)/schema.json -provider-name kubernetes
 	@rm -f $(TF_PROV_DOCS)/schema.json $(TF_PROV_DOCS)/terraform-provider-kubernetes
 	@echo "==> Checking for broken links..."
 	@scripts/markdown-link-check.sh "$(DOCKER)" "$(DOCKER_RUN_OPTS)" "$(DOCKER_VOLUME_OPTS)" "$(PROVIDER_DIR)"
 
-website-lint-fix: tools
+docs-lint-fix: tools
 	@echo "==> Applying automatic website linter fixes..."
-	@misspell -w -source=text ./website
+	@misspell -w -source=text ./docs
 	@echo "==> Running markdownlint-cli --fix using DOCKER='$(DOCKER)', DOCKER_RUN_OPTS='$(DOCKER_RUN_OPTS)' and DOCKER_VOLUME_OPTS='$(DOCKER_VOLUME_OPTS)'"
-	@$(DOCKER) run $(DOCKER_RUN_OPTS) -v $(PROVIDER_DIR):/workspace:$(DOCKER_VOLUME_OPTS) -w /workspace 06kellyjac/markdownlint-cli --fix ./website
+	@$(DOCKER) run $(DOCKER_RUN_OPTS) -v $(PROVIDER_DIR):/workspace:$(DOCKER_VOLUME_OPTS) -w /workspace 06kellyjac/markdownlint-cli --fix ./docs
 	@echo "==> Fixing website terraform blocks code with terrafmt..."
-	@terrafmt fmt ./website --pattern '*.markdown'
+	@terrafmt fmt ./docs --pattern '*.markdown'
 
-.PHONY: build test testacc tools vet fmt fmtcheck terrafmt test-compile depscheck tests-lint tests-lint-fix website-lint website-lint-fix changelog changelog-entry
+.PHONY: build test testacc tools vet fmt fmtcheck terrafmt test-compile depscheck tests-lint tests-lint-fix docs-lint docs-lint-fix changelog changelog-entry

website/docs/d/all_namespaces.html.markdown renamed to docs/data-sources/all_namespaces.md

@@ -1,21 +1,19 @@
 ---
 subcategory: "core/v1"
-layout: "kubernetes"
 page_title: "Kubernetes: kubernetes_all_namespaces"
 description: |-
   Lists all namespaces within a cluster.
 ---
 
 # kubernetes_all_namespaces
 
-This data source provides a mechanism for listing the names of all available namespaces in a Kubernetes cluster.
-It can be used to check for existence of a specific namespaces or to apply another resource to all or a subset of existing namespaces in a cluster.
+This data source provides a mechanism for listing the names of all available namespaces in a Kubernetes cluster. It can be used to check for existence of a specific namespaces or to apply another resource to all or a subset of existing namespaces in a cluster.
 
 In Kubernetes, namespaces provide a scope for names and are intended as a way to divide cluster resources between multiple users.
 
 ## Example Usage
 
-```hcl
+```terraform
 data "kubernetes_all_namespaces" "allns" {}
 
 output "all-ns" {
@@ -25,5 +23,4 @@ output "all-ns" {
 output "ns-present" {
   value = contains(data.kubernetes_all_namespaces.allns.namespaces, "kube-system")
 }
-
 ```

website/docs/d/config_map.html.markdown renamed to docs/data-sources/config_map.md

@@ -1,6 +1,5 @@
 ---
 subcategory: "core/v1"
-layout: "kubernetes"
 page_title: "Kubernetes: kubernetes_config_map"
 description: |-
   This data source reads configuration data from a config map.
@@ -14,7 +13,7 @@ Config Maps are key-value pairs containing configuration data. The Config Map da
 
 ## Example Usage
 
-```hcl
+```terraform
 data "kubernetes_config_map" "example" {
   metadata {
     name = "my-config"

website/docs/d/config_map_v1.html.markdown renamed to docs/data-sources/config_map_v1.md

@@ -1,6 +1,5 @@
 ---
 subcategory: "core/v1"
-layout: "kubernetes"
 page_title: "Kubernetes: kubernetes_config_map_v1"
 description: |-
   This data source reads configuration data from a config map.
@@ -14,7 +13,7 @@ Config Maps are key-value pairs containing configuration data. The Config Map da
 
 ## Example Usage
 
-```hcl
+```terraform
 data "kubernetes_config_map_v1" "example" {
   metadata {
     name = "my-config"

website/docs/d/endpoints_v1.html.markdown renamed to docs/data-sources/endpoints_v1.md

@@ -1,6 +1,5 @@
 ---
 subcategory: "core/v1"
-layout: "kubernetes"
 page_title: "Kubernetes: kubernetes_endpoints_v1"
 description: |-
     An Endpoints resource is an abstraction, linked to a Service, which defines the list of endpoints that actually implement the service.
@@ -10,10 +9,9 @@ description: |-
 
 An Endpoints resource is an abstraction, linked to a Service, which defines the list of endpoints that actually implement the service.
 
-
 ## Example Usage
 
-```hcl
+```terraform
 data "kubernetes_endpoints_v1" "api_endpoints" {
   metadata {
     name      = "kubernetes"
@@ -39,7 +37,6 @@ The following arguments are supported:
 
 #### Attributes
 
-
 * `generation` - A sequence number representing a specific generation of the desired state.
 * `resource_version` - An opaque value that represents the internal version of this endpoints resource that can be used by clients to determine when endpoints resource has changed. For more info see [Kubernetes reference](https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency)
 * `uid` - The unique in time and space value for this endpoints resource. For more info see [Kubernetes reference](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids)
@@ -77,4 +74,3 @@ The following arguments are supported:
 * `name` - (Optional) The name of this port within the endpoint. All ports within the endpoint must have unique names. Optional if only one port is defined on this endpoint.
 * `port` - (Required) The port that will be utilized by this endpoint.
 * `protocol` - (Optional) The IP protocol for this port. Supports `TCP` and `UDP`. Default is `TCP`.
-