Merge pull request #4 from chezmoi-sh/docs/update-documentation

📝(gh): Update documentation for this provider

Author: xunleii

CODEOWNERS

@@ -14,4 +14,4 @@
 # See also OWNERS.md for governance details
 
 # Fallback owners
-*			@ulucinar @sergenyalcin
+*			@xunleii

CODE_OF_CONDUCT.md

@@ -1,3 +1,44 @@
-## Code of Conduct
+# Code of Conduct
 
-Upjet is under [the Apache 2.0 license](LICENSE) with [notice](NOTICE).
+All participants of `cloudflare-provider` are expected to abide by our Code of Conduct, both online and during
+in-person events that are hosted and/or associated with `cloudflare-provider`.
+
+## The Pledge
+
+In the interest of fostering an open and welcoming environment, we pledge to make participation in our project
+and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity,
+level of experience, nationality, personal appearance, race, religion, sex or sexual orientation.
+
+## The Standards
+
+Examples of behaviour that contributes to creating a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+
+Examples of unacceptable behaviour by participants include:
+
+- Trolling, insulting/derogatory comments, public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Not being respectful to reasonable communication boundaries, such as 'leave me alone,' 'go away,' or 'I’m not
+  discussing this with you.'
+- The usage of sexualised language or imagery and unwelcome sexual attention or advances
+- Swearing, usage of strong or disturbing language
+- Demonstrating the graphics or any other content you know may be considered disturbing
+- Starting and/or participating in arguments related to politics
+- Assuming or promoting any kind of inequality including but not limited to: age, body size, disability, ethnicity,
+  nationality and race, personal appearance, religion, sex or sexual orientation
+- Drug promotion of any kind
+- Attacking personal tastes
+- Other conduct which you know could reasonably be considered inappropriate in a professional setting.
+
+## Enforcement
+
+Violations of the Code of Conduct may be reported by sending an email to `[email protected]`.
+All reports will be reviewed and investigated and will result in a response that is deemed necessary and appropriate
+to the circumstances. Further details of specific enforcement policies may be posted separately.
+
+We hold the right and responsibility to remove comments or other contributions that are not aligned to this Code of
+Conduct, or to ban temporarily or permanently any members for other behaviours that they deem inappropriate,
+threatening, offensive, or harmful.

Makefile

@@ -239,15 +239,30 @@ schema-version-diff:
 
 $(PROJECT_NAME): $(PROJECT_NAME).generate generate build
 
-$(PROJECT_NAME).generate:
+$(PROJECT_NAME).generate: $(YQ)
 	@$(INFO) Generating Cloudflare resource definitions for v$(TERRAFORM_PROVIDER_VERSION)
-	@yq $(PROJECT_NAME).resources.yaml --output-format json \
+	@$(YQ) $(PROJECT_NAME).resources.yaml --output-format json \
 		| go run ./scripts/generate_provider_config.go -version $(TERRAFORM_PROVIDER_VERSION) -package $(TERRAFORM_PROVIDER_REPO)
 
+$(PROJECT_NAME).reference_matrix: $(YQ)
+	@$(INFO) Generating Cloudflare reference matrix for v$(TERRAFORM_PROVIDER_VERSION)
+	@echo >&2 "| Status | API Group | Kind | Terraform Equivalent |"
+	@echo >&2 "|--------|-----------|------|----------------------|"
+	@$(YQ) provider-cloudflare.resources.yaml -o json \
+		| jq '.supported | to_entries[] | .key as $$group | .value | to_entries[] | "|:white_check_mark:|\($$group).cloudflare.crossplane.io|\(.value.kind)|\(.key)|"' --raw-output \
+		| sort >&2
+	@$(YQ) provider-cloudflare.resources.yaml -o json \
+		| jq '.not_supported[] | "|:black_square_button:|||\(.)|"' --raw-output \
+		| sort >&2
+	@$(YQ) provider-cloudflare.resources.yaml -o json \
+		| jq '.deprecated[] | "|:no_entry_sign:|||\(.)|"' --raw-output \
+		| sort >&2
+
 define PROVIDER_MAKE_HELP
 
 $(PROJECT_NAME) Targets:
-    $(PROJECT_NAME).generate   Generate $(PROJECT_NAME) resource definitions for v$(TERRAFORM_PROVIDER_VERSION)
+    $(PROJECT_NAME).generate           Generate $(PROJECT_NAME) resource definitions for v$(TERRAFORM_PROVIDER_VERSION)
+	$(PROJECT_NAME).reference_matrix   Generate $(PROJECT_NAME) reference matrix for v$(TERRAFORM_PROVIDER_VERSION)
 
 endef
 export PROVIDER_MAKE_HELP