Document EESSI environment variables

Ouverte
#598 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Domaine
documentation

Piste de recherche

The payload names no files or entry points, so start by searching the repository for EESSI_ variable assignments to build the full list. The issue asks for three things per variable: its purpose, its valid value format, and whether end-users can override it via an _OVERRIDE variable. It is done when each variable found has all three documented in the docs. The issue has no comments or linked work, so confirm the target page with maintainers before writing.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

We set a lot of EESSI_ environment variables. We should document

  • What they are used for
  • What valid values are (i.e. which 'format')
  • Which ones can be set / overriden by end-users (_OVERRIDE) etc.

This will also help ourselves, e.g. to avoid unclarities like we had earlier regarding 'does the GPU_TARGET_ARCHITECTURE include /accelerator or not?'

Langage dominant
Python
Étoiles
14
Forks
54
Merge moyen
11 h 2 min
PR mergées (30 j)
41

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de EESSI/docs

Toutes les issues de EESSI/docs

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

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