Skip to content

Commit a5398cf

Browse files
authored
Merge pull request #511 from oliverpei/master
Optimize document directory
2 parents 16d2c14 + 722b980 commit a5398cf

File tree

239 files changed

+258
-13
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

239 files changed

+258
-13
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions

gendoc/main.go

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -40,22 +40,24 @@ func main() {
4040
filePath := filepath.Dir(filename)
4141
message("generating doc from: %s\n", filePath)
4242

43-
// document for DataSources
44-
for k, v := range provider.DataSourcesMap {
45-
genDoc("data_source", filePath, k, v)
46-
}
43+
// document for Index
44+
products := genIdx(filePath)
4745

48-
// document for Resources
49-
for k, v := range provider.ResourcesMap {
50-
genDoc("resource", filePath, k, v)
51-
}
46+
for _, product := range products {
47+
// document for DataSources
48+
for _, dataSource := range product.DataSources {
49+
genDoc(product.Name, "data_source", filePath, dataSource, provider.DataSourcesMap[dataSource])
50+
}
5251

53-
// document for Index
54-
genIdx(filePath)
52+
// document for Resources
53+
for _, resource := range product.Resources {
54+
genDoc(product.Name, "resource", filePath, resource, provider.ResourcesMap[resource])
55+
}
56+
}
5557
}
5658

5759
// genIdx generating index for resource
58-
func genIdx(filePath string) {
60+
func genIdx(filePath string) (prods []Product) {
5961
filename := "provider.go"
6062

6163
message("[START]get description from file: %s\n", filename)
@@ -81,7 +83,7 @@ func genIdx(filePath string) {
8183
doc := strings.TrimSpace(description[pos+16:])
8284
// description = strings.TrimSpace(description[:pos])
8385

84-
prods, err := GetIndex(doc)
86+
prods, err = GetIndex(doc)
8587
if err != nil {
8688
message("[FAIL!]: %s", err)
8789
os.Exit(1)
@@ -111,11 +113,13 @@ func genIdx(filePath string) {
111113
}
112114

113115
message("[SUCC.]write doc to file success: %s", filename)
116+
return
114117
}
115118

116119
// genDoc generating doc for data source and resource
117-
func genDoc(dtype, fpath, name string, resource *schema.Resource) {
120+
func genDoc(product, dtype, fpath, name string, resource *schema.Resource) {
118121
data := map[string]string{
122+
"product": product,
119123
"name": name,
120124
"dtype": strings.Replace(dtype, "_", "", -1),
121125
"resource": name[len(cloudMark)+1:],

gendoc/template.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package main
22

33
const (
44
docTPL = `---
5+
subcategory: "{{.product}}"
56
layout: "{{.cloud_mark}}"
67
page_title: "{{.cloud_title}}: {{.name}}"
78
sidebar_current: "docs-{{.cloud_mark}}-{{.dtype}}-{{.resource}}"

website/docs/d/as_scaling_configs.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/as_scaling_groups.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/as_scaling_policies.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/availability_regions.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/availability_zones.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cam_group_memberships.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cam_group_policy_attachments.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cam_groups.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cam_policies.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cam_role_policy_attachments.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cam_roles.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cam_saml_providers.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cam_user_policy_attachments.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cam_users.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cbs_snapshot_policies.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cbs_snapshots.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cbs_storages.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/ccn_bandwidth_limits.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/ccn_instances.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cdn_domains.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cfs_access_groups.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cfs_access_rules.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cfs_file_systems.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/ckafka_acls.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/ckafka_topics.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/ckafka_users.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/clb_attachments.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/clb_instances.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/clb_listener_rules.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/clb_listeners.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/clb_redirections.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/container_cluster_instances.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/container_clusters.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cos_bucket_object.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/cos_buckets.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dayu_cc_http_policies.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dayu_cc_https_policies.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dayu_ddos_policies.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dayu_ddos_policy_attachments.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dayu_ddos_policy_cases.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dayu_l4_rules.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dayu_l7_rules.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dc_gateway_ccn_routes.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dc_gateway_instances.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dc_instances.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dcx_instances.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/dnats.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/eip.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/eips.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/elasticsearch_instances.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/enis.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/gaap_certificates.html.markdown

Lines changed: 1 addition & 0 deletions

website/docs/d/gaap_domain_error_pages.html.markdown

Lines changed: 1 addition & 0 deletions

0 commit comments

Comments
 (0)