From f9c9219bd63db5618fb9e5bebba834daaf3d51e0 Mon Sep 17 00:00:00 2001 From: Michael Barz Date: Fri, 6 Oct 2023 11:17:54 +0200 Subject: [PATCH] clean up docs --- docs/.gitignore | 1 - docs/helpers/extended_vars.yaml | 82 ++++++++++++++++++++++++++++ docs/services/auth-machine/_index.md | 16 ------ docs/services/ocdav/_index.md | 26 --------- docs/services/sse/_index.md | 16 ------ 5 files changed, 82 insertions(+), 59 deletions(-) create mode 100644 docs/helpers/extended_vars.yaml delete mode 100644 docs/services/auth-machine/_index.md delete mode 100755 docs/services/ocdav/_index.md delete mode 100644 docs/services/sse/_index.md diff --git a/docs/.gitignore b/docs/.gitignore index 73d0aef38c..d584946e13 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -2,5 +2,4 @@ hugo/ grpc_apis/ mutagen.yml.lock helpers/output/* -helpers/extended_vars.yaml services/**/_index.md diff --git a/docs/helpers/extended_vars.yaml b/docs/helpers/extended_vars.yaml new file mode 100644 index 0000000000..d30d070b6b --- /dev/null +++ b/docs/helpers/extended_vars.yaml @@ -0,0 +1,82 @@ +variables: +- rawname: CS3_GATEWAY + path: services/idp/pkg/backends/cs3/bootstrap/cs3.go:76 + foundincode: true + name: CS3_GATEWAY + type: "" + default_value: "" + description: "" + do_ignore: true +- rawname: CS3_MACHINE_AUTH_API_KEY + path: services/idp/pkg/backends/cs3/bootstrap/cs3.go:77 + foundincode: true + name: CS3_MACHINE_AUTH_API_KEY + type: "" + default_value: "" + description: "" + do_ignore: true +- rawname: MICRO_LOG_LEVEL + path: ocis-pkg/log/log.go:31 + foundincode: true + name: MICRO_LOG_LEVEL + type: string + default_value: Error + description: Set the log level for the internal go micro framework. Only change + on supervision of ownCloud Support. + do_ignore: false +- rawname: MICRO_LOG_LEVEL + path: ocis-pkg/log/log.go:35 + foundincode: true + name: MICRO_LOG_LEVEL + type: "" + default_value: "" + description: "" + do_ignore: true +- rawname: registryEnv + path: ocis-pkg/registry/registry.go:44 + foundincode: true + name: MICRO_REGISTRY + type: string + default_value: "" + description: 'Go micro registry type to use. Supported types are: ''nats'', ''kubernetes'', + ''etcd'', ''consul'', ''memory'' and ''mdns''. Will be selected automatically. Only change + on supervision of ownCloud Support.' + do_ignore: false +- rawname: registryAddressEnv + path: ocis-pkg/registry/registry.go:42 + foundincode: true + name: MICRO_REGISTRY_ADDRESS + type: string + default_value: "" + description: The bind address of the internal go micro framework. Only change on + supervision of ownCloud Support. + do_ignore: false +- rawname: OCIS_BASE_DATA_PATH + path: ocis-pkg/config/defaults/paths.go:23 + foundincode: true + name: OCIS_BASE_DATA_PATH + type: string + default_value: '''/var/lib/ocis'' or ''$HOME/.ocis/''' + description: The base directory location used by several services and for user data. + Predefined to '/var/lib/ocis' for container images (inside the container) or '$HOME/.ocis/' + for binary releases. Services can have, if available, an individual setting with + an own environment variable. + do_ignore: false +- rawname: OCIS_CONFIG_DIR + path: ocis-pkg/config/defaults/paths.go:56 + foundincode: true + name: OCIS_CONFIG_DIR + type: string + default_value: '''/etc/ocis'' or ''$HOME/.ocis/config''' + description: The default directory location for config files. Predefined to '/etc/ocis' + for container images (inside the container) or '$HOME/.ocis/config' for binary + releases. + do_ignore: false +- rawname: parts[0] + path: ocis-pkg/config/envdecode/envdecode.go:382 + foundincode: true + name: parts[0] + type: "" + default_value: "" + description: false positive - code that extract envvars for config structs + do_ignore: true diff --git a/docs/services/auth-machine/_index.md b/docs/services/auth-machine/_index.md deleted file mode 100644 index edb7c4afd2..0000000000 --- a/docs/services/auth-machine/_index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Auth-Machine -date: 2022-03-02T00:00:00+00:00 -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/services/auth-machine -geekdocFilePath: _index.md -geekdocCollapseSection: true ---- - -## Abstract - - -## Table of Contents - -{{< toc-tree >}} diff --git a/docs/services/ocdav/_index.md b/docs/services/ocdav/_index.md deleted file mode 100755 index 6e45233181..0000000000 --- a/docs/services/ocdav/_index.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: ocDAV -date: 2023-05-31T13:33:51.029749931+02:00 -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/services/ocdav -geekdocFilePath: README.md -geekdocCollapseSection: true ---- - - - -## Abstract - -The ocdav service provides the WebDAV API which is required by ownCloud clients. Previews (thumbnails) are provided by the [WebDAV service](../webdav). - - -## Table of Contents - -* [Example Yaml Config](#example-yaml-config) - -## Example Yaml Config -{{< include file="services/_includes/ocdav-config-example.yaml" language="yaml" >}} - -{{< include file="services/_includes/ocdav_configvars.md" >}} - diff --git a/docs/services/sse/_index.md b/docs/services/sse/_index.md deleted file mode 100644 index d839d16de5..0000000000 --- a/docs/services/sse/_index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: SSE -date: 2022-08-08T00:00:00+00:00 -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/services/sse -geekdocFilePath: _index.md -geekdocCollapseSection: true ---- - -## Abstract - - -## Table of Contents - -{{< toc-tree >}}