From 83b4bf9bcfeac774de1af74ce454e89ffddfacf4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Pablo=20Villaf=C3=A1=C3=B1ez?= Date: Thu, 20 Jan 2022 13:15:59 +0100 Subject: [PATCH] Remove old configuration templates --- accounts/templates/GRPC.tmpl | 75 ------------------------------ protogen/docs/CONFIGURATION.tmpl | 78 -------------------------------- settings/templates/GRPC.tmpl | 75 ------------------------------ store/templates/GRPC.tmpl | 75 ------------------------------ thumbnails/templates/GRPC.tmpl | 75 ------------------------------ 5 files changed, 378 deletions(-) delete mode 100644 accounts/templates/GRPC.tmpl delete mode 100644 protogen/docs/CONFIGURATION.tmpl delete mode 100644 settings/templates/GRPC.tmpl delete mode 100644 store/templates/GRPC.tmpl delete mode 100644 thumbnails/templates/GRPC.tmpl diff --git a/accounts/templates/GRPC.tmpl b/accounts/templates/GRPC.tmpl deleted file mode 100644 index 545ab202d..000000000 --- a/accounts/templates/GRPC.tmpl +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "GRPC API" -date: 2018-05-02T00:00:00+00:00 -weight: 50 -geekdocRepo: https://github.com/owncloud/ocis-thumbnails -geekdocEditPath: edit/master/docs -geekdocFilePath: grpc.md ---- - -{{`{{< toc >}}`}} - -{{ range .Files -}} -## {{ .Name }} - -{{ .Description }} -{{- range .Messages -}} -{{- /* remove newline */}}### {{ .LongName }} - -{{ .Description }} - -{{ if .HasFields -}} -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -{{ range .Fields -}} -| {{.Name}} | [{{.LongType}}](#{{.LongType | lower | replace "." "" }}) | {{.Label}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end }} | -{{ end -}} -{{ end }} -{{ if .HasExtensions -}} -| Extension | Type | Base | Number | Description | -| --------- | ---- | ---- | ------ | ----------- | -{{ range .Extensions -}} -| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | -{{ end -}} -{{ end -}} -{{ end -}} -{{- range .Enums -}} -### {{ .LongName }} - -{{ .Description }} - -| Name | Number | Description | -| ---- | ------ | ----------- | -{{range .Values -}} -| {{.Name}} | {{.Number}} | {{nobr .Description}} | -{{ end -}} -{{ end -}} - -{{ if .HasExtensions }} - -### File-level Extensions -| Extension | Type | Base | Number | Description | -| --------- | ---- | ---- | ------ | ----------- | -{{ range .Extensions -}} -| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} | -{{ end -}} -{{ end -}} -{{- range .Services }} -### {{ .Name }} - -{{ .Description }} - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -{{ range .Methods -}} -| {{.Name}} | [{{.RequestLongType}}](#{{.RequestLongType | lower | replace "." "" }}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseLongType | lower | replace "." "" }}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} | -{{ end -}} -{{ end -}} -{{ end }} -## Scalar Value Types - -| .proto Type | Notes | C++ | Java | -| ----------- | ----- | --- | ---- | -{{ range .Scalars -}} -| {{`{{< div id="`}}{{.ProtoType}}{{`" content="`}}{{.ProtoType}}{{`" >}}`}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | -{{ end }} \ No newline at end of file diff --git a/protogen/docs/CONFIGURATION.tmpl b/protogen/docs/CONFIGURATION.tmpl deleted file mode 100644 index c180d7a56..000000000 --- a/protogen/docs/CONFIGURATION.tmpl +++ /dev/null @@ -1,78 +0,0 @@ ---- -title: "Configuration" -date: "{{ date "2006-01-02T15:04:05-0700" now }}" -weight: 20 -geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/accounts/templates -geekdocFilePath: CONFIGURATION.tmpl ---- -{{- define "options"}} -{{ $fnNames := (last . ).Flags -}} -{{ range $opt := first . }} -{{ range $fnName := $fnNames }}{{ with list $fnName $opt -}} -{{ $o := last . -}} -{{ if eq $o.FnName $fnName -}} --{{ $o.Name }} | {{ range $i, $e := $o.Env }} {{ if $i }}, {{ end }}${{ $e }}{{ end }} -: {{ $o.Usage }}. {{- if $o.Default }} Default: `{{ $o.Default }}`.{{ end }} - -{{ end -}} -{{ end -}} -{{ end -}} -{{ end -}} -{{ end }} - -{{`{{< toc >}}`}} - -## Configuration - -### Configuration using config files - -Out of the box extensions will attempt to read configuration details from: - -```console -/etc/ocis -$HOME/.ocis -./config -``` - -For this configuration to be picked up, have a look at your extension `root` command and look for which default config name it has assigned. *i.e: ocis-accounts reads `accounts.json | yaml | toml ...`*. - -So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis/tree/master/accounts/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/ocis.yml`, `${HOME}/.ocis/ocis.yml` or `$(pwd)/config/ocis.yml`. - -### Environment variables - -If you prefer to configure the service with environment variables you can see the available variables below. - -If multiple variables are listed for one option, they are in order of precedence. This means the leftmost variable will always win if given. - -### Command-line flags - -If you prefer to configure the service with command-line flags you can see the available variables below. Command line flags are only working when calling the subcommand directly. - -{{ $options := .Options -}} -{{ range $com := .Commands }}{{ with (list $options $com) -}} -{{ $c := last . -}} -{{ if eq $c.Name "accounts" -}} -## Root Command - -{{ $c.Usage }} - -Usage: `accounts [global options] command [command options] [arguments...]` -{{ template "options" . -}} -## Sub Commands - -{{ end -}} -{{ end -}} -{{ end -}} -{{- range $com := .Commands }}{{ with (list $options $com) -}} -{{- $c := last . }} -{{- if ne $c.Name "accounts" -}} -### accounts {{ $c.Name }} - -{{ $c.Usage }} - -Usage: `accounts {{ $c.Name }} [command options] [arguments...]` -{{ template "options" . }} -{{- end -}} -{{- end -}} -{{- end -}} diff --git a/settings/templates/GRPC.tmpl b/settings/templates/GRPC.tmpl deleted file mode 100644 index 545ab202d..000000000 --- a/settings/templates/GRPC.tmpl +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "GRPC API" -date: 2018-05-02T00:00:00+00:00 -weight: 50 -geekdocRepo: https://github.com/owncloud/ocis-thumbnails -geekdocEditPath: edit/master/docs -geekdocFilePath: grpc.md ---- - -{{`{{< toc >}}`}} - -{{ range .Files -}} -## {{ .Name }} - -{{ .Description }} -{{- range .Messages -}} -{{- /* remove newline */}}### {{ .LongName }} - -{{ .Description }} - -{{ if .HasFields -}} -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -{{ range .Fields -}} -| {{.Name}} | [{{.LongType}}](#{{.LongType | lower | replace "." "" }}) | {{.Label}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end }} | -{{ end -}} -{{ end }} -{{ if .HasExtensions -}} -| Extension | Type | Base | Number | Description | -| --------- | ---- | ---- | ------ | ----------- | -{{ range .Extensions -}} -| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | -{{ end -}} -{{ end -}} -{{ end -}} -{{- range .Enums -}} -### {{ .LongName }} - -{{ .Description }} - -| Name | Number | Description | -| ---- | ------ | ----------- | -{{range .Values -}} -| {{.Name}} | {{.Number}} | {{nobr .Description}} | -{{ end -}} -{{ end -}} - -{{ if .HasExtensions }} - -### File-level Extensions -| Extension | Type | Base | Number | Description | -| --------- | ---- | ---- | ------ | ----------- | -{{ range .Extensions -}} -| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} | -{{ end -}} -{{ end -}} -{{- range .Services }} -### {{ .Name }} - -{{ .Description }} - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -{{ range .Methods -}} -| {{.Name}} | [{{.RequestLongType}}](#{{.RequestLongType | lower | replace "." "" }}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseLongType | lower | replace "." "" }}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} | -{{ end -}} -{{ end -}} -{{ end }} -## Scalar Value Types - -| .proto Type | Notes | C++ | Java | -| ----------- | ----- | --- | ---- | -{{ range .Scalars -}} -| {{`{{< div id="`}}{{.ProtoType}}{{`" content="`}}{{.ProtoType}}{{`" >}}`}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | -{{ end }} \ No newline at end of file diff --git a/store/templates/GRPC.tmpl b/store/templates/GRPC.tmpl deleted file mode 100644 index 545ab202d..000000000 --- a/store/templates/GRPC.tmpl +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "GRPC API" -date: 2018-05-02T00:00:00+00:00 -weight: 50 -geekdocRepo: https://github.com/owncloud/ocis-thumbnails -geekdocEditPath: edit/master/docs -geekdocFilePath: grpc.md ---- - -{{`{{< toc >}}`}} - -{{ range .Files -}} -## {{ .Name }} - -{{ .Description }} -{{- range .Messages -}} -{{- /* remove newline */}}### {{ .LongName }} - -{{ .Description }} - -{{ if .HasFields -}} -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -{{ range .Fields -}} -| {{.Name}} | [{{.LongType}}](#{{.LongType | lower | replace "." "" }}) | {{.Label}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end }} | -{{ end -}} -{{ end }} -{{ if .HasExtensions -}} -| Extension | Type | Base | Number | Description | -| --------- | ---- | ---- | ------ | ----------- | -{{ range .Extensions -}} -| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | -{{ end -}} -{{ end -}} -{{ end -}} -{{- range .Enums -}} -### {{ .LongName }} - -{{ .Description }} - -| Name | Number | Description | -| ---- | ------ | ----------- | -{{range .Values -}} -| {{.Name}} | {{.Number}} | {{nobr .Description}} | -{{ end -}} -{{ end -}} - -{{ if .HasExtensions }} - -### File-level Extensions -| Extension | Type | Base | Number | Description | -| --------- | ---- | ---- | ------ | ----------- | -{{ range .Extensions -}} -| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} | -{{ end -}} -{{ end -}} -{{- range .Services }} -### {{ .Name }} - -{{ .Description }} - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -{{ range .Methods -}} -| {{.Name}} | [{{.RequestLongType}}](#{{.RequestLongType | lower | replace "." "" }}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseLongType | lower | replace "." "" }}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} | -{{ end -}} -{{ end -}} -{{ end }} -## Scalar Value Types - -| .proto Type | Notes | C++ | Java | -| ----------- | ----- | --- | ---- | -{{ range .Scalars -}} -| {{`{{< div id="`}}{{.ProtoType}}{{`" content="`}}{{.ProtoType}}{{`" >}}`}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | -{{ end }} \ No newline at end of file diff --git a/thumbnails/templates/GRPC.tmpl b/thumbnails/templates/GRPC.tmpl deleted file mode 100644 index 545ab202d..000000000 --- a/thumbnails/templates/GRPC.tmpl +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "GRPC API" -date: 2018-05-02T00:00:00+00:00 -weight: 50 -geekdocRepo: https://github.com/owncloud/ocis-thumbnails -geekdocEditPath: edit/master/docs -geekdocFilePath: grpc.md ---- - -{{`{{< toc >}}`}} - -{{ range .Files -}} -## {{ .Name }} - -{{ .Description }} -{{- range .Messages -}} -{{- /* remove newline */}}### {{ .LongName }} - -{{ .Description }} - -{{ if .HasFields -}} -| Field | Type | Label | Description | -| ----- | ---- | ----- | ----------- | -{{ range .Fields -}} -| {{.Name}} | [{{.LongType}}](#{{.LongType | lower | replace "." "" }}) | {{.Label}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end }} | -{{ end -}} -{{ end }} -{{ if .HasExtensions -}} -| Extension | Type | Base | Number | Description | -| --------- | ---- | ---- | ------ | ----------- | -{{ range .Extensions -}} -| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | -{{ end -}} -{{ end -}} -{{ end -}} -{{- range .Enums -}} -### {{ .LongName }} - -{{ .Description }} - -| Name | Number | Description | -| ---- | ------ | ----------- | -{{range .Values -}} -| {{.Name}} | {{.Number}} | {{nobr .Description}} | -{{ end -}} -{{ end -}} - -{{ if .HasExtensions }} - -### File-level Extensions -| Extension | Type | Base | Number | Description | -| --------- | ---- | ---- | ------ | ----------- | -{{ range .Extensions -}} -| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} | -{{ end -}} -{{ end -}} -{{- range .Services }} -### {{ .Name }} - -{{ .Description }} - -| Method Name | Request Type | Response Type | Description | -| ----------- | ------------ | ------------- | ------------| -{{ range .Methods -}} -| {{.Name}} | [{{.RequestLongType}}](#{{.RequestLongType | lower | replace "." "" }}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}](#{{.ResponseLongType | lower | replace "." "" }}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} | -{{ end -}} -{{ end -}} -{{ end }} -## Scalar Value Types - -| .proto Type | Notes | C++ | Java | -| ----------- | ----- | --- | ---- | -{{ range .Scalars -}} -| {{`{{< div id="`}}{{.ProtoType}}{{`" content="`}}{{.ProtoType}}{{`" >}}`}} | {{.Notes}} | {{.CppType}} | {{.JavaType}} | -{{ end }} \ No newline at end of file