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

FI-1911 Added Documentation for Windows #375

Merged
merged 5 commits into from
Oct 24, 2023
Merged

Conversation

360dgries
Copy link
Contributor

Summary

Text blurb on WSL2 setup included in the "Getting Started" page of the docs, as well as a reference to the section in the README. Wasn't sure on the formatting desired.

Testing Guidance

Check the links (?) Otherwise no tests needed I don't think.

@codecov
Copy link

codecov bot commented Jul 24, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (604b6e7) 77.00% compared to head (202505c) 77.00%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #375   +/-   ##
=======================================
  Coverage   77.00%   77.00%           
=======================================
  Files         214      214           
  Lines       10708    10708           
  Branches      991      991           
=======================================
  Hits         8246     8246           
  Misses       1884     1884           
  Partials      578      578           
Flag Coverage Δ
backend 94.35% <ø> (ø)
frontend 69.75% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bmath10 bmath10 requested a review from arscan August 16, 2023 15:21
Copy link
Contributor

@arscan arscan left a comment

Choose a reason for hiding this comment

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

Finally walked through these steps in my Windows machine. Looks good. My machine was already configured so I couldn't confirm all the steps, per-se, but this has all the information someone would need to get started with WSL if they haven't yet used it. And if it isn't, I'm not sure how much more explaination here would help (and we are obviously open here to feedback if someone is having trouble).

One thing that I do that is a little different than this, is just open the ubuntu terminal and run code . in the folder that I want to us VS Code in, and Windows automagically runs VS Code in a Windows window but opens a prompt back to the WSL container and synchronizes any changes back to that filesystem. But I bet there lots of different ways of doing this.

@360dgries 360dgries merged commit 0644bc0 into main Oct 24, 2023
10 checks passed
@360dgries 360dgries deleted the FI-1911-WSL-documentation branch October 24, 2023 18:40
@rpassas rpassas mentioned this pull request Oct 27, 2023
@360dgries 360dgries changed the title Added Documentation for Windows FI-1911 Added Documentation for Windows Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants