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

Installation Documentation improvement #119

Open
vaibhavsingh97 opened this issue Sep 19, 2017 · 7 comments
Open

Installation Documentation improvement #119

vaibhavsingh97 opened this issue Sep 19, 2017 · 7 comments
Assignees

Comments

@vaibhavsingh97
Copy link
Member

vaibhavsingh97 commented Sep 19, 2017

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.

@vaibhavsingh97
Copy link
Member Author

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

@vaibhavsingh97
Copy link
Member Author

@anubhakushwaha @nikhita Please share your opinion 😄

@nikhita
Copy link
Contributor

nikhita commented Sep 20, 2017

@vaibhavsingh97 I ❤️ it!

@vaibhavsingh97
Copy link
Member Author

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

@nikhita
Copy link
Contributor

nikhita commented Sep 20, 2017

@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?

@vaibhavsingh97
Copy link
Member Author

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

@devesh-verma
Copy link

@vaibhavsingh97 can I take this one?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants