update doc templates

Signed-off-by: Christian Richter <crichter@owncloud.com>
owncloud · Jun 21, 2022 · f781859 · f781859
1 parent 774e033
commit f781859
Show file tree

Hide file tree

Showing 76 changed files with 138 additions and 138 deletions.
diff --git a/docs/ocis/deployment/ocis_individual_services.md b/docs/ocis/deployment/ocis_individual_services.md
@@ -19,7 +19,7 @@ geekdocFilePath: ocis_individual_services.md
 
 The docker stack consists of at least 24 containers. One of them is Traefik, a proxy which is terminating ssl and forwards the requests to oCIS in the internal docker network.
 
-The other containers are oCIS extensions, running each one in a separate container. In this example, oCIS uses its internal IDP [LibreGraph Connect]({{< ref "../../extensions/idp" >}}) and the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}}). You also can start more than one container of each service by setting `OCIS_SCALE` to a number greater than 1. Currently this won't scale all services, but we are working on making all service easily scalable.
+The other containers are oCIS services, running each one in a separate container. In this example, oCIS uses its internal IDP [LibreGraph Connect]({{< ref "../../services/idp" >}}) and the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}}). You also can start more than one container of each service by setting `OCIS_SCALE` to a number greater than 1. Currently this won't scale all services, but we are working on making all service easily scalable.
 
 ## Server Deployment
 
@@ -76,7 +76,7 @@ See also [example server setup]({{< ref "preparing_server" >}})
  STORAGE_TRANSFER_SECRET=
  # Machine auth api key secret. Must be changed in order to have a secure oCIS. Defaults to "change-me-please"
  OCIS_MACHINE_AUTH_API_KEY=
- # Number of services to run for extensions, that currently can be easily scaled. Defaults to 1.
+ # Number of services to run for services, that currently can be easily scaled. Defaults to 1.
  OCIS_SCALE=
  ```
 

diff --git a/docs/ocis/deployment/ocis_keycloak.md b/docs/ocis/deployment/ocis_keycloak.md
@@ -20,9 +20,9 @@ geekdocFilePath: ocis_keycloak.md
 The docker stack consists 4 containers. One of them is Traefik, a proxy which is terminating ssl and forwards the requests to oCIS in the internal docker network. It
 is also responsible for redirecting requests on the OIDC discovery endpoints (e.g. `.well-known/openid-configuration`) to the correct destination in Keycloak.
 
-Keycloak add two containers: Keycloak itself and a PostgreSQL as database. Keycloak will be configured as oCIS' IDP instead of the internal IDP [LibreGraph Connect]({{< ref "../../extensions/idp" >}})
+Keycloak add two containers: Keycloak itself and a PostgreSQL as database. Keycloak will be configured as oCIS' IDP instead of the internal IDP [LibreGraph Connect]({{< ref "../../services/idp" >}})
 
-The other container is oCIS itself, running all extensions in one container. In this example oCIS uses the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}})
+The other container is oCIS itself, running all services in one container. In this example oCIS uses the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}})
 
 ## Server Deployment
 

diff --git a/docs/ocis/deployment/ocis_traefik.md b/docs/ocis/deployment/ocis_traefik.md
@@ -18,7 +18,7 @@ geekdocFilePath: ocis_traefik.md
 
 The docker stack consists of two containers. One of them is Traefik, a proxy which is terminating ssl and forwards the requests to oCIS in the internal docker network.
 
-The other one is oCIS itself running all extensions in one container. In this example, oCIS uses its internal IDP [LibreGraph Connect]({{< ref "../../extensions/idp" >}}) and the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}})
+The other one is oCIS itself running all extensions in one container. In this example, oCIS uses its internal IDP [LibreGraph Connect]({{< ref "../../services/idp" >}}) and the [oCIS storage driver]({{< ref "../storage/storagedrivers" >}})
 
 ## Server Deployment
 

diff --git a/docs/ocis/development/extensions.md b/docs/ocis/development/extensions.md
@@ -46,7 +46,7 @@ For a consistent look and feel, ownCloud Web uses an external design library, th
 
 ### Settings
 
-An extension likely has some behaviour which the user can configure. Fundamental configuration will often be done by administrators during deployment, via configuration files or by setting environment variables. But for other settings, which are supposed to change more often or which are even user specific, this is not a viable way. Therefore you need to offer the users a UI where they can configure your extension to their liking. Because implementing something like this is a repetitive task among extensions, oCIS already offers the settings extensions which does that for your extension. Your extension just needs to register settings bundles, respective permissions and finally read the current values from the settings service. You can read more on that on the [settings extension]({{< ref "../../extensions/settings" >}}) and see how [oCIS Hello uses these settings](https://owncloud.dev/extensions/ocis_hello/settings/).
+An extension likely has some behaviour which the user can configure. Fundamental configuration will often be done by administrators during deployment, via configuration files or by setting environment variables. But for other settings, which are supposed to change more often or which are even user specific, this is not a viable way. Therefore you need to offer the users a UI where they can configure your extension to their liking. Because implementing something like this is a repetitive task among extensions, oCIS already offers the settings extensions which does that for your extension. Your extension just needs to register settings bundles, respective permissions and finally read the current values from the settings service. You can read more on that on the [settings extension]({{< ref "../../services/settings" >}}) and see how [oCIS Hello uses these settings](https://owncloud.dev/extensions/ocis_hello/settings/).
 
 ### Proxy
 

diff --git a/docs/services/app-provider/_index.md b/docs/services/app-provider/_index.md
@@ -3,7 +3,7 @@ title: App-Provider
 date: 2022-03-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/app-provider
+geekdocEditPath: edit/master/docs/services/app-provider
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---

diff --git a/docs/services/app-provider/configuration.md b/docs/services/app-provider/configuration.md
@@ -3,13 +3,13 @@ title: Service Configuration
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/app-provider
+geekdocEditPath: edit/master/docs/services/app-provider
 geekdocFilePath: configuration.md
 geekdocCollapseSection: true
 ---
 
 ## Example YAML Config
 
-{{< include file="extensions/_includes/app-provider-config-example.yaml" language="yaml" >}}
+{{< include file="services/_includes/app-provider-config-example.yaml" language="yaml" >}}
 
-{{< include file="extensions/_includes/app-provider_configvars.md" >}}
+{{< include file="services/_includes/app-provider_configvars.md" >}}
diff --git a/docs/services/app-registry/_index.md b/docs/services/app-registry/_index.md
@@ -3,7 +3,7 @@ title: App-Registry
 date: 2022-03-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/app-registry
+geekdocEditPath: edit/master/docs/services/app-registry
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---

diff --git a/docs/services/app-registry/apps.md b/docs/services/app-registry/apps.md
@@ -3,7 +3,7 @@ title: "Apps"
 date: 2018-05-02T00:00:00+00:00
 weight: 10
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/app-registry
+geekdocEditPath: edit/master/docs/services/app-registry
 geekdocFilePath: apps.md
 ---
 

diff --git a/docs/services/app-registry/configuration.md b/docs/services/app-registry/configuration.md
@@ -3,13 +3,13 @@ title: Service Configuration
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/app-registry
+geekdocEditPath: edit/master/docs/services/app-registry
 geekdocFilePath: configuration.md
 geekdocCollapseSection: true
 ---
 
 ## Example YAML Config
 
-{{< include file="extensions/_includes/app-registry-config-example.yaml" language="yaml" >}}
+{{< include file="services/_includes/app-registry-config-example.yaml" language="yaml" >}}
 
-{{< include file="extensions/_includes/app-registry_configvars.md" >}}
+{{< include file="services/_includes/app-registry_configvars.md" >}}
diff --git a/docs/services/audit/_index.md b/docs/services/audit/_index.md
@@ -3,7 +3,7 @@ title: Audit
 date: 2022-03-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/audit
+geekdocEditPath: edit/master/docs/services/audit
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---

diff --git a/docs/services/audit/configuration.md b/docs/services/audit/configuration.md
@@ -3,14 +3,14 @@ title: Service Configuration
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/audit
+geekdocEditPath: edit/master/docs/services/audit
 geekdocFilePath: configuration.md
 geekdocCollapseSection: true
 ---
 
 
 ## Example YAML Config
 
-{{< include file="extensions/_includes/audit-config-example.yaml" language="yaml" >}}
+{{< include file="services/_includes/audit-config-example.yaml" language="yaml" >}}
 
-{{< include file="extensions/_includes/audit_configvars.md" >}}
+{{< include file="services/_includes/audit_configvars.md" >}}
diff --git a/docs/services/auth-basic/_index.md b/docs/services/auth-basic/_index.md
@@ -3,7 +3,7 @@ title: Auth-Basic
 date: 2022-03-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/auth-basic
+geekdocEditPath: edit/master/docs/services/auth-basic
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---

diff --git a/docs/services/auth-basic/configuration.md b/docs/services/auth-basic/configuration.md
@@ -3,13 +3,13 @@ title: Service Configuration
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/auth-basic
+geekdocEditPath: edit/master/docs/services/auth-basic
 geekdocFilePath: configuration.md
 geekdocCollapseSection: true
 ---
 
 ## Example YAML Config
 
-{{< include file="extensions/_includes/auth-basic-config-example.yaml" language="yaml" >}}
+{{< include file="services/_includes/auth-basic-config-example.yaml" language="yaml" >}}
 
-{{< include file="extensions/_includes/auth-basic_configvars.md" >}}
+{{< include file="services/_includes/auth-basic_configvars.md" >}}
diff --git a/docs/services/auth-bearer/_index.md b/docs/services/auth-bearer/_index.md
@@ -3,7 +3,7 @@ title: Auth-Bearer
 date: 2022-03-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/auth-bearer
+geekdocEditPath: edit/master/docs/services/auth-bearer
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---

diff --git a/docs/services/auth-bearer/configuration.md b/docs/services/auth-bearer/configuration.md
@@ -3,13 +3,13 @@ title: Service Configuration
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/auth-bearer
+geekdocEditPath: edit/master/docs/services/auth-bearer
 geekdocFilePath: configuration.md
 geekdocCollapseSection: true
 ---
 
 ## Example YAML Config
 
-{{< include file="extensions/_includes/auth-bearer-config-example.yaml" language="yaml" >}}
+{{< include file="services/_includes/auth-bearer-config-example.yaml" language="yaml" >}}
 
-{{< include file="extensions/_includes/auth-bearer_configvars.md" >}}
+{{< include file="services/_includes/auth-bearer_configvars.md" >}}
diff --git a/docs/services/auth-machine/_index.md b/docs/services/auth-machine/_index.md
@@ -3,7 +3,7 @@ title: Auth-Machine
 date: 2022-03-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/auth-machine
+geekdocEditPath: edit/master/docs/services/auth-machine
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---

diff --git a/docs/services/auth-machine/configuration.md b/docs/services/auth-machine/configuration.md
@@ -3,13 +3,13 @@ title: Service Configuration
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/auth-machine
+geekdocEditPath: edit/master/docs/services/auth-machine
 geekdocFilePath: configuration.md
 geekdocCollapseSection: true
 ---
 
 ## Example YAML Config
 
-{{< include file="extensions/_includes/auth-machine-config-example.yaml" language="yaml" >}}
+{{< include file="services/_includes/auth-machine-config-example.yaml" language="yaml" >}}
 
-{{< include file="extensions/_includes/auth-machine_configvars.md" >}}
+{{< include file="services/_includes/auth-machine_configvars.md" >}}
diff --git a/docs/services/frontend/_index.md b/docs/services/frontend/_index.md
@@ -3,7 +3,7 @@ title: Frontend
 date: 2022-03-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/frontend
+geekdocEditPath: edit/master/docs/services/frontend
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---

diff --git a/docs/services/frontend/configuration.md b/docs/services/frontend/configuration.md
@@ -3,13 +3,13 @@ title: Service Configuration
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/frontend
+geekdocEditPath: edit/master/docs/services/frontend
 geekdocFilePath: configuration.md
 geekdocCollapseSection: true
 ---
 
 ## Example YAML Config
 
-{{< include file="extensions/_includes/frontend-config-example.yaml" language="yaml" >}}
+{{< include file="services/_includes/frontend-config-example.yaml" language="yaml" >}}
 
-{{< include file="extensions/_includes/frontend_configvars.md" >}}
+{{< include file="services/_includes/frontend_configvars.md" >}}
diff --git a/docs/services/gateway/_index.md b/docs/services/gateway/_index.md
@@ -3,7 +3,7 @@ title: Gateway
 date: 2022-03-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/gateway
+geekdocEditPath: edit/master/docs/services/gateway
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---

diff --git a/docs/services/gateway/configuration.md b/docs/services/gateway/configuration.md
@@ -3,13 +3,13 @@ title: Service Configuration
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/gateway
+geekdocEditPath: edit/master/docs/services/gateway
 geekdocFilePath: configuration.md
 geekdocCollapseSection: true
 ---
 
 ## Example YAML Config
 
-{{< include file="extensions/_includes/gateway-config-example.yaml" language="yaml" >}}
+{{< include file="services/_includes/gateway-config-example.yaml" language="yaml" >}}
 
-{{< include file="extensions/_includes/gateway_configvars.md" >}}
+{{< include file="services/_includes/gateway_configvars.md" >}}
diff --git a/docs/services/graph-explorer/_index.md b/docs/services/graph-explorer/_index.md
@@ -3,7 +3,7 @@ title: "Graph-Explorer"
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/graph-explorer
+geekdocEditPath: edit/master/docs/services/graph-explorer
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---

diff --git a/docs/services/graph-explorer/configuration.md b/docs/services/graph-explorer/configuration.md
@@ -3,13 +3,13 @@ title: Service Configuration
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/graph-explorer
+geekdocEditPath: edit/master/docs/services/graph-explorer
 geekdocFilePath: configuration.md
 geekdocCollapseSection: true
 ---
 
 ## Example YAML Config
 
-{{< include file="extensions/_includes/graph-explorer-config-example.yaml" language="yaml" >}}
+{{< include file="services/_includes/graph-explorer-config-example.yaml" language="yaml" >}}
 
-{{< include file="extensions/_includes/graph-explorer_configvars.md" >}}
+{{< include file="services/_includes/graph-explorer_configvars.md" >}}
diff --git a/docs/services/graph/_index.md b/docs/services/graph/_index.md
@@ -3,7 +3,7 @@ title: "Graph"
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/graph
+geekdocEditPath: edit/master/docs/services/graph
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---

diff --git a/docs/services/graph/configuration.md b/docs/services/graph/configuration.md
@@ -3,12 +3,12 @@ title: Service Configuration
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/graph
+geekdocEditPath: edit/master/docs/services/graph
 geekdocFilePath: configuration.md
 geekdocCollapseSection: true
 ---
 ## Example YAML Config
 
-{{< include file="extensions/_includes/graph-config-example.yaml" language="yaml" >}}
+{{< include file="services/_includes/graph-config-example.yaml" language="yaml" >}}
 
-{{< include file="extensions/_includes/graph_configvars.md" >}}
+{{< include file="services/_includes/graph_configvars.md" >}}
diff --git a/docs/services/graph/groups.md b/docs/services/graph/groups.md
@@ -2,7 +2,7 @@
 title: Groups
 weight: 40
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/graph
+geekdocEditPath: edit/master/docs/services/graph
 geekdocFilePath: users.md
 ---
 

diff --git a/docs/services/graph/spaces.md b/docs/services/graph/spaces.md
@@ -2,7 +2,7 @@
 title: Spaces
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/graph
+geekdocEditPath: edit/master/docs/services/graph
 geekdocFilePath: spaces.md
 ---
 

diff --git a/docs/services/graph/users.md b/docs/services/graph/users.md
@@ -2,7 +2,7 @@
 title: Users
 weight: 30
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/graph
+geekdocEditPath: edit/master/docs/services/graph
 geekdocFilePath: users.md
 ---
 

diff --git a/docs/services/groups/_index.md b/docs/services/groups/_index.md
@@ -3,7 +3,7 @@ title: Groups
 date: 2022-03-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/groups
+geekdocEditPath: edit/master/docs/services/groups
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---

diff --git a/docs/services/groups/configuration.md b/docs/services/groups/configuration.md
@@ -3,13 +3,13 @@ title: Service Configuration
 date: 2018-05-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/groups
+geekdocEditPath: edit/master/docs/services/groups
 geekdocFilePath: configuration.md
 geekdocCollapseSection: true
 ---
 
 ## Example YAML Config
 
-{{< include file="extensions/_includes/groups-config-example.yaml" language="yaml" >}}
+{{< include file="services/_includes/groups-config-example.yaml" language="yaml" >}}
 
-{{< include file="extensions/_includes/groups_configvars.md" >}}
+{{< include file="services/_includes/groups_configvars.md" >}}
diff --git a/docs/services/idm/_index.md b/docs/services/idm/_index.md
@@ -3,7 +3,7 @@ title: IDM
 date: 2022-03-02T00:00:00+00:00
 weight: 20
 geekdocRepo: https://github.com/owncloud/ocis
-geekdocEditPath: edit/master/docs/extensions/idm
+geekdocEditPath: edit/master/docs/services/idm
 geekdocFilePath: _index.md
 geekdocCollapseSection: true
 ---