activitypods / activitypods/deployment
Add comment in .env.exemple files
- Dominant language
- Shell
- Stars
- 2
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
Actuellement, les explications liées aux fichiers .env sont dans la doc, il y a donc besoin de faire des allers et retours entre la doc et les fichiers (pas bien grave, voir aidant si la doc est traduites dans plusieurs langues)
En associant à chaque ligne son rôle / les changements à y faire, on évite la bascule nomé plus haut...
Mais plus important : ça permet de reprérer ligne par ligne, s'il manque des choses dans la doc.
Par exemple, actuellement dans `.env.exemple` :
```
LETSENCRYPT_EMAIL=
FUSEKI_PASSWORD=
```
Que dois-je mettre ? que ce passe-t-il si je laisse vide ?
Cela pourrait être explicité comme suit (comportement fictif) :
```
LETSENCRYPT_EMAIL= # handle https certificate automaticly (disabled if empty)
# -------------------------------------------------------------------------
# DON'T EDIT AFTER THIS LINE : AUTO-GENERATED
# -------------------------------------------------------------------------
FUSEKI_PASSWORD=
```
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.