fossasia/badgeyay

Update Installation Docs for Backend

Open

#1664 opened on Sep 7, 2018

View on GitHub
 (12 comments) (0 reactions) (0 assignees)JavaScript (1,778 stars) (450 forks)batch import
DocumentationHelp WantedOpen-for-allParent issue

Description

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.

Contributor guide

Tech stack
pythonshelldocker
Domain
backenddocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
MarkdownGitCommand line
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the existing installation docs in api/docs/installation/ directory and the README. Check the issue comments for any progress or pending items. Follow the MARKDOWN formatting guidelines and include screenshots for each step. Ensure all links are updated.