toolshed/abra
5
5
Fork 23
Code Issues 88 Pull Requests 12 Packages Releases 45 Activity

documenting and translating env variables #958

New Issue
Open
opened 2026-10-29 20:17:28 +00:00 by fauno · 3 comments
fauno commented 2026-10-29 20:17:28 +00:00
Owner
Copy Link
Copy Source

just leaving this here as an idea we discussed with @ChasquiLabo. in order to translate the .env.sample comments, currently we'd need to maintain a fork of each recipe with guaranteed merge conflicts.

but if the comments/documentation where to be separated in a language-specific file, each variable could have a better documentation and become translatable even with tools like weblate.

then abra app config could show both variables and their documentation on the operator's language just by merging both in a single file. and operators working on the same server reading different languages can collaborate :)

just leaving this here as an idea we discussed with @ChasquiLabo. in order to translate the .env.sample comments, currently we'd need to maintain a fork of each recipe with guaranteed merge conflicts. but if the comments/documentation where to be separated in a language-specific file, each variable could have a better documentation and become translatable even with tools like weblate. then `abra app config` could show both variables and their documentation on the operator's language just by merging both in a single file. and operators working on the same server reading different languages can collaborate :)
❤️ 1
fauno added the enhancementi18n labels 2026-10-29 20:17:28 +00:00
fauno commented 2026-10-29 20:21:02 +00:00
Author
Owner
Copy Link
Copy Source

while adding features to different recipes a feedback i get often is that an env var should be documented and have some examples either on the .env.sample or the README, but it's difficult to map things on the README to the .env, and the .env feels like it shouldn't have a lot of text, so this proposal would also help with that i think.

while adding features to different recipes a feedback i get often is that an env var should be documented and have some examples either on the .env.sample or the README, but it's difficult to map things on the README to the .env, and the .env feels like it shouldn't have a lot of text, so this proposal would also help with that i think.
p4u1 commented 2026-10-29 23:12:54 +00:00
Owner
Copy Link
Copy Source

I have something like a recipe.yaml in my head where you can define env variables and their documentation (in different languages). Abra could then generate the env sample or part of the readme

I have something like a recipe.yaml in my head where you can define env variables and their documentation (in different languages). Abra could then generate the env sample or part of the readme
👍 1
decentral1se commented 2026-10-31 21:34:17 +00:00
Owner
Copy Link
Copy Source

toolshed/organising#695

https://git.coopcloud.tech/toolshed/organising/issues/695
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
Something is not working
 build
go build related issues
 ci/cd
Building things with CI/CD
 critical fix
https://docs.coopcloud.tech/federation/resolutions/passed/010/
 design
UI/UX
 documentation
Documenting all the things
 duplicate
This issue or pull request already exists
 easy-first-issue
Something for new people to get stuck into. We hope it's easy!
 enhancement
New feature
 help wanted
Need some help
 i10n
Everything to do with localisation
 i18n
Everything to do with internationalisation
 installer
Everything to do with the install script.
 invalid
Something is wrong
 question
More information is needed
 release
Release management
 release-candidate
Related to the new release candidate
 security
Security related
 tech-debt
test
Unit/integration testing
 wontfix
This won't be fixed
No labels enhancement i18n
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
3wordchant aadil (Aadil Ayub) abra-bot (Abra Bot) ammaratef45 amras (Sarma) Apfelwurm BornDeleuze (Born Deleuze) Brooke carla cas (Cassowary) coopcloud cyrnel dannygroenewegen (Danny Groenewegen) decentral1se (d1) dede devydave fauno (fauno) hex (Josh Dukes) iexos jade (Jade Ambrose) jjsfunhouse jmakdah2 (Jackie Makdah) joe-irving (Joe Irving) kawaiipunk (KawaiiPunk) knoflook kolaente lambdabundesverband linnealovespie (April) moosemower moritz notplants oxaliq (sorrel) p4u1 (p4u1) pharaohgraphy (Andrew 🐦‍🔥❤️‍🔥✴️) renovate-bot (Comrade Renovate Bot) ripclap simon sixsmith (Sixsmith) stevensting (stevensting) trav (Trav Fryer) val (val (he/him)) yksflip
No Assignees
3 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: toolshed/abra#958