mrparkers · hamiltont · Sep 10, 2020 · Sep 10, 2020
diff --git a/docs-old/data_sources/keycloak_group.md → docs/data-sources/keycloak_group.md b/docs-old/data_sources/keycloak_group.md → docs/data-sources/keycloak_group.md
diff --git a/...ld/data_sources/keycloak_openid_client.md → docs/data-sources/keycloak_openid_client.md b/...ld/data_sources/keycloak_openid_client.md → docs/data-sources/keycloak_openid_client.md
diff --git a/docs-old/data_sources/keycloak_realm.md → docs/data-sources/keycloak_realm.md b/docs-old/data_sources/keycloak_realm.md → docs/data-sources/keycloak_realm.md
diff --git a/docs-old/data_sources/keycloak_realm_keys.md → docs/data-sources/keycloak_realm_keys.md b/docs-old/data_sources/keycloak_realm_keys.md → docs/data-sources/keycloak_realm_keys.md
diff --git a/docs-old/data_sources/keycloak_role.md → docs/data-sources/keycloak_role.md b/docs-old/data_sources/keycloak_role.md → docs/data-sources/keycloak_role.md
diff --git a/...loak_saml_client_installation_provider.md → ...loak_saml_client_installation_provider.md b/...loak_saml_client_installation_provider.md → ...loak_saml_client_installation_provider.md
diff --git a/...bute_importer_identity_provider_mapper.md → ...bute_importer_identity_provider_mapper.md b/...bute_importer_identity_provider_mapper.md → ...bute_importer_identity_provider_mapper.md
diff --git a/...rces/keycloak_authentication_execution.md → ...rces/keycloak_authentication_execution.md b/...rces/keycloak_authentication_execution.md → ...rces/keycloak_authentication_execution.md
diff --git a/...ycloak_authentication_execution_config.md → ...ycloak_authentication_execution_config.md b/...ycloak_authentication_execution_config.md → ...ycloak_authentication_execution_config.md
diff --git a/...ources/keycloak_custom_user_federation.md → ...ources/keycloak_custom_user_federation.md b/...ources/keycloak_custom_user_federation.md → ...ources/keycloak_custom_user_federation.md
diff --git a/...-old/resources/keycloak_default_groups.md → docs/resources/keycloak_default_groups.md b/...-old/resources/keycloak_default_groups.md → docs/resources/keycloak_default_groups.md
diff --git a/...eycloak_generic_client_protocol_mapper.md → ...eycloak_generic_client_protocol_mapper.md b/...eycloak_generic_client_protocol_mapper.md → ...eycloak_generic_client_protocol_mapper.md
diff --git a/...es/keycloak_generic_client_role_mapper.md → ...es/keycloak_generic_client_role_mapper.md b/...es/keycloak_generic_client_role_mapper.md → ...es/keycloak_generic_client_role_mapper.md
diff --git a/docs-old/resources/keycloak_group.md → docs/resources/keycloak_group.md b/docs-old/resources/keycloak_group.md → docs/resources/keycloak_group.md
diff --git a/...d/resources/keycloak_group_memberships.md → docs/resources/keycloak_group_memberships.md b/...d/resources/keycloak_group_memberships.md → docs/resources/keycloak_group_memberships.md
diff --git a/docs-old/resources/keycloak_group_roles.md → docs/resources/keycloak_group_roles.md b/docs-old/resources/keycloak_group_roles.md → docs/resources/keycloak_group_roles.md
diff --git a/...ovider_token_exchange_scope_permission.md → ...ovider_token_exchange_scope_permission.md b/...ovider_token_exchange_scope_permission.md → ...ovider_token_exchange_scope_permission.md
diff --git a/...sources/keycloak_ldap_full_name_mapper.md → ...sources/keycloak_ldap_full_name_mapper.md b/...sources/keycloak_ldap_full_name_mapper.md → ...sources/keycloak_ldap_full_name_mapper.md
diff --git a/...d/resources/keycloak_ldap_group_mapper.md → docs/resources/keycloak_ldap_group_mapper.md b/...d/resources/keycloak_ldap_group_mapper.md → docs/resources/keycloak_ldap_group_mapper.md
diff --git a/...es/keycloak_ldap_hardcoded_role_mapper.md → ...es/keycloak_ldap_hardcoded_role_mapper.md b/...es/keycloak_ldap_hardcoded_role_mapper.md → ...es/keycloak_ldap_hardcoded_role_mapper.md
diff --git a/...p_msad_lds_user_account_control_mapper.md → ...p_msad_lds_user_account_control_mapper.md b/...p_msad_lds_user_account_control_mapper.md → ...p_msad_lds_user_account_control_mapper.md
diff --git a/..._ldap_msad_user_account_control_mapper.md → ..._ldap_msad_user_account_control_mapper.md b/..._ldap_msad_user_account_control_mapper.md → ..._ldap_msad_user_account_control_mapper.md
diff --git a/...es/keycloak_ldap_user_attribute_mapper.md → ...es/keycloak_ldap_user_attribute_mapper.md b/...es/keycloak_ldap_user_attribute_mapper.md → ...es/keycloak_ldap_user_attribute_mapper.md
diff --git a/...esources/keycloak_ldap_user_federation.md → ...esources/keycloak_ldap_user_federation.md b/...esources/keycloak_ldap_user_federation.md → ...esources/keycloak_ldap_user_federation.md
diff --git a/...ources/keycloak_oidc_identity_provider.md → ...ources/keycloak_oidc_identity_provider.md b/...ources/keycloak_oidc_identity_provider.md → ...ources/keycloak_oidc_identity_provider.md
diff --git a/...ycloak_openid_audience_protocol_mapper.md → ...ycloak_openid_audience_protocol_mapper.md b/...ycloak_openid_audience_protocol_mapper.md → ...ycloak_openid_audience_protocol_mapper.md
diff --git a/docs-old/resources/keycloak_openid_client.md → docs/resources/keycloak_openid_client.md b/docs-old/resources/keycloak_openid_client.md → docs/resources/keycloak_openid_client.md
diff --git a/.../keycloak_openid_client_default_scopes.md → .../keycloak_openid_client_default_scopes.md b/.../keycloak_openid_client_default_scopes.md → .../keycloak_openid_client_default_scopes.md
diff --git a/...keycloak_openid_client_optional_scopes.md → ...keycloak_openid_client_optional_scopes.md b/...keycloak_openid_client_optional_scopes.md → ...keycloak_openid_client_optional_scopes.md
diff --git a/...resources/keycloak_openid_client_scope.md → ...resources/keycloak_openid_client_scope.md b/...resources/keycloak_openid_client_scope.md → ...resources/keycloak_openid_client_scope.md
diff --git a/...oak_openid_client_service_account_role.md → ...oak_openid_client_service_account_role.md b/...oak_openid_client_service_account_role.md → ...oak_openid_client_service_account_role.md
diff --git a/...cloak_openid_full_name_protocol_mapper.md → ...cloak_openid_full_name_protocol_mapper.md b/...cloak_openid_full_name_protocol_mapper.md → ...cloak_openid_full_name_protocol_mapper.md
diff --git a/...penid_group_membership_protocol_mapper.md → ...penid_group_membership_protocol_mapper.md b/...penid_group_membership_protocol_mapper.md → ...penid_group_membership_protocol_mapper.md
diff --git a/...openid_hardcoded_claim_protocol_mapper.md → ...openid_hardcoded_claim_protocol_mapper.md b/...openid_hardcoded_claim_protocol_mapper.md → ...openid_hardcoded_claim_protocol_mapper.md
diff --git a/..._openid_hardcoded_role_protocol_mapper.md → ..._openid_hardcoded_role_protocol_mapper.md b/..._openid_hardcoded_role_protocol_mapper.md → ..._openid_hardcoded_role_protocol_mapper.md
diff --git a/..._openid_user_attribute_protocol_mapper.md → ..._openid_user_attribute_protocol_mapper.md b/..._openid_user_attribute_protocol_mapper.md → ..._openid_user_attribute_protocol_mapper.md
diff --git a/...penid_user_client_role_protocol_mapper.md → ...penid_user_client_role_protocol_mapper.md b/...penid_user_client_role_protocol_mapper.md → ...penid_user_client_role_protocol_mapper.md
diff --git a/...k_openid_user_property_protocol_mapper.md → ...k_openid_user_property_protocol_mapper.md b/...k_openid_user_property_protocol_mapper.md → ...k_openid_user_property_protocol_mapper.md
diff --git a/...openid_user_realm_role_protocol_mapper.md → ...openid_user_realm_role_protocol_mapper.md b/...openid_user_realm_role_protocol_mapper.md → ...openid_user_realm_role_protocol_mapper.md
diff --git a/...enid_user_session_note_protocol_mapper.md → ...enid_user_session_note_protocol_mapper.md b/...enid_user_session_note_protocol_mapper.md → ...enid_user_session_note_protocol_mapper.md
diff --git a/docs-old/resources/keycloak_realm.md → docs/resources/keycloak_realm.md b/docs-old/resources/keycloak_realm.md → docs/resources/keycloak_realm.md
diff --git a/docs-old/resources/keycloak_realm_events.md → docs/resources/keycloak_realm_events.md b/docs-old/resources/keycloak_realm_events.md → docs/resources/keycloak_realm_events.md
diff --git a/docs-old/resources/keycloak_role.md → docs/resources/keycloak_role.md b/docs-old/resources/keycloak_role.md → docs/resources/keycloak_role.md
diff --git a/docs-old/resources/keycloak_saml_client.md → docs/resources/keycloak_saml_client.md b/docs-old/resources/keycloak_saml_client.md → docs/resources/keycloak_saml_client.md
diff --git a/...es/keycloak_saml_client_default_scopes.md → ...es/keycloak_saml_client_default_scopes.md b/...es/keycloak_saml_client_default_scopes.md → ...es/keycloak_saml_client_default_scopes.md
diff --git a/...d/resources/keycloak_saml_client_scope.md → docs/resources/keycloak_saml_client_scope.md b/...d/resources/keycloak_saml_client_scope.md → docs/resources/keycloak_saml_client_scope.md
diff --git a/...ources/keycloak_saml_identity_provider.md → ...ources/keycloak_saml_identity_provider.md b/...ources/keycloak_saml_identity_provider.md → ...ources/keycloak_saml_identity_provider.md
diff --git a/...ak_saml_user_attribute_protocol_mapper.md → ...ak_saml_user_attribute_protocol_mapper.md b/...ak_saml_user_attribute_protocol_mapper.md → ...ak_saml_user_attribute_protocol_mapper.md
diff --git a/...oak_saml_user_property_protocol_mapper.md → ...oak_saml_user_property_protocol_mapper.md b/...oak_saml_user_property_protocol_mapper.md → ...oak_saml_user_property_protocol_mapper.md
diff --git a/docs-old/resources/keycloak_user.md → docs/resources/keycloak_user.md b/docs-old/resources/keycloak_user.md → docs/resources/keycloak_user.md
diff --git a/docs-old/resources/keycloak_user_roles.md → docs/resources/keycloak_user_roles.md b/docs-old/resources/keycloak_user_roles.md → docs/resources/keycloak_user_roles.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -4,12 +4,12 @@ repo_url: https://github.com/mrparkers/terraform-provider-keycloak
 nav:
 - Getting Started: index.md
 - Data Sources:
-  - keycloak_group: data_sources/keycloak_group.md
-  - keycloak_openid_client: data_sources/keycloak_openid_client.md
-  - keycloak_realm: data_sources/keycloak_realm.md
-  - keycloak_realm_keys: data_sources/keycloak_realm_keys.md
-  - keycloak_role: data_sources/keycloak_role.md
-  - keycloak_saml_client_installation_provider: data_sources/keycloak_saml_client_installation_provider.md
+  - keycloak_group: data-sources/keycloak_group.md
+  - keycloak_openid_client: data-sources/keycloak_openid_client.md
+  - keycloak_realm: data-sources/keycloak_realm.md
+  - keycloak_realm_keys: data-sources/keycloak_realm_keys.md
+  - keycloak_role: data-sources/keycloak_role.md
+  - keycloak_saml_client_installation_provider: data-sources/keycloak_saml_client_installation_provider.md
 - Resources:
   - keycloak_realm: resources/keycloak_realm.md
   - keycloak_realm_events: resources/keycloak_realm_events.md

diff --git a/scripts/check-docs.sh b/scripts/check-docs.sh
@@ -0,0 +1,46 @@
+#!/bin/bash
+#
+# Hacky shell script to find potentially missing documentation. 
+# Relies on the fact that, so far, most of the source code 
+# filenames mirror their respective doc filename. Does not do any 
+# parsing (of either golang or markdown) to try and build a 100% 
+# accurate list, the intention is this quickly gets you a short list
+# of 10-15 things to check manually. 
+#
+# Usage: 
+#    $ cd <git-wd-root>
+#    $ ./scripts/check-docs.sh
+
+
+for code_file in $(ls provider)
+do
+
+	if [[ "$code_file" == *"test.go" ]]; then
+	  # echo "$code_file is a test file, ignoring"
+	  continue
+	fi
+
+	doc_file=$(echo $code_file | sed -e 's|\.go|\.md|g')
+	if [[ "$code_file" == "resource_"* ]]; then
+		doc_file=$(echo $doc_file | sed -e 's|^resource_|docs/resources/|g')
+		# echo "Looking for $doc_file"
+		if [[ ! -f "$doc_file" ]]; then
+   			 echo "$doc_file does not exist."
+		fi
+
+		continue
+	fi
+
+	if [[ "$code_file" == "data_source_"* ]]; then
+		doc_file=$(echo $doc_file | sed -e 's|^data_source_|docs/data-sources/|g')
+		# echo "Looking for $doc_file"
+		if [[ ! -f "$doc_file" ]]; then
+   			 echo "$doc_file does not exist."
+		fi
+
+		continue
+	fi
+
+	echo "No doc file found automatically for $code_file"
+
+done