Skip to content

Conversation

mcdonnnj
Copy link
Member

@mcdonnnj mcdonnnj commented Feb 7, 2020

🗣 Description

This PR adds instructions for the Windows Subsystem for Linux (WSL) to setup pyenv for development usage. There is also clarification about prerequisites and what lines to add to your .bashrc for Linux installations.

💭 Motivation and Context

While trying to get INL setup with our development practices on WSL there was a lot of troubleshooting. This should make it easier for a new user to get their development environment in line with our practices more easily.

🧪 Testing

I started with a fresh installation of the Ubuntu app on a Windows 10 installation and followed the directions as listed. After completing the pyenv installation I was able to install Python versions 3.8.1, 3.7.6, 3.6.10, and 2.7.17 (latest releases of the 3.8, 3,7, 3,6, and 2.7 major versions) with no issues. Those versions should cover reasonable development situations, but are not exhaustive.

🚥 Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (causes existing functionality to change)

✅ Checklist

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Clarify Linux .bashrc additions.
Add Windows Subsystem for Linux specifics.
@mcdonnnj mcdonnnj requested review from a team, dav3r, felddy and jsf9k as code owners February 7, 2020 18:03
@mcdonnnj mcdonnnj self-assigned this Feb 7, 2020
Copy link
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for writing this up @mcdonnnj - it should be very helpful for the INL team! Please consider my one small comment. 📝

Also clean up line breaking, since these changes will likely be
backported to skeleton-generic.
Copy link
Member

@jsf9k jsf9k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care of this @mcdonnnj!

I added a commit that removed an errant space and also cleaned up the line breaking. I did that because I think these changes should be backported to cisagov/skeleton-generic, so I'd like the formatting to be as clean as possible. I like for the *.md documents to be easily readable as plain text without rendering in Markdown.

@mcdonnnj mcdonnnj added documentation This issue or pull request improves or adds to documentation and removed enhancement labels Feb 10, 2020
@mcdonnnj mcdonnnj merged commit efe5437 into develop Feb 10, 2020
@mcdonnnj mcdonnnj deleted the improvements/add_wsl_instructions branch February 10, 2020 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This issue or pull request improves or adds to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants