Skip to content

Add comment in .env.exemple files #1

Description

@1000i100

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=

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions