From 351733c110a7b10ef890038ce8744e4e98f96f7e Mon Sep 17 00:00:00 2001 From: Christian Richter Date: Fri, 11 Mar 2022 11:06:47 +0100 Subject: [PATCH] Update template to render directly to docs includes directory Signed-off-by: Christian Richter --- docs/extensions/_includes/.gitignore | 1 + docs/extensions/accounts/configuration.md | 3 +++ docs/extensions/glauth/configuration.md | 3 +++ .../graph-explorer/configuration.md | 3 +++ docs/extensions/graph/configuration.md | 2 ++ docs/extensions/idm/configuration.md | 3 +++ docs/extensions/idp/configuration.md | 3 +++ docs/extensions/nats/configuration.md | 3 +++ .../extensions/notifications/configuration.md | 3 +++ docs/extensions/ocs/configuration.md | 3 +++ docs/extensions/proxy/configuration.md | 3 +++ docs/extensions/settings/configuration.md | 3 +++ docs/extensions/store/configuration.md | 3 +++ docs/extensions/thumbnails/configuration.md | 3 +++ docs/extensions/web/configuration.md | 3 +++ docs/extensions/webdav/configuration.md | 3 +++ docs/helpers/example-config-generator.go.tmpl | 20 ++++++++++++------- 17 files changed, 58 insertions(+), 7 deletions(-) diff --git a/docs/extensions/_includes/.gitignore b/docs/extensions/_includes/.gitignore index a463a88c5..3b7434f10 100644 --- a/docs/extensions/_includes/.gitignore +++ b/docs/extensions/_includes/.gitignore @@ -1 +1,2 @@ *_configvars.md +*-example.yaml \ No newline at end of file diff --git a/docs/extensions/accounts/configuration.md b/docs/extensions/accounts/configuration.md index 584b5b183..8fffa2559 100644 --- a/docs/extensions/accounts/configuration.md +++ b/docs/extensions/accounts/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/accounts-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/accounts_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/glauth/configuration.md b/docs/extensions/glauth/configuration.md index 7132fe0e5..e45a0c0aa 100644 --- a/docs/extensions/glauth/configuration.md +++ b/docs/extensions/glauth/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/glauth-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/glauth_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/graph-explorer/configuration.md b/docs/extensions/graph-explorer/configuration.md index c27fe2467..a88cabd2d 100644 --- a/docs/extensions/graph-explorer/configuration.md +++ b/docs/extensions/graph-explorer/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/graph-explorer-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/graph-explorer_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/graph/configuration.md b/docs/extensions/graph/configuration.md index 786dfb133..dbd212255 100644 --- a/docs/extensions/graph/configuration.md +++ b/docs/extensions/graph/configuration.md @@ -7,6 +7,8 @@ geekdocEditPath: edit/master/docs/extensions/graph geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config +{{< include file="extensions/_includes/graph-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/graph_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/idm/configuration.md b/docs/extensions/idm/configuration.md index 14200bcde..1595260c7 100644 --- a/docs/extensions/idm/configuration.md +++ b/docs/extensions/idm/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/idm-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/idm_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/idp/configuration.md b/docs/extensions/idp/configuration.md index bc6011eac..8aa88d203 100644 --- a/docs/extensions/idp/configuration.md +++ b/docs/extensions/idp/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/idp-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/idp_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/nats/configuration.md b/docs/extensions/nats/configuration.md index 20ba82f34..4d414c90d 100644 --- a/docs/extensions/nats/configuration.md +++ b/docs/extensions/nats/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/nats-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/nats_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/notifications/configuration.md b/docs/extensions/notifications/configuration.md index 7da0ba47b..7e260efbd 100644 --- a/docs/extensions/notifications/configuration.md +++ b/docs/extensions/notifications/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/notifications-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/notifications_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/ocs/configuration.md b/docs/extensions/ocs/configuration.md index 502fead64..af9bd28c4 100644 --- a/docs/extensions/ocs/configuration.md +++ b/docs/extensions/ocs/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/ocs-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/ocs_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/proxy/configuration.md b/docs/extensions/proxy/configuration.md index 785922489..e127a1015 100644 --- a/docs/extensions/proxy/configuration.md +++ b/docs/extensions/proxy/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/proxy-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/proxy_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/settings/configuration.md b/docs/extensions/settings/configuration.md index b20e913a7..ac61a7570 100644 --- a/docs/extensions/settings/configuration.md +++ b/docs/extensions/settings/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/settings-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/settings_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/store/configuration.md b/docs/extensions/store/configuration.md index a974e254a..d556218cf 100644 --- a/docs/extensions/store/configuration.md +++ b/docs/extensions/store/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/store-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/store_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/thumbnails/configuration.md b/docs/extensions/thumbnails/configuration.md index 7b6e85bde..1f10b1366 100644 --- a/docs/extensions/thumbnails/configuration.md +++ b/docs/extensions/thumbnails/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/thumbnails-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/thumbnails_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/web/configuration.md b/docs/extensions/web/configuration.md index d55237fd9..ee3e60d7d 100644 --- a/docs/extensions/web/configuration.md +++ b/docs/extensions/web/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/web-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/web_configvars.md" >}} \ No newline at end of file diff --git a/docs/extensions/webdav/configuration.md b/docs/extensions/webdav/configuration.md index 7ae4a0486..53c282001 100644 --- a/docs/extensions/webdav/configuration.md +++ b/docs/extensions/webdav/configuration.md @@ -8,5 +8,8 @@ geekdocFilePath: configuration.md geekdocCollapseSection: true --- +## Example YAML Config + +{{< include file="extensions/_includes/webdav-config-example.yaml" language="yaml" >}} {{< include file="extensions/_includes/webdav_configvars.md" >}} \ No newline at end of file diff --git a/docs/helpers/example-config-generator.go.tmpl b/docs/helpers/example-config-generator.go.tmpl index aa0bc029c..705a5e875 100644 --- a/docs/helpers/example-config-generator.go.tmpl +++ b/docs/helpers/example-config-generator.go.tmpl @@ -34,14 +34,20 @@ func main() { {{- end}} } for pkg, yml := range cfg { - targetFolder := filepath.Join("../../", pkg, "/config") - os.MkdirAll(targetFolder, 0700) - targetYamlFile, err := os.Create(filepath.Join(targetFolder, replacer.Replace(pkg) + "-config-example.yaml")) - if err != nil { - log.Fatalf("Failed to create target file for : %s", err) + targetFolders := []string{ + // TODO: comment in when it is clear how to commit this to the structure of the master|main branch + // filepath.Join("../../", pkg, "/config"), + "../../docs/extensions/_includes/", + } + for _, targetFolder := range targetFolders { + os.MkdirAll(targetFolder, 0700) + targetYamlFile, err := os.Create(filepath.Join(targetFolder, replacer.Replace(pkg) + "-config-example.yaml")) + if err != nil { + log.Fatalf("Failed to create target file for : %s", err) + } + defer targetYamlFile.Close() + targetYamlFile.WriteString(yml) } - defer targetYamlFile.Close() - targetYamlFile.WriteString(yml) } }