-
-
Notifications
You must be signed in to change notification settings - Fork 133
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
[Feature] Improving Readme.md for Docker compose setup #126
Comments
@Shivangbhatnagar237 this issue is quite similar to #125. If you have something different to add, You can leave it as a comment over there. |
@Lakshay-Pruthi Agreed. |
Sure, I've added the whole issue template to #125's comment. |
@TimidRobot Actually I opened this issue, but @Lakshay-Pruthi and @Xaid-vfx told me to add the issue in the comments of #125 |
Hey @possumbilities, the suggestions for the amendments in the Readme include:
|
Hey @possumbilities, changing the Readme file may help new contributors, are my suggestions for amendments all correct? |
Hey @possumbilities, what are your views on this? |
I believe, while the original Issue here is a bit off scope, the comment further in here merits consideration, to further clarify the documentation.:
|
Hey, so can I work on this issue?
|
Problem
The Docker Compose setup doesn't consist of all the steps in brief that one should do to set up a local working environment
Description
The steps present in the Readme for setting up a local development environment by forking and cloning the repository are incomplete. If one wants to setup an environment using a Command prompt or using VS Code integrated terminal or a Git bash client, these steps are not mentioned in the Readme.md file. I have correctly set up the local development environment and I had to go to the Internet to search for a few steps involved. Using this experience, I want to improve the documentation to contribute and help my fellow developers working on CC Resource Archive project.
Alternatives
Adding images to describe various steps can help a lot. I can use Scribe (https://scribehow.com/) to properly document the steps and create a step-by-step guide.
Implementation
The text was updated successfully, but these errors were encountered: