activitypods / activitypods/deployment

Add comment in .env.exemple files

Ouverte
#1 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Shell
Étoiles
2
Forks
1
Métriques de merge des PR
Aucune PR mergée en 30 j

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=
```

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Évaluation

Cette issue n'a pas encore été évaluée.

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.