OpenSourceHelpCommunity/OpenSourceHelpCommunity.github.io

Installation Documentation improvement

Opened this issue · 7 comments

As of now new users can easily understand how to install this webapp locally but if they want to deploy the application in heroku they can't because of lack of explanation. We could have something like this:
image
More organized documentation and proper steps to deploy locally and on heroku.
In Documentation details of technology stack, branch policies, Contributions best practices and License details are missing.

@tapasweni-pathak I can raise seperate issues for these and these issues can be fixed by first time contributor.

@anubhakushwaha @nikhita Please share your opinion 😄

@vaibhavsingh97 I ❤️ it!

@nikhita What i am thinking to have a gist/Google doc where everyone can collaborate and can improve installation documentation to more beginer friendly.

@vaibhavsingh97 Sounds great. I think we should go with a google doc since it has better sharing features.

Just to be clear, the google doc will be kind of a "draft", right? We'll later port it to markdown?

@nikhita yeah, It's just a draft, We would port that draft in markdown. I will share the link of doc in a minute

@vaibhavsingh97 can I take this one?