activitypods / activitypods/deployment

Add comment in .env.exemple files

Abierto
#1 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
Shell
Estrellas
2
Forks
1
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.