mirror of
https://github.com/opencloud-eu/opencloud.git
synced 2026-05-06 11:31:00 -05:00
applied review comments by @wkloucek
This commit is contained in:
+1
-1
@@ -146,7 +146,7 @@ def main(ctx):
|
||||
|
||||
build_release_helpers = [
|
||||
changelog(ctx),
|
||||
# docs(ctx),
|
||||
docs(ctx),
|
||||
]
|
||||
|
||||
test_pipelines.append(
|
||||
|
||||
+5
-5
@@ -2,11 +2,11 @@
|
||||
SKIP_CONFIG_DOCS_GENERATE ?= 0
|
||||
CONFIG_DOCS_BASE_PATH ?= ../docs/extensions
|
||||
|
||||
.PHONY: config-docs-generate
|
||||
config-docs-generate: $(FLAEX)
|
||||
@if [ $(SKIP_CONFIG_DOCS_GENERATE) -ne 1 ]; then \
|
||||
$(FLAEX) >| $(CONFIG_DOCS_BASE_PATH)/$(NAME)/configuration.md \
|
||||
; fi;
|
||||
#.PHONY: config-docs-generate
|
||||
#config-docs-generate: $(FLAEX)
|
||||
# @if [ $(SKIP_CONFIG_DOCS_GENERATE) -ne 1 ]; then \
|
||||
# $(FLAEX) >| $(CONFIG_DOCS_BASE_PATH)/$(NAME)/configuration.md \
|
||||
# ; fi;
|
||||
|
||||
.PHONY: grpc-docs-generate
|
||||
grpc-docs-generate: buf-generate
|
||||
|
||||
+9
-1
@@ -19,7 +19,7 @@ In order to simplify deployments and development the configuration model from oC
|
||||
|
||||
## In-depth configuration
|
||||
|
||||
Since we include a set of predefined extensions within the single binary, configuring an extension can be done in a variety of ways. Since we work with complex types, having as many cli per config value scales poorly, so we limited the options to config files and environment variables, leaving cli flags for shared values, such as config file sources (`--config-file`) or logging (`--log-level`, `--log-pretty`, `--log-file` or `--log-color`).
|
||||
Since we include a set of predefined extensions within the single binary, configuring an extension can be done in a variety of ways. Since we work with complex types, having as many cli per config value scales poorly, so we limited the options to config files and environment variables, leaving cli flags for common values, such as logging (`--log-level`, `--log-pretty`, `--log-file` or `--log-color`).
|
||||
|
||||
The hierarchy is clear enough, leaving us with:
|
||||
|
||||
@@ -39,6 +39,14 @@ Let's explore the various flows with examples and workflows.
|
||||
|
||||
Let's explore with examples this approach.
|
||||
|
||||
#### Expected loading locations:
|
||||
|
||||
- `$HOME/.ocis/config/`
|
||||
- `/etc/ocis/`
|
||||
- `.config/`
|
||||
|
||||
followed by the extension name. When configuring the proxy, a valid full path that will get loaded is `$HOME/.ocis/config/proxy.yaml`.
|
||||
|
||||
#### Only config files
|
||||
|
||||
The following config files are present in the default loading locations:
|
||||
|
||||
Reference in New Issue
Block a user