posit-dev / posit-dev/rsconnect-python

deploying "EXTRA_FILES" needs to be explained better

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

Nessuno ha ancora preso questa issue.

documentation
Lingua principale
Python
Stelle
37
Fork
28
Merge medio
1g 3h
PR unite (30g)
7

Descrizione

The deploy subcommands take "EXTRA_FILES" arguments, but it's really unclear how it actually works.

The --help shows:

rsconnect deploy api [OPTIONS] DIRECTORY [EXTRA_FILES]...

And the README shows:

rsconnect deploy api flask-api/ data.csv

But when I try it (eg rsconnect deploy api ./hello/ data.txt), I get an error:

Error: ../data.txt must be under ./hello/.

So I need to have data.txt inside the hello directory? Doesn't everything inside the app directory get included by default? What's the point of EXTRA_FILES then? Is it just to negate a --exclude, as described in the README? What am I missing?

Also, the documentation should clearly state where the extra files get placed inside the app directory hierarchy. One would assume they get placed in the root but why make people guess? The documentation should be more clear.

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

Inizia con gli esempi di deploy nel README e con l’output di --help dei sottocomandi deploy, quindi segui dove viene descritto EXTRA_FILES. Chiarisci quando vengono inclusi i file aggiuntivi, come si relazionano a --exclude e dove compaiono nella gerarchia della directory dell’app; il lavoro è completato quando il comportamento documentato risponde alle domande segnalate senza lasciare spazio a supposizioni.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.