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

Update ReadMe.md file to include a missing installation step #11466

Closed
segun-codes opened this issue Oct 10, 2022 · 7 comments
Closed

Update ReadMe.md file to include a missing installation step #11466

segun-codes opened this issue Oct 10, 2022 · 7 comments
Labels
documentation feature lacks proper documentation or needs more documents outreachy

Comments

@segun-codes
Copy link

segun-codes commented Oct 10, 2022

As observed by the contributor iIlyShelly (#10844 (comment)) and also confirmed by me during setup, step 10 in the ReadME.md file should be preceded by running the command "bundle exec rake webpacker:install" (or alternative with similar effect) otherwise errors related to webpack and manifest.json are returned. To avoid wasting time trying to fix this error especially for first timers, the ReadMe.md could be updated to include the missing step.

@welcome
Copy link

welcome bot commented Oct 10, 2022

Thanks for opening your first issue! This space is protected by our Code of Conduct - and we're here to help.
Please follow the issue template to help us help you 👍🎉😄
If you have screenshots or a gif to share demonstrating the issue, that's really helpful! 📸
Do join our Gitter channel for some brainstorming discussions.

@ayeolakenny
Copy link
Contributor

can this issue be assigned to me pls?

@xiaodaiweiwei
Copy link

I can have a try on this issue.

@TildaDares TildaDares added documentation feature lacks proper documentation or needs more documents outreachy labels Oct 11, 2022
@TildaDares
Copy link
Member

Hi @segun-codes, that is a brilliant observation. I don’t think everyone encounters that error so what you should do is instead of adding it as a step, we can say something along the lines of

“If you have the following error, then do this.”

That wording can be better refined though.

Thank you!

@segun-codes segun-codes mentioned this issue Oct 11, 2022
5 tasks
@segun-codes
Copy link
Author

segun-codes commented Oct 13, 2022

Hi @TildaDares, I observed that in a later version of the ReadMe.md file someone else had already implemented a pull request to address the issue I raised. It appears it was an older version of the README.md file that I was looking at when I generated the issue otherwise, I wouldn't have need to raise the issue in the first place. The issue is addressed in step #10 of section "Standard Installation" in https://github.com/publiclab/plots2/blob/main/README.md

@TildaDares
Copy link
Member

It’s good you caught that @segun-codes. I think you can close this issue now.

Thank you!

@segun-codes
Copy link
Author

Okay

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation feature lacks proper documentation or needs more documents outreachy
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants