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

[Feature] Improving Readme.md for Docker compose setup #126

Open
1 task done
Shivangbhatnagar237 opened this issue Mar 29, 2023 · 9 comments
Open
1 task done

[Feature] Improving Readme.md for Docker compose setup #126

Shivangbhatnagar237 opened this issue Mar 29, 2023 · 9 comments
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work

Comments

@Shivangbhatnagar237
Copy link

Problem

image
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

  • I would be interested in implementing this feature.
@Shivangbhatnagar237 Shivangbhatnagar237 added ✨ goal: improvement Improvement to an existing feature 💻 aspect: code Concerns the software code in the repository 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🟩 priority: low Low priority and doesn't need to be rushed labels Mar 29, 2023
@Lakshay-Pruthi
Copy link
Contributor

@Shivangbhatnagar237 this issue is quite similar to #125. If you have something different to add, You can leave it as a comment over there.

@Xaid-vfx
Copy link
Contributor

@Lakshay-Pruthi Agreed.
@Shivangbhatnagar237 you can carry the conversation here #125.

@Shivangbhatnagar237
Copy link
Author

Sure, I've added the whole issue template to #125's comment.

@Shivangbhatnagar237
Copy link
Author

@TimidRobot Actually I opened this issue, but @Lakshay-Pruthi and @Xaid-vfx told me to add the issue in the comments of #125

@Shivangbhatnagar237
Copy link
Author

Shivangbhatnagar237 commented Apr 1, 2023

Hey @possumbilities, the suggestions for the amendments in the Readme include:

  1. Adding complete steps informing what will happen (Install Docker and after installing, it will reboot your device)
  2. Adding information (It requires Windows subsystem for linux, or wsl enabled and upgraded to the latest version)
  3. Adding supporting info that might be required like wsl can be upgraded by the command wsl --update in Windows Powershell

@Shivangbhatnagar237
Copy link
Author

Hey @possumbilities, changing the Readme file may help new contributors, are my suggestions for amendments all correct?

@Shivangbhatnagar237
Copy link
Author

Hey @possumbilities, what are your views on this?

@possumbilities possumbilities closed this as not planned Won't fix, can't repro, duplicate, stale Aug 20, 2024
@possumbilities possumbilities added ⛔️ status: discarded Will not be worked on 🧹 status: ticket work required Needs more details before it can be worked on and removed ⛔️ status: discarded Will not be worked on 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Aug 20, 2024
@possumbilities possumbilities added ⛔️ status: discarded Will not be worked on and removed 🧹 status: ticket work required Needs more details before it can be worked on labels Aug 20, 2024
@possumbilities possumbilities added 🧹 status: ticket work required Needs more details before it can be worked on and removed ⛔️ status: discarded Will not be worked on labels Aug 20, 2024
@possumbilities
Copy link
Contributor

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 @possumbilities, the suggestions for the amendments in the Readme include:

  1. Adding complete steps informing what will happen (Install Docker and after installing, it will reboot your device)
  2. Adding information (It requires Windows subsystem for linux, or wsl enabled and upgraded to the latest version)
  3. Adding supporting info that might be required like wsl can be upgraded by the command wsl --update in Windows Powershell

@possumbilities possumbilities added 🏁 status: ready for work Ready for work and removed 🧹 status: ticket work required Needs more details before it can be worked on labels Aug 20, 2024
@TimidRobot TimidRobot moved this to Backlog in possumbilities Sep 10, 2024
@Shivangbhatnagar237
Copy link
Author

Hey, so can I work on this issue?

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 @possumbilities, the suggestions for the amendments in the Readme include:

  1. Adding complete steps informing what will happen (Install Docker and after installing, it will reboot your device)
  2. Adding information (It requires Windows subsystem for linux, or wsl enabled and upgraded to the latest version)
  3. Adding supporting info that might be required like wsl can be upgraded by the command wsl --update in Windows Powershell

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository ✨ goal: improvement Improvement to an existing feature 🟩 priority: low Low priority and doesn't need to be rushed 🏁 status: ready for work Ready for work
Projects
Status: Backlog
Development

No branches or pull requests

4 participants