add more config doc descriptions #3973
Conversation
wkloucek
requested review from
mmattel
and removed request for
kulmann and
pascalwengerter
Co-authored-by: Phil Davis <[email protected]>
|
"This branch is 4 commits ahead, 39 commits behind owncloud:master." Will that matter? Is it worth rebasing to make sure that it's all good? |
|
💥 Acceptance test Core-API-Tests-ocis-storage-10 failed. Further test are cancelled... |
| GatewayAddress string `yaml:"gateway_addr" env:"STORAGE_GATEWAY_GRPC_ADDR" desc:"GRPC address of the storage-system extension."` | ||
| StorageAddress string `yaml:"storage_addr" env:"STORAGE_GRPC_ADDR" desc:"GRPC address of the storage-system extension."` |
There was a problem hiding this comment.
These have the same description - are there 2 variables that do the same thing?
There was a problem hiding this comment.
Yes, that's a somehow weird decision to expose both settings. I think this grew organically and has historical reasons.
Is now tracked in #4058
|
@wkloucek see the image below, it seems that in the web service, one config var errors. It is between
|
|
|
||
| This service provides search functionality. |
There was a problem hiding this comment.
It is obvious that a search service provides search functionality, but could we have a bit more meat on the bone 😅
There was a problem hiding this comment.
Please let us do abstracts in subsequent PRs. They should be more than one sentence.
| CommitShareToStorageGrant bool `yaml:"commit_share_to_storage_grant" env:"GATEWAY_COMMIT_SHARE_TO_STORAGE_GRANT" desc:"Commit shares to storage grants."` | ||
| CommitShareToStorageRef bool `yaml:"commit_share_to_storage_ref" env:"GATEWAY_COMMIT_SHARE_TO_STORAGE_REF" desc:"Commit shares to storage."` |
There was a problem hiding this comment.
What is the difference in between the two? Or what is the impact is setting true/false?
There was a problem hiding this comment.
GATEWAY_COMMIT_SHARE_TO_STORAGE_REF was removed and the description updated in 4fe5703
services/graph/pkg/config/http.go
Outdated
| Namespace string `yaml:"-"` | ||
| Root string `yaml:"root" env:"GRAPH_HTTP_ROOT"` | ||
| Root string `yaml:"root" env:"GRAPH_HTTP_ROOT" desc:"The root path of the HTTP service."` |
There was a problem hiding this comment.
The default is: /graph. In which folder can /graph be found?
There was a problem hiding this comment.
Clarified with @dragonchaser
There was a problem hiding this comment.
I changed it to Subdirectory that serves as the root for this HTTP service. for all services that have that option.
if you have oCIS on https://ocis.owncloud.test, the graph service is available on https://ocis.owncloud.test/graph. If you want to have it on another subdirectory, eg. /foobar, you could change that config and also the proxy route to serve the graph on https://ocis.owncloud.test/foobar
Co-authored-by: Martin <[email protected]> Co-authored-by: Phil Davis <[email protected]>
Already fixed in this PR |
|
@phil-davis 👍 😄 |
|
Kudos, SonarCloud Quality Gate passed!
|
|
👍 |
Description
adds more config doc descriptions, removes unused configuration options
Related Issue
Motivation and Context
have all config options described
How Has This Been Tested?
Screenshots (if appropriate):
Types of changes
Checklist: