chaoss / chaoss/grimoirelab-tutorial

Third-party dependences for Graal

Aperta
#115 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Ruby
Stelle
30
Fork
67
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

As stated in https://lists.linuxfoundation.org/pipermail/grimoirelab-discussions/2020-January/000282.html, the intro requires Python3 and Graal to be installed, but it does not mention that third-party backend-tools are also needed.

Following the tutorial lacking them will cause errors.

  • Just mentioning this in the intro would already help a lot to interprete the error messages.
  • Adding a guide on how to install theese would help further to solve the problem. https://github.com/chaoss/grimoirelab/tree/master/third-party#example is already ok for Docker users or to find out that the Docker grimoirelab/full image provides 2 deb files to install these in Debian. A generic description would be even better.
  • Capturing theese kind of errors in Graal itself and pointing the user to the previous documentation would be the next step. This would possibly require a sepparate issue (?).

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Esamina l’introduzione del tutorial di Graal e l’esempio di third-party backend-tools nel repository GrimoireLab. Documenta le dipendenze richieste e le istruzioni di installazione per gli utenti che non usano Docker, trattando la gestione degli errori lato Graal come un follow-up separato. Il lavoro è considerato completato quando il lettore viene avvisato delle dipendenze prima di seguire il tutorial e può trovare istruzioni di installazione pertinenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
docker, python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.