fossasia/badgeyay

Update Installation Docs for Backend

Open

#1664 aperta il 7 set 2018

Vedi su GitHub
 (12 commenti) (0 reazioni) (0 assegnatari)JavaScript (450 fork)batch import
DocumentationHelp WantedOpen-for-allParent issue

Metriche repository

Star
 (1778 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

I'm submitting a ...

  • bug report
  • feature request

Please update the Installation Docs for following:

  • Generic Installation Instructions. Please see this for reference.
  • Installation on Linux/Unix using Virtualenv. Please see this for reference.
  • Installaion on Windows or Vagrant Installation. Please see this for reference.
  • Deployment on Heroku. Please see this for reference.
  • Deployment on Docker. Please see this for reference.
  1. Please open separate Issue for respective Installation docs.
  2. Installation docs should be placed api/docs/installation.
  3. Please update the link of installation docs in the README
  4. Every Installation doc should contain a good quality screenshot for every step mentioned.
  5. Use Github Markdown uniformly for formatting the Installation steps.

Guida contributor

Direzione di ricerca
Esamina i file di documentazione di installazione esistenti a cui si fa riferimento nell'issue. Assicurati che ogni documento abbia collegamenti corretti, screenshot aggiornati e formattazione Markdown uniforme. Aggiorna di conseguenza i collegamenti nel README.
Tech stack
Nessuno
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80