Skip to content

Commit 817ffe0

Browse files
authored
Merge pull request #11506 from owncloud/update_envvar_changes
[docs-only] Update envvar description
2 parents c05d12d + cca0c46 commit 817ffe0

36 files changed

+715
-341
lines changed

Makefile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,9 @@ docs-generate:
169169
done
170170

171171
$(MAKE) --no-print-directory -C docs docs-generate || exit 1
172-
cp docs/services/general-info/env-var-deltas/*.adoc docs/services/_includes/adoc/env-var-deltas/
172+
# .adoc for admin docs, .md for dev docs
173+
cp docs/services/general-info/envvars/env-var-deltas/*.adoc docs/services/_includes/adoc/env-var-deltas/
174+
cp docs/services/general-info/envvars/env-var-deltas/*.md docs/services/_includes/adoc/env-var-deltas/
173175

174176
.PHONY: check-env-var-annotations
175177
check-env-var-annotations:

docs/helpers/README.md

Lines changed: 86 additions & 121 deletions
Large diffs are not rendered by default.

docs/helpers/env_vars.yaml

Lines changed: 149 additions & 146 deletions
Large diffs are not rendered by default.

docs/ocis/development/envvars.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ geekdocFilePath: envvars.md
99

1010
Environment variables are an essential part of configuring services.
1111

12-
If you are going to create new ones or deprecate existing ones, you must read the [Envvar Naming Scope]({{< ref "services/general-info/envvar-scopes.md" >}}) and the
13-
[Deprecating Variables]({{< ref "services/general-info/deprecating-variables.md" >}}) documentation for more details first before doing so.
12+
If you are going to create new ones or deprecate existing ones, you must read the [Envvar Naming Scope]({{< ref "services/general-info/envvars/envvar-naming-scopes.md" >}}) and the
13+
[Deprecating Variables]({{< ref "services/general-info/envvars/deprecating-variables.md" >}}) documentation for more details first before doing so.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
!**/_index.md
2+

docs/services/general-info/added-services.md

Lines changed: 0 additions & 64 deletions
This file was deleted.
-10.8 KB
Binary file not shown.

docs/services/general-info/env-var-deltas/make-adoc-and-md-files.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: Environment Variables
3+
date: 2025-07-03T00:00:00+00:00
4+
weight: 10
5+
geekdocRepo: https://github.com/owncloud/ocis
6+
geekdocEditPath: edit/master/docs/services/general-info/envvars
7+
geekdocFilePath: _index.md
8+
geekdocCollapseSection: true
9+
---
10+
11+
## General Information
12+
13+
This section provides general information how to manage environment variables.
14+
15+
Additionally read the [helper README](https://github.com/owncloud/ocis/tree/master/docs/helpers#readme) for internal details how envvars are managed.

docs/services/general-info/deprecating-variables.md renamed to docs/services/general-info/envvars/deprecating-variables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: "Envvar Deprecation"
33
date: 2024-08-22T15:41:00+01:00
4-
weight: 20
4+
weight: 15
55
geekdocRepo: https://github.com/owncloud/ocis
6-
geekdocEditPath: edit/master/docs/services/general-info
6+
geekdocEditPath: edit/master/docs/services/general-info/envvars
77
geekdocFilePath: deprecating-variables.md
88
---
99

0 commit comments

Comments
 (0)