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

docs: add instructions for avoiding folder path issues #2407

Merged
merged 14 commits into from
Sep 13, 2024

Conversation

jfmcquade
Copy link
Collaborator

@jfmcquade jfmcquade commented Sep 11, 2024

PR Checklist

  • PR title descriptive (can be used in release notes)

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:

Screenshot 2024-09-12 at 10 27 05

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 11, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 11, 2024
@jfmcquade jfmcquade marked this pull request as ready for review September 11, 2024 12:10
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 11, 2024
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Sep 11, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 11, 2024
Copy link
Collaborator Author

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.

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 11, 2024
README.md Outdated Show resolved Hide resolved
documentation/docs/index.md Show resolved Hide resolved
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 13, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 13, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 13, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 13, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 13, 2024
@chrismclarke chrismclarke self-requested a review September 13, 2024 17:15
@chrismclarke chrismclarke merged commit 782e74b into master Sep 13, 2024
7 checks passed
@chrismclarke chrismclarke deleted the docs/folder-path-issues branch September 13, 2024 17:15
@chrismclarke
Copy link
Member

chrismclarke commented Sep 13, 2024

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

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants