commit ea2a2b3

Merge: 67f727d 98b226c Author: Willy Kloucek <34452982+wkloucek@users.noreply.github.com> Date: Fri Dec 11 13:29:11 2020 +0100 Merge pull request #1046 from owncloud/enable_collapse_docs [docs-only] make menu lists collapsed
owncloud · Dec 11, 2020 · 2ef203c · 2ef203c
1 parent 9df5c8c
commit 2ef203c
Show file tree

Hide file tree

Showing 28 changed files with 370 additions and 355 deletions.
diff --git a/extensions/accounts/_index.md b/extensions/accounts/_index.md
@@ -5,6 +5,7 @@ weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/extensions/accounts
 geekdocFilePath: _index.md
+geekdocCollapseSection: true
 ---
 
 ## Abstract

diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-12-11T10:57:15+0000"
+date: "2020-12-11T12:29:35+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/accounts/templates
@@ -33,24 +33,6 @@ If you prefer to configure the service with environment variables you can see th
 
 If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
 
-### accounts update
-
-Make changes to an existing account
-
-Usage: `accounts update [command options] [arguments...]`
-
-### accounts list
-
-List existing accounts
-
-Usage: `accounts list [command options] [arguments...]`
-
---grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE  
-: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
-
---name | $ACCOUNTS_NAME  
-: service name. Default: `accounts`.
-
 ### accounts server
 
 Start ocis accounts service
@@ -123,11 +105,17 @@ Create a new account
 
 Usage: `accounts add [command options] [arguments...]`
 
-### accounts rebuildIndex
+### accounts list
 
-Rebuilds the service's index, i.e. deleting and then re-adding all existing documents
+List existing accounts
 
-Usage: `accounts rebuildIndex [command options] [arguments...]`
+Usage: `accounts list [command options] [arguments...]`
+
+--grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE  
+: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
+
+--name | $ACCOUNTS_NAME  
+: service name. Default: `accounts`.
 
 ### accounts ocis-accounts
 
@@ -144,35 +132,47 @@ Usage: `accounts ocis-accounts [command options] [arguments...]`
 --log-color | $ACCOUNTS_LOG_COLOR  
 : Enable colored logging. Default: `true`.
 
-### accounts inspect
+### accounts update
 
-Show detailed data on an existing account
+Make changes to an existing account
 
-Usage: `accounts inspect [command options] [arguments...]`
+Usage: `accounts update [command options] [arguments...]`
+
+### accounts remove
+
+Removes an existing account
+
+Usage: `accounts remove [command options] [arguments...]`
 
 --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE  
 : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
 
 --name | $ACCOUNTS_NAME  
 : service name. Default: `accounts`.
 
-### accounts version
+### accounts rebuildIndex
 
-Print the versions of the running instances
+Rebuilds the service's index, i.e. deleting and then re-adding all existing documents
 
-Usage: `accounts version [command options] [arguments...]`
+Usage: `accounts rebuildIndex [command options] [arguments...]`
+
+### accounts inspect
+
+Show detailed data on an existing account
+
+Usage: `accounts inspect [command options] [arguments...]`
 
 --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE  
 : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
 
 --name | $ACCOUNTS_NAME  
 : service name. Default: `accounts`.
 
-### accounts remove
+### accounts version
 
-Removes an existing account
+Print the versions of the running instances
 
-Usage: `accounts remove [command options] [arguments...]`
+Usage: `accounts version [command options] [arguments...]`
 
 --grpc-namespace | $ACCOUNTS_GRPC_NAMESPACE  
 : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.

diff --git a/extensions/glauth/_index.md b/extensions/glauth/_index.md
@@ -5,6 +5,7 @@ weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/extensions/glauth
 geekdocFilePath: _index.md
+geekdocCollapseSection: true
 ---
 
 This service provides a [glauth](https://github.com/glauth/glauth) based LDAP proxy for ocis which can be used by clients or other extensions. It allows applications relying on LDAP to access the accounts stored in the ocis accounts service. It can be used to make firewalls or identity providers aware of all users, including guest accounts.

diff --git a/extensions/glauth/configuration.md b/extensions/glauth/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-12-11T10:57:17+0000"
+date: "2020-12-11T12:29:39+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/glauth/templates

diff --git a/extensions/konnectd/_index.md b/extensions/konnectd/_index.md
@@ -4,6 +4,7 @@ weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/extensions/konnectd
 geekdocFilePath: _index.md
+geekdocCollapseSection: true
 ---
 
 This service provides an OpenID Connect provider which is the default way to authenticate in OCIS.
diff --git a/extensions/konnectd/configuration.md b/extensions/konnectd/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-12-11T10:57:19+0000"
+date: "2020-12-11T12:29:41+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/konnectd/templates
@@ -33,15 +33,6 @@ If you prefer to configure the service with environment variables you can see th
 
 If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
 
-### konnectd health
-
-Check health status
-
-Usage: `konnectd health [command options] [arguments...]`
-
---debug-addr | $KONNECTD_DEBUG_ADDR  
-: Address to debug endpoint. Default: `0.0.0.0:9134`.
-
 ### konnectd server
 
 Start integrated server
@@ -183,3 +174,12 @@ Usage: `konnectd version [command options] [arguments...]`
 --name | $KONNECTD_NAME  
 : Service name. Default: `konnectd`.
 
+### konnectd health
+
+Check health status
+
+Usage: `konnectd health [command options] [arguments...]`
+
+--debug-addr | $KONNECTD_DEBUG_ADDR  
+: Address to debug endpoint. Default: `0.0.0.0:9134`.
+
diff --git a/extensions/ocis-phoenix/_index.md b/extensions/ocis-phoenix/_index.md
@@ -5,6 +5,7 @@ weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/extensions/ocis-phoenix
 geekdocFilePath: _index.md
+geekdocCollapseSection: true
 ---
 
 Note: Work in progress to rename Phoenix to ownCloud Web.

diff --git a/extensions/ocis-phoenix/configuration.md b/extensions/ocis-phoenix/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-12-11T10:57:22+0000"
+date: "2020-12-11T12:29:45+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/phoenix/templates
@@ -33,6 +33,21 @@ If you prefer to configure the service with environment variables you can see th
 
 If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
 
+### phoenix ocis-phoenix
+
+Serve Phoenix for oCIS
+
+Usage: `phoenix ocis-phoenix [command options] [arguments...]`
+
+--log-level | $PHOENIX_LOG_LEVEL  
+: Set logging level. Default: `info`.
+
+--log-pretty | $PHOENIX_LOG_PRETTY  
+: Enable pretty logging. Default: `true`.
+
+--log-color | $PHOENIX_LOG_COLOR  
+: Enable colored logging. Default: `true`.
+
 ### phoenix health
 
 Check health status
@@ -117,18 +132,3 @@ Usage: `phoenix server [command options] [arguments...]`
 --oidc-scope | $PHOENIX_OIDC_SCOPE  
 : OpenID Connect scope. Default: `openid profile email`.
 
-### phoenix ocis-phoenix
-
-Serve Phoenix for oCIS
-
-Usage: `phoenix ocis-phoenix [command options] [arguments...]`
-
---log-level | $PHOENIX_LOG_LEVEL  
-: Set logging level. Default: `info`.
-
---log-pretty | $PHOENIX_LOG_PRETTY  
-: Enable pretty logging. Default: `true`.
-
---log-color | $PHOENIX_LOG_COLOR  
-: Enable colored logging. Default: `true`.
-
diff --git a/extensions/ocs/_index.md b/extensions/ocs/_index.md
@@ -5,6 +5,7 @@ weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/extensions/ocs
 geekdocFilePath: _index.md
+geekdocCollapseSection: true
 ---
 
 This service provides the OCS API which is required by some ownCloud clients.
diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-12-11T10:57:23+0000"
+date: "2020-12-11T12:29:48+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/ocs/templates

diff --git a/extensions/onlyoffice/_index.md b/extensions/onlyoffice/_index.md
@@ -5,6 +5,7 @@ weight: 10
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/extensions/onlyoffice
 geekdocFilePath: _index.md
+geekdocCollapseSection: true
 ---
 
 This service enables users open documents, spreadsheets and presentations in the OnlyOffice app installed in ownCloud 10.
diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-12-11T10:57:31+0000"
+date: "2020-12-11T12:29:58+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/onlyoffice/templates

diff --git a/extensions/proxy/_index.md b/extensions/proxy/_index.md
@@ -4,6 +4,7 @@ weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/extensions/proxy
 geekdocFilePath: _index.md
+geekdocCollapseSection: true
 ---
 
 This service provides a proxy service that routes requests to the correct extensions.
diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-12-11T10:57:24+0000"
+date: "2020-12-11T12:29:49+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/proxy/templates
@@ -33,33 +33,6 @@ If you prefer to configure the service with environment variables you can see th
 
 If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
 
-### proxy ocis-proxy
-
-proxy for Reva/oCIS
-
-Usage: `proxy ocis-proxy [command options] [arguments...]`
-
---log-level | $PROXY_LOG_LEVEL  
-: Set logging level. Default: `info`.
-
---log-pretty | $PROXY_LOG_PRETTY  
-: Enable pretty logging. Default: `true`.
-
---log-color | $PROXY_LOG_COLOR  
-: Enable colored logging. Default: `true`.
-
-### proxy version
-
-Print the versions of the running instances
-
-Usage: `proxy version [command options] [arguments...]`
-
---service-namespace | $PROXY_SERVICE_NAMESPACE  
-: Set the base namespace for the service namespace. Default: `com.owncloud.web`.
-
---service-name | $PROXY_SERVICE_NAME  
-: Service name. Default: `proxy`.
-
 ### proxy health
 
 Check health status
@@ -153,3 +126,30 @@ Usage: `proxy server [command options] [arguments...]`
 --enable-basic-auth | $PROXY_ENABLE_BASIC_AUTH  
 : enable basic authentication. Default: `false`.
 
+### proxy ocis-proxy
+
+proxy for Reva/oCIS
+
+Usage: `proxy ocis-proxy [command options] [arguments...]`
+
+--log-level | $PROXY_LOG_LEVEL  
+: Set logging level. Default: `info`.
+
+--log-pretty | $PROXY_LOG_PRETTY  
+: Enable pretty logging. Default: `true`.
+
+--log-color | $PROXY_LOG_COLOR  
+: Enable colored logging. Default: `true`.
+
+### proxy version
+
+Print the versions of the running instances
+
+Usage: `proxy version [command options] [arguments...]`
+
+--service-namespace | $PROXY_SERVICE_NAMESPACE  
+: Set the base namespace for the service namespace. Default: `com.owncloud.web`.
+
+--service-name | $PROXY_SERVICE_NAME  
+: Service name. Default: `proxy`.
+
diff --git a/extensions/settings/_index.md b/extensions/settings/_index.md
@@ -5,6 +5,7 @@ weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/docs/extensions/settings
 geekdocFilePath: _index.md
+geekdocCollapseSection: true
 ---
 
 ## Abstract

diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2020-12-11T10:57:25+0000"
+date: "2020-12-11T12:29:51+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/settings/templates
@@ -33,15 +33,6 @@ If you prefer to configure the service with environment variables you can see th
 
 If you prefer to configure the service with commandline flags you can see the available variables below. Command line flags are only working when calling the subcommand directly.
 
-### settings health
-
-Check health status
-
-Usage: `settings health [command options] [arguments...]`
-
---debug-addr | $SETTINGS_DEBUG_ADDR  
-: Address to debug endpoint. Default: `0.0.0.0:9194`.
-
 ### settings server
 
 Start integrated server
@@ -132,3 +123,12 @@ Usage: `settings version [command options] [arguments...]`
 --name | $SETTINGS_NAME  
 : service name. Default: `settings`.
 
+### settings health
+
+Check health status
+
+Usage: `settings health [command options] [arguments...]`
+
+--debug-addr | $SETTINGS_DEBUG_ADDR  
+: Address to debug endpoint. Default: `0.0.0.0:9194`.
+