Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Auto-generate documentation of the config / env variables #4668

Closed
michaelstingl opened this issue Sep 26, 2022 · 1 comment
Closed
Labels
Topic:Documentation Type:CI Related to our Continouus Integration Solution

Comments

@michaelstingl
Copy link
Contributor

michaelstingl commented Sep 26, 2022

Is your feature request related to a problem? Please describe.

From a discussion with @tbsbdr :

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:

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 a configuration.adoc. It gets then embedded in the mdm.adoc page.

/cc @mmattel @d7oc

@michaelstingl michaelstingl added Type:CI Related to our Continouus Integration Solution Topic:Documentation labels Sep 26, 2022
@micbar
Copy link
Contributor

micbar commented Sep 27, 2022

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.

There are existing tickets for that #3917 #4178

Closing this here. Please check the other tickets for progress.

@micbar micbar closed this as completed Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Topic:Documentation Type:CI Related to our Continouus Integration Solution
Projects
None yet
Development

No branches or pull requests

2 participants