-
Notifications
You must be signed in to change notification settings - Fork 26
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
docs: add instructions for avoiding folder path issues #2407
Conversation
documentation/requirements.txt
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This diff was changing PyYAML==6.0
-> PyYAML==6.0.2
. PyYAML v6.0 was not installing for me, but updating the dependency to the most recent version fixed the issue.
documentation/docs/contributors/documentation/running-server.md
Outdated
Show resolved
Hide resolved
Weird about the python diffs, maybe it's a github thing then (can revisit next time it comes up). In any case I think this one should be good to go |
PR Checklist
Description
Adds some instructions regarding the local destination of the cloned repo, in order to avoid possible issues with cloning the repo to a folder whose absolute path contains a space character (example in this mattermost thread).
In general I'm wary of adding too much specific detail to the "Quickstart" set-up docs, as we have to assume that users either have some level of technical proficiency or can acquire it elsewhere. However, it does seem worth including instructions such as this where there might otherwise be issues for some users that do not make themselves immediately apparent.
Git Issues
Closes #
Screenshots/Videos
Docs site version: