Document EESSI environment variables

Open
  • Is something wrong?
#598 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

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.

Written by the indexing model from the issue text.

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

Dominant language
Python
Stars
14
Forks
54
Avg merge
11h 2m
Merged PRs (30d)
41

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EESSI/docs

All issues in EESSI/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.