Document EESSI environment variables

Offen
  • Stimmt etwas nicht?
#598 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
35/100
Issue-Typ
Dokumentation
Klarheit
Größtenteils klar
Aktivitätsstatus
Veraltet
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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?'

Vorherrschende Sprache
Python
Sterne
14
Forks
54
Ø Merge
11 Std. 2 Min.
Gemergte PRs (30 T.)
41

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus EESSI/docs

Alle Issues in EESSI/docs

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.