commit 74c883b

Merge: ebc51c6 977f590 Author: Phil Davis <[email protected]> Date: Thu Feb 18 14:35:37 2021 +0300 Merge pull request #1679 from owncloud/add_breaking_changes_changelog [docs-only] add breaking changes and migration
owncloud · Feb 18, 2021 · d4aba71 · d4aba71
1 parent 345377b
commit d4aba71
Show file tree

Hide file tree

Showing 16 changed files with 425 additions and 384 deletions.
diff --git a/extensions/accounts/configuration.md b/extensions/accounts/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2021-02-18T08:57:14+0000"
+date: "2021-02-18T11:35:59+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/accounts/templates
@@ -35,6 +35,12 @@ If multiple variables are listed for one option, they are in order of precedence
 
 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 add
+
+Create a new account
+
+Usage: `accounts add [command options] [arguments...]`
+
 ### accounts list
 
 List existing accounts
@@ -113,29 +119,35 @@ Usage: `accounts server [command options] [arguments...]`
 -service-user-username |  $ACCOUNTS_SERVICE_USER_USERNAME
 : username of the internal service user (required on EOS).
 
-### accounts version
+### accounts update
 
-Print the versions of the running instances
+Make changes to an existing account
 
-Usage: `accounts version [command options] [arguments...]`
+Usage: `accounts update [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 add
+### accounts rebuildIndex
 
-Create a new account
+Rebuilds the service's index, i.e. deleting and then re-adding all existing documents
 
-Usage: `accounts add [command options] [arguments...]`
+Usage: `accounts rebuildIndex [command options] [arguments...]`
 
-### accounts inspect
+### accounts remove
 
-Show detailed data on an existing account
+Removes an existing account
 
-Usage: `accounts inspect [command options] [arguments...]`
+Usage: `accounts remove [command options] [arguments...]`
 
 -grpc-namespace |  $ACCOUNTS_GRPC_NAMESPACE
 : Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
@@ -158,23 +170,11 @@ Usage: `accounts ocis-accounts [command options] [arguments...]`
 -log-color |  $ACCOUNTS_LOG_COLOR
 : Enable colored logging. Default: `true`.
 
-### accounts update
-
-Make changes to an existing account
-
-Usage: `accounts update [command options] [arguments...]`
-
-### accounts rebuildIndex
-
-Rebuilds the service's index, i.e. deleting and then re-adding all existing documents
-
-Usage: `accounts rebuildIndex [command options] [arguments...]`
-
-### 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/configuration.md b/extensions/glauth/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2021-02-18T08:58:29+0000"
+date: "2021-02-18T11:37:09+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/glauth/templates

diff --git a/extensions/graph-explorer/configuration.md b/extensions/graph-explorer/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2021-02-18T08:58:30+0000"
+date: "2021-02-18T11:37:11+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/graph-explorer/templates
@@ -52,15 +52,6 @@ Usage: `graph-explorer [global options] command [command options] [arguments...]
 
 ## Sub Commands
 
-### graph-explorer health
-
-Check health status
-
-Usage: `graph-explorer health [command options] [arguments...]`
-
--debug-addr |  $GRAPH_EXPLORER_DEBUG_ADDR
-: Address to debug endpoint. Default: `0.0.0.0:9136`.
-
 ### graph-explorer server
 
 Start integrated server
@@ -112,3 +103,12 @@ Usage: `graph-explorer server [command options] [arguments...]`
 -graph-url |  $GRAPH_EXPLORER_GRAPH_URL
 : Set the url to the graph api service. Default: `http://localhost:9120`.
 
+### graph-explorer health
+
+Check health status
+
+Usage: `graph-explorer health [command options] [arguments...]`
+
+-debug-addr |  $GRAPH_EXPLORER_DEBUG_ADDR
+: Address to debug endpoint. Default: `0.0.0.0:9136`.
+
diff --git a/extensions/graph/configuration.md b/extensions/graph/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2021-02-18T08:58:31+0000"
+date: "2021-02-18T11:37:12+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/graph/templates
@@ -55,15 +55,6 @@ Usage: `graph [global options] command [command options] [arguments...]`
 
 ## Sub Commands
 
-### graph health
-
-Check health status
-
-Usage: `graph health [command options] [arguments...]`
-
--debug-addr |  $GRAPH_DEBUG_ADDR
-: Address to debug endpoint. Default: `0.0.0.0:9124`.
-
 ### graph server
 
 Start integrated server
@@ -136,3 +127,12 @@ Usage: `graph server [command options] [arguments...]`
 -reva-gateway-addr |  $REVA_GATEWAY_ADDR
 : REVA Gateway Endpoint. Default: `127.0.0.1:9142`.
 
+### graph health
+
+Check health status
+
+Usage: `graph health [command options] [arguments...]`
+
+-debug-addr |  $GRAPH_DEBUG_ADDR
+: Address to debug endpoint. Default: `0.0.0.0:9124`.
+
diff --git a/extensions/idp/configuration.md b/extensions/idp/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2021-02-18T08:58:32+0000"
+date: "2021-02-18T11:37:13+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/idp/templates
@@ -35,18 +35,6 @@ If multiple variables are listed for one option, they are in order of precedence
 
 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.
 
-### idp version
-
-Print the versions of the running instances
-
-Usage: `idp version [command options] [arguments...]`
-
--http-namespace |  $IDP_HTTP_NAMESPACE
-: Set the base namespace for service discovery. Default: `com.owncloud.web`.
-
--name |  $IDP_NAME
-: Service name. Default: `idp`.
-
 ### idp health
 
 Check health status
@@ -218,3 +206,15 @@ Usage: `idp server [command options] [arguments...]`
 -disable-identifier-webapp |  $IDP_DISABLE_IDENTIFIER_WEBAPP
 : Disable built-in identifier-webapp to use a frontend hosted elsewhere.. Default: `true`.
 
+### idp version
+
+Print the versions of the running instances
+
+Usage: `idp version [command options] [arguments...]`
+
+-http-namespace |  $IDP_HTTP_NAMESPACE
+: Set the base namespace for service discovery. Default: `com.owncloud.web`.
+
+-name |  $IDP_NAME
+: Service name. Default: `idp`.
+
diff --git a/extensions/ocs/configuration.md b/extensions/ocs/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2021-02-18T08:58:34+0000"
+date: "2021-02-18T11:37:16+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/ocs/templates
@@ -35,6 +35,15 @@ If multiple variables are listed for one option, they are in order of precedence
 
 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.
 
+### ocs health
+
+Check health status
+
+Usage: `ocs health [command options] [arguments...]`
+
+-debug-addr |  $OCS_DEBUG_ADDR
+: Address to debug endpoint. Default: `0.0.0.0:9114`.
+
 ### ocs ocis-ocs
 
 Serve OCS API for oCIS
@@ -113,12 +122,3 @@ Usage: `ocs version [command options] [arguments...]`
 -name |  $OCS_NAME
 : Service name. Default: `ocs`.
 
-### ocs health
-
-Check health status
-
-Usage: `ocs health [command options] [arguments...]`
-
--debug-addr |  $OCS_DEBUG_ADDR
-: Address to debug endpoint. Default: `0.0.0.0:9114`.
-
diff --git a/extensions/onlyoffice/configuration.md b/extensions/onlyoffice/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2021-02-18T08:58:34+0000"
+date: "2021-02-18T11:37:17+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/onlyoffice/templates

diff --git a/extensions/proxy/configuration.md b/extensions/proxy/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2021-02-18T08:58:35+0000"
+date: "2021-02-18T11:37:18+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/proxy/templates
@@ -35,6 +35,30 @@ If multiple variables are listed for one option, they are in order of precedence
 
 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 health
+
+Check health status
+
+Usage: `proxy health [command options] [arguments...]`
+
+--debug-addr |  $PROXY_DEBUG_ADDR
+: Address to debug endpoint. Default: `0.0.0.0:9109`.
+
+### proxy ocis-proxy
+
+proxy for 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 server
 
 Start integrated server
@@ -134,27 +158,3 @@ Usage: `proxy version [command options] [arguments...]`
 --service-name |  $PROXY_SERVICE_NAME
 : Service name. Default: `proxy`.
 
-### proxy health
-
-Check health status
-
-Usage: `proxy health [command options] [arguments...]`
-
---debug-addr |  $PROXY_DEBUG_ADDR
-: Address to debug endpoint. Default: `0.0.0.0:9109`.
-
-### proxy ocis-proxy
-
-proxy for 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`.
-
diff --git a/extensions/settings/configuration.md b/extensions/settings/configuration.md
@@ -1,6 +1,6 @@
 ---
 title: "Configuration"
-date: "2021-02-18T08:58:36+0000"
+date: "2021-02-18T11:37:18+0000"
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
 geekdocEditPath: edit/master/settings/templates
@@ -35,6 +35,18 @@ If multiple variables are listed for one option, they are in order of precedence
 
 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 version
+
+Print the versions of the running instances
+
+Usage: `settings version [command options] [arguments...]`
+
+-grpc-namespace |  $SETTINGS_GRPC_NAMESPACE
+: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
+
+-name |  $SETTINGS_NAME
+: service name. Default: `settings`.
+
 ### settings health
 
 Check health status
@@ -122,15 +134,3 @@ Usage: `settings server [command options] [arguments...]`
 -jwt-secret |  $SETTINGS_JWT_SECRET , $OCIS_JWT_SECRET
 : Used to create JWT to talk to reva, should equal reva's jwt-secret. Default: `Pive-Fumkiu4`.
 
-### settings version
-
-Print the versions of the running instances
-
-Usage: `settings version [command options] [arguments...]`
-
--grpc-namespace |  $SETTINGS_GRPC_NAMESPACE
-: Set the base namespace for the grpc namespace. Default: `com.owncloud.api`.
-
--name |  $SETTINGS_NAME
-: service name. Default: `settings`.
-