Improvements for build nodes documentation

Aberta
  • Algo errado?
#72 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
35/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Domínio
documentation

Direção de pesquisa

Start from the build nodes documentation page in the EESSI docs repo, where the $EESSI_TMPDIR bind-mount instructions, the tarball creation example and the startprefix commands appear. Work through the nine bullets, editing each section the issue names, and resolve the open questions (EasyBuild temp dir versus bind mount, disk space figure) with a maintainer. Done means each bullet is either applied or explicitly declined in the thread.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

  • When using something else than /tmp for $EESSI_TMPDIR, you may have to bind mount that location by passing -B $EESSI_TMPDIR to Singularity. We can probably just always use this flag in the instructions, even when /tmp is being used.
  • Maybe have a TLDR section that allows you to easily copy all commands in one go.
  • Add an extra warning about the working directory from which the tarball gets created; this really has to be a subdir of the repo, as illustrated in the example.
  • Add a section on how this can be run as a (non-interactive) job. (using startprefix <<< buildscript.sh)
  • Build nodes should have internet access
  • How to set the number of cores to be used for compiling
  • Easybuild should use a temporary dir in $EESSI_TMPDIR (which can be set to something else than /tmp), or we should bind mount a subdir of $EESSI_TMPDIR as /tmp in the container
  • Check available disk space (~30GB?)
  • Make the tarball (especially when you install some additional packages, but it can be done in any case) in ${EESSI_TMPDIR}/overlay-upper/${EESSI_PILOT_VERSION}/software/linux
Linguagem predominante
Python
Estrelas
14
Forks
54
Merge médio
11h 2min
PRs com merge (30d)
41

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de EESSI/docs

Todas as issues de EESSI/docs

Issues semelhantes

Mais issues de Python

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.