sevenhill/QSfera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve settings docs overview page

Browse Source
This commit is contained in:
Benedikt Kulmann
2020-06-05 07:43:50 +02:00
parent 3a12bff114
commit a69d4e0421
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/_index.md
+9 -7
View File
@@ -23,22 +23,24 @@ graph TD
ows[ocis-web-settings] ows[ocis-web-settings]
owc[ocis-web-core] owc[ocis-web-core]
end end
ows ---|"listSettingsBundles(),<br>listSettingsValues(),<br>saveSettingsValue(value)"| os[ocis-settings] ows ---|"listSettingsBundles(),<br>saveSettingsValue(value)"| os[ocis-settings]
owc ---|"listSettingsValues()<br>getSettingsValue(id)"| sdk[oC SDK] owc ---|"listSettingsValues()"| sdk[oC SDK]
sdk --- sdks{ocis-settings<br>available?} sdk --- sdks{ocis-settings<br>available?}
sdks ---|"yes"| os sdks ---|"yes"| os
sdks ---|"no"| defaults[Use set of<br>default values] sdks ---|"no"| defaults[Use set of<br>default values]
oa[oCIS extensions<br>e.g. ocis-accounts] ---|"saveSettingsBundle(bundle),<br>getSettingsValue(id)"| os oa[oCIS extensions<br>e.g. ocis-accounts] ---|"saveSettingsBundle(bundle)"| os
{{< /mermaid >}} {{< /mermaid >}}
The diagram shows how the settings service integrates into oCIS: The diagram shows how the settings service integrates into oCIS:
**Settings management:** **Settings management:**
- oCIS extensions can register settings bundles with the ocis-settings service. - oCIS extensions can register *settings bundles* with the ocis-settings service.
- The settings frontend can be plugged into ocis-web, showing generated forms for changing settings values as a user. - The settings frontend can be plugged into ocis-web, showing forms for changing *settings values* as a user.
The forms are generated from the registered *settings bundles*.
**Settings usage:** **Settings usage:**
- Extensions can query ocis-settings for settings values of a user. - Extensions can query ocis-settings for *settings values* of a user.
- The ownCloud SDK, used as a data abstraction layer for ocis-web, will query ocis-settings for settings values of a user, - The ownCloud SDK, used as a data abstraction layer for ocis-web, will query ocis-settings for *settings values* of a user,
if it's available. The SDK uses sensible defaults when ocis-settings is not part of the setup. if it's available. The SDK uses sensible defaults when ocis-settings is not part of the setup.
For compatibility with ownCloud 10, a migration of ownCloud 10 settings into the storage of ocis-settings will be available. For compatibility with ownCloud 10, a migration of ownCloud 10 settings into the storage of ocis-settings will be available.