mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-04-24 13:08:26 -05:00
Code Issues Packages Projects Releases Wiki Activity

[docs-only] Fix texts and typos in README.md files

Browse Source
This commit is contained in:
mmattel
2023-04-23 10:02:27 +02:00
parent 169a3abe07
commit 84d2d8dae9
14 changed files with 39 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/helpers/README.md
+2 -1
View File
@@ -16,11 +16,12 @@
## Introduction
`docs/helpers` contains small go programs creating docs by extracting information from the code. The `main.go` program is manually started with `make docs-generate` or via the CI. It calls the other required programs and has three main responsibilities:
`docs/helpers` contains small go programs creating docs by extracting information from the code. The `main.go` program is manually started with `make docs-generate` or via the CI. It calls the other required programs and has these main responsibilities:
- Generate docs for envvars in config structs including deprecations if there are any.
- Extract and generate docs for `extended` envvars that are not mentioned in config structs (aka "rogue" envvars).
- Extract and generate docs for `global` envvars which occur in multiple services.
- Create `docs/service/<service-name>/_index.md` from `service/<service-name>/README.md` files while keeping the existing `_index.md` if the README.md has not been created so far.
## Output Generated