Merge branch 'master' into document-architecture

This commit is contained in:
Jörn Friedrich Dreyer
2021-04-29 18:08:53 +02:00
committed by GitHub
181 changed files with 4245 additions and 5624 deletions
+25
View File
@@ -0,0 +1,25 @@
---
title: "Releasing"
weight: 70
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/accounts
geekdocFilePath: releasing.md
---
{{< toc >}}
## Requirements
You need a working installation of [the Go programming language](https://golang.org/) installed to build the assets for a working release.
## Releasing
After adding changes to the accounts package within oCIS and testing them locally, you want to update the compiled assets to the oCIS binary.
To achieve this, you have to run a Go command and add the results to your PR. The preferred way to do this is to run `make generate` in the root
of the repository and then commit the resulting changes to your branch/PR.
### Package Hierarchy
- [ocis](https://github.com/owncloud/ocis)
- [ocis-accounts](https://github.com/owncloud/ocis/tree/master/accounts)
+1 -1
View File
@@ -8,4 +8,4 @@ geekdocFilePath: _index.md
geekdocCollapseSection: true
---
This service embeds [Graph-Explorer](https://github.com/owncloud/ocis/graph-explorer) to provide a UI for ownCloud Infinite Scale.
This service embeds [Graph-Explorer](https://github.com/owncloud/ocis/tree/master/graph-explorer) to provide a UI for ownCloud Infinite Scale.
+1 -1
View File
@@ -1,7 +1,7 @@
---
title: "OnlyOffice"
date: 2018-05-02T00:00:00+00:00
weight: 10
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/onlyoffice
geekdocFilePath: _index.md
+1 -1
View File
@@ -7,4 +7,4 @@ geekdocEditPath: edit/master/docs/extensions/onlyoffice
geekdocFilePath: license.md
---
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/onlyoffice/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/blob/master/onlyoffice/LICENSE) license. For the license of the used libraries you have to check the respective sources.
+1 -1
View File
@@ -15,7 +15,7 @@ for other extensions to register new settings within oCIS. It is responsible for
settings values as well.
For ease of use, this extension provides an ocis-web extension which allows users to change their settings values.
Please refer to the [ocis-web extension docs]({{< relref "../../ocis/development/extensions/#external-ownCloud-Web-apps" >}})
Please refer to the [ocis-web extension docs]({{< ref "../../ocis/development/extensions/#external-ownCloud-Web-apps" >}})
for running ocis-web extensions.
{{< mermaid class="text-center">}}
+1 -1
View File
@@ -2,7 +2,7 @@
title: "Glossary"
date: 2020-05-04T12:35:00+01:00
weight: 80
geekdocRepo: https://github.com/owncloud/oci
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/settings
geekdocFilePath: glossary.md
---
+25
View File
@@ -0,0 +1,25 @@
---
title: "Releasing"
weight: 70
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/extensions/settings
geekdocFilePath: releasing.md
---
{{< toc >}}
## Requirements
You need a working installation of [the Go programming language](https://golang.org/) installed to build the assets for a working release.
## Releasing
After adding changes to the settings package within oCIS and testing them locally, you want to update the compiled assets to the oCIS binary.
To achieve this, you have to run a Go command and add the results to your PR. The preferred way to do this is to run `make generate` in the root
of the repository and then commit the resulting changes to your branch/PR.
### Package Hierarchy
- [ocis](https://github.com/owncloud/ocis)
- [ocis-settings](https://github.com/owncloud/ocis/tree/master/settings)
+1 -1
View File
@@ -14,7 +14,7 @@ provided by this service.
## Identifying settings values
A *settings value* is uniquely identified by four attributes. Three of them are coming from the definition of
the setting within it's settings bundle (see [Settings Bundles]({{< relref "bundles.md" >}})
the setting within it's settings bundle (see [Settings Bundles]({{< ref "bundles" >}})
for an example). The fourth identifies the user.
- extension: Key of the extension that registered the settings bundle,
- bundleKey: Key of the settings bundle,
+1 -1
View File
@@ -13,7 +13,7 @@ To release a new version of the storage submodule, you have to follow a few simp
## Preparation
1. Before releasing, make sure that reva has been [updated to the desired version]({{< ref "updating.md" >}})
1. Before releasing, make sure that reva has been [updated to the desired version]({{< ref "updating" >}})
## Release
1. Check out master
+1 -1
View File
@@ -15,5 +15,5 @@ geekdocFilePath: updating.md
2. Create a changelog entry containing changes that were done in [reva](https://github.com/cs3org/reva/commits/master)
3. Create a Pull Request to ocis-reva master with those changes
4. If test issues appear, you might need to adjust the tests
5. After the PR is merged, consider doing a [release of the storage submodule]({{< ref "releasing.md" >}})
5. After the PR is merged, consider doing a [release of the storage submodule]({{< ref "releasing" >}})
+1 -1
View File
@@ -28,7 +28,7 @@ export STORAGE_USERS_DRIVER=json
export STORAGE_USERS_JSON=/path/to/users.json
```
For the format of the users.json have a look at the [reva examples](https://github.com/cs3org/reva/blob/master/examples/separate/users.demo.json)
For the format of the users.json have a look at the [reva examples](https://github.com/cs3org/reva/blob/master/examples/oc-phoenix/users.demo.json)
### LDAP driver
+1 -1
View File
@@ -16,7 +16,7 @@ To update this package within all the deliveries, we need to update the package
### Package Hierarchy
- [ocis](https://githug.com/owncloud/ocis)
- [ocis](https://github.com/owncloud/ocis)
- [ocis-web](https://github.com/owncloud/ocis/tree/master/web)
- [ocis-pkg](https://github.com/owncloud/ocis/tree/master/ocis-pkg)
- [ownCloud Web](https://github.com/owncloud/web)