You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Do we have an overview of all OCIS config / env variables? I find it quite tedious to find the right variable names like OCIS_BASE_DATA_PATH in the documentation.
Describe the solution you'd like
Documentation of the config / env variables should be maintained in the source code, and automagically extracted for docs in every pull request. We already do this with the oC10 config.php parameters and for the iOS app MDM and branding parameters:
This is already implemented from the very beginning of the project.
The challenge is that we have around 30 services and a lot of settings. We need more hand-crafted and manual documentation about the config options. The list alone, as we have it today is somehow overwhelming.
Is your feature request related to a problem? Please describe.
From a discussion with @tbsbdr :
Describe the solution you'd like
Documentation of the config / env variables should be maintained in the source code, and automagically extracted for docs in every pull request. We already do this with the oC10 config.php parameters and for the iOS app MDM and branding parameters:
Describe alternatives you've considered
Maintenance without automation just don't scale.
Additional context
For the iOS app and iOS SDK MDM and branding parameters, we have the compiled app running with GitHub actions:
https://github.com/owncloud/ios-app/blob/master/.github/workflows/configuration-documentation.yml
A
CONFIGURATION.json
gets created, and a gomplate template is used to generate aconfiguration.adoc
. It gets then embedded in themdm.adoc
page./cc @mmattel @d7oc
The text was updated successfully, but these errors were encountered: