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

Add Installation Instructions for Windows Users #910

Closed
micw523 opened this issue Jul 31, 2019 · 5 comments · Fixed by #1031
Closed

Add Installation Instructions for Windows Users #910

micw523 opened this issue Jul 31, 2019 · 5 comments · Fixed by #1031
Assignees
Labels
kind/documentation Categorizes issue or PR as related to documentation. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.

Comments

@micw523
Copy link
Contributor

micw523 commented Jul 31, 2019

This issue originally appeared in #676. We provided a utility script for Windows developers to work around the symbolic link in #766. However, the script is not documented anywhere and we just got a new question on #857. I think we should add information to Readme for potential Windows developers.

We'll have to tell Windows developers about the symbolic links and our workaround - and that they'll face difficulty when trying to commit changes (should remove the copied folders, clone the base repo only if they want to change the code in the base repo, etc).

I have two ideas to document this:

  1. Add some information under the "Installation" section and tell Windows users that installing from PyPi is preferred. Otherwise they'll need to run the batch script.
  2. Add a new section in front of the Mac/Python issue on Readme to document the same kind of actions that they need to take.
@micw523
Copy link
Contributor Author

micw523 commented Jul 31, 2019

/kind documentation
/this-is-fine

@k8s-ci-robot
Copy link
Contributor

@micw523: dog image

In response to this:

/kind documentation
/this-is-fine

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Jul 31, 2019
@roycaihw
Copy link
Member

roycaihw commented Aug 1, 2019

I'm fine with adding a paragraph or two to Installation and Troubleshooting. If it will be longer we can have a separate doc and link to it

@fejta-bot
Copy link

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 30, 2019
@micw523
Copy link
Contributor Author

micw523 commented Oct 30, 2019

/lifecycle frozen
/assign
Will tie this to #266

@k8s-ci-robot k8s-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Oct 30, 2019
@micw523 micw523 mentioned this issue Dec 13, 2019
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants