Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Improve] Update the main README.md, CONTRIBUTING.md and Scrapper-Service/README.md #40

Open
2 of 6 tasks
thesagarsehgal opened this issue Mar 11, 2020 · 7 comments
Open
2 of 6 tasks
Assignees
Labels
beginner GSSOC label for beginner tag documentation Improvements or additions to documentation good first issue Good for newcomers gssoc20 GSSOC label for gscco20 tag

Comments

@thesagarsehgal
Copy link
Collaborator

thesagarsehgal commented Mar 11, 2020

Some of the improvements that must be added to the main README.md file.

  • In the Prerequisites section, for the various tools like Mongo DB, Angular, etc., please provide a link to the installation instructions for Windows and Linux systems.
  • The /Scrapper-Service folder has requirements.txt file. Please add instructions for creating the virtual environment and installing the /Scrapper-Service/requirements.txt.
  • For Deployment of Scrapper-Service section, in the instructions, change main.py to app.py.
  • For Deployment section, separate all the commands into different blocks, instead of putting all of them in one block. Further, please remove the >> symbol in the beginning, because currently, it becomes difficult to copy the complete command in a double click.
  • Also, similar work has to be done in the ATTENTION section of CONTRIBUTING.md file for separating all the commands into different blocks, instead of putting all of them in one block.
  • Add instructions on how to run the Scraper Service in different modes in the /Scrapper-Service/README.md.
@thesagarsehgal thesagarsehgal changed the title [Improve] Update the main README.md [Improve] Update the main README.md and CONTRIBUTING.md Mar 11, 2020
@thesagarsehgal thesagarsehgal changed the title [Improve] Update the main README.md and CONTRIBUTING.md [Improve] Update the main README.md, CONTRIBUTING.md and Scrapper-Service/README.md Mar 11, 2020
@thesagarsehgal thesagarsehgal added beginner GSSOC label for beginner tag documentation Improvements or additions to documentation good first issue Good for newcomers gssoc20 GSSOC label for gscco20 tag labels Mar 12, 2020
@maheshschand
Copy link
Contributor

Interested. Could you please assign this to me @sagar-sehgal ?

@poojasrinivass
Copy link

I would like to work on this issue.

@ikoala21
Copy link
Contributor

If it is not assigned yet, I would like to take this up.

@thesagarsehgal
Copy link
Collaborator Author

@maheshschand @poojasrinivass @manasakalaga Thank You for showing interest in the issue. I am assigning 1-1 mini task to each one of you. As soon as you solve one of the mini-task, I will assign a new mini-task to you.

@maheshschand :- In the Prerequisites section, for the various tools like Mongo DB, Angular, etc., please provide a link to the installation instructions for Windows and Linux systems.

@poojasrinivass :- The /Scrapper-Service folder has requirements.txt file. Please add instructions for creating the virtual environment and installing the /Scrapper-Service/requirements.txt .

@manasakalaga :- For Deployment of Scrapper-Service section, in the instructions, change main.py to app.py.

@maheshschand
Copy link
Contributor

@sagar-sehgal I made necessary changes in README.md. Please look into #44 pull request.

@thesagarsehgal
Copy link
Collaborator Author

@poojasrinivass I haven't got any response from you. This was a very small update. I request you to please send a PR corresponding to the issue assigned to you.

@thesagarsehgal
Copy link
Collaborator Author

@manasakalaga Since you have completed one subpart I am assigning you another one.

Add instructions on how to run the Scraper Service in different modes in the /Scrapper-Service/README.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginner GSSOC label for beginner tag documentation Improvements or additions to documentation good first issue Good for newcomers gssoc20 GSSOC label for gscco20 tag
Projects
None yet
Development

No branches or pull requests

4 participants