Merge pull request #126 from datadrivers/fea/sub-categories

Add subcategory to generated documentation
datadrivers · Oct 7, 2021 · db37d9e · db37d9e
2 parents c5f61b9 + 3c77409
commit db37d9e
Show file tree

Hide file tree

Showing 28 changed files with 35 additions and 0 deletions.
diff --git a/docs/data-sources/anonymous.md b/docs/data-sources/anonymous.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_anonymous"
+subcategory: "Other"
 sidebar_current: "docs-nexus-datasource-anonymous"
 description: |-
   Use this get the anonymous configuration of the nexus repository manager.

diff --git a/docs/data-sources/blobstore.md b/docs/data-sources/blobstore.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_blobstore"
+subcategory: "Other"
 sidebar_current: "docs-nexus-datasource-blobstore"
 description: |-
   Use this to create a Nexus blobstore.

diff --git a/docs/data-sources/privileges.md b/docs/data-sources/privileges.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_privileges"
+subcategory: "Other"
 sidebar_current: "docs-nexus-datasource-privileges"
 description: |-
   Use this data source to work with privileges

diff --git a/docs/data-sources/repository.md b/docs/data-sources/repository.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_repository"
+subcategory: "Other"
 sidebar_current: "docs-nexus-datasource-repository"
 description: |-
   Use this data source to get a repository data structure

diff --git a/docs/data-sources/routing_rule.md b/docs/data-sources/routing_rule.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_routing_rule"
+subcategory: "Routing"
 sidebar_current: "docs-nexus-datasource-routing_rule"
 description: |-
   Use this data source to work with routing rules

diff --git a/docs/data-sources/security_ldap.md b/docs/data-sources/security_ldap.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_security_ldap"
+subcategory: "Security"
 sidebar_current: "docs-nexus-datasource-security_ldap"
 description: |-
   Use this data source to work with LDAP security

diff --git a/docs/data-sources/security_realms.md b/docs/data-sources/security_realms.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_security_realms"
+subcategory: "Security"
 sidebar_current: "docs-nexus-datasource-security_realms"
 description: |-
   Use this data source to work with Realms security

diff --git a/docs/data-sources/security_saml.md b/docs/data-sources/security_saml.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_security_saml"
+subcategory: "Security"
 sidebar_current: "docs-nexus-datasource-security_saml"
 description: |-
   Use this data source to get the saml configuration

diff --git a/docs/data-sources/security_user.md b/docs/data-sources/security_user.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_security_user"
+subcategory: "Security"
 sidebar_current: "docs-nexus-datasource-security_user"
 description: |-
   Use this data source to get a user data structure

diff --git a/docs/data-sources/security_user_token.md b/docs/data-sources/security_user_token.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_security_user_token"
+subcategory: "Security"
 sidebar_current: "docs-nexus-datasource-security_user_token"
 description: |-
   Use this data source to get the global user-token configuration.

diff --git a/docs/data-sources/user.md b/docs/data-sources/user.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_user"
+subcategory: "Other"
 sidebar_current: "docs-nexus-datasource-user"
 description: |-
   This data source is deprecated.

diff --git a/docs/resources/anonymous.md b/docs/resources/anonymous.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_anonymous"
+subcategory: "Other"
 sidebar_current: "docs-nexus-resource-anonymous"
 description: |-
   Use this resource to change the anonymous configuration of the nexus repository manager.

diff --git a/docs/resources/blobstore.md b/docs/resources/blobstore.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_blobstore"
+subcategory: "Other"
 sidebar_current: "docs-nexus-resource-blobstore"
 description: |-
   Use this resource to create a Nexus blobstore.

diff --git a/docs/resources/content_selector.md b/docs/resources/content_selector.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_content_selector"
+subcategory: "Other"
 sidebar_current: "docs-nexus-resource-content_selector"
 description: |-
   Use this resource to create a Nexus Content Selector

diff --git a/docs/resources/privilege.md b/docs/resources/privilege.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_privilege"
+subcategory: "Other"
 sidebar_current: "docs-nexus-resource-privilege"
 description: |-
   Use this resource to create a Nexus privilege

diff --git a/docs/resources/repository.md b/docs/resources/repository.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_repository"
+subcategory: "Other"
 sidebar_current: "docs-nexus-resource-repository"
 description: |-
   Use this resource to create a Nexus Repository.

diff --git a/docs/resources/role.md b/docs/resources/role.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_role"
+subcategory: "Other"
 sidebar_current: "docs-nexus-resource-role"
 description: |-
   Use this resource to create a Nexus Role.

diff --git a/docs/resources/routing_rule.md b/docs/resources/routing_rule.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_routing_rule"
+subcategory: "Routing"
 sidebar_current: "docs-nexus-resource-routing_rule"
 description: |-
   Use this resource to create a Nexus Routing Rule.

diff --git a/docs/resources/script.md b/docs/resources/script.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_script"
+subcategory: "Other"
 sidebar_current: "docs-nexus-resource-script"
 description: |-
   Use this resource to create and execute a custom script.

diff --git a/docs/resources/security_ldap.md b/docs/resources/security_ldap.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_security_ldap"
+subcategory: "Security"
 sidebar_current: "docs-nexus-resource-security_ldap"
 description: |-
   Use this resource to create a Nexus Security LDAP

diff --git a/docs/resources/security_ldap_order.md b/docs/resources/security_ldap_order.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_security_ldap_order"
+subcategory: "Security"
 sidebar_current: "docs-nexus-resource-security_ldap_order"
 description: |-
   Use this resource to change the LDAP order.

diff --git a/docs/resources/security_realms.md b/docs/resources/security_realms.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_security_realms"
+subcategory: "Security"
 sidebar_current: "docs-nexus-resource-security_realms"
 description: |-
   Use this resource to activate Nexus Security LDAP and order

diff --git a/docs/resources/security_saml.md b/docs/resources/security_saml.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_security_saml"
+subcategory: "Security"
 sidebar_current: "docs-nexus-resource-security_saml"
 description: |-
   Use this resource to create a Nexus Security SAML

diff --git a/docs/resources/security_user.md b/docs/resources/security_user.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_security_user"
+subcategory: "Security"
 sidebar_current: "docs-nexus-resource-security_user"
 description: |-
   Use this resource to manage users

diff --git a/docs/resources/security_user_token.md b/docs/resources/security_user_token.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_security_user_token"
+subcategory: "Security"
 sidebar_current: "docs-nexus-resource-security_user_token"
 description: |-
   Use this resource to manage the global configuration for the user-tokens

diff --git a/docs/resources/user.md b/docs/resources/user.md
@@ -1,6 +1,7 @@
 ---
 layout: "nexus"
 page_title: "Nexus: nexus_user"
+subcategory: "Other"
 sidebar_current: "docs-nexus-resource-user"
 description: |-
   This data source is deprecated.

diff --git a/gendocs/main.go b/gendocs/main.go
@@ -171,6 +171,14 @@ func genDoc(dtype, fpath, name string, resource *schema.Resource) {
 		"description":       "",
 		"description_short": "",
 		"import":            "",
+		"subcategory":       "Other",
+	}
+
+	nameArray := strings.Split(name, "_")
+	if len(nameArray) > 2 {
+		if nameArray[1] != "content" {
+			data["subcategory"] = strings.Title(nameArray[1])
+		}
 	}
 
 	fname := fmt.Sprintf("%s_%s.go", dtype, data["resource"])

diff --git a/gendocs/template.go b/gendocs/template.go
@@ -4,6 +4,7 @@ const (
 	docTPL = `---
 layout: "{{.cloud_mark}}"
 page_title: "{{.cloud_title}}: {{.name}}"
+subcategory: "{{.subcategory}}"
 sidebar_current: "docs-{{.cloud_mark}}-{{.dtype}}-{{.resource}}"
 description: |-
   {{.description_short}}