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.

Sign up for GitHub

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

FI-1911 Added Documentation for Windows #375

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dad5da1
Added Documentation for Windows
360dgries Jul 24, 2023
c6c7905
Merge branch 'main' into FI-1911-WSL-documentation
arscan Oct 20, 2023
1bb9114
Added information about WSL networking issues
360dgries Oct 24, 2023
28a4a62
Merge branch 'FI-1911-WSL-documentation' of https://github.com/infern…
360dgries Oct 24, 2023
202505c
Merge branch 'main' into FI-1911-WSL-documentation
360dgries Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,10 @@ or
GET http://localhost:4567/inferno/api/test_sessions/TEST_SESSION_ID/results
```

## Running on Windows
Inferno Core requires a WSL instance in order to run. Instructions for setting
that up can be found at the [Inferno Framework documentation](https://inferno-framework.github.io/inferno-core/getting-started.html#development-with-ruby)

## Development in a Ruby console
To get to an interactive console, run `bundle exec bin/inferno console`

Expand Down
3 changes: 3 additions & 0 deletions docs/Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,8 @@ GEM
racc (~> 1.4)
nokogiri (1.14.3-x86_64-darwin)
racc (~> 1.4)
nokogiri (1.14.3-x86_64-linux)
racc (~> 1.4)
octokit (4.25.1)
faraday (>= 1, < 3)
sawyer (~> 0.9)
Expand Down Expand Up @@ -262,6 +264,7 @@ GEM
PLATFORMS
arm64-darwin-21
x86_64-darwin-20
x86_64-linux

DEPENDENCIES
github-pages (~> 227)
Expand Down
21 changes: 19 additions & 2 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,29 @@ Put the `package.tgz` for the IG you're writing tests for in
to the resources needed to validate resources against your IG.

### Development with Ruby

___
**NOTE:** Windows developers will need to use [WSL](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl#install-wsl-2) in order to interact with Inferno. It is recommended that you also follow [the steps for installing node.js](https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-wsl#install-nvm-nodejs-and-npm). Once you have WSL (and node.js) set up:
{: .fs-3}

1. Install VS Code and the [WSL Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-wsl).
1. Install [Ubuntu from the Windows Store](https://www.microsoft.com/store/productId/9PDXGNCFSCZV).
1. Open Command Prompt and run `ubuntu`.
1. You will have to setup a user and password for this linux subsytem.
2. The password will be used for `sudo` commands later, so remember these credentials!
1. Install Docker Desktop for Windows.
1. Follow the steps from Docker to ensure it plays nicely with WSL, see [here](https://docs.docker.com/desktop/wsl/#turn-on-docker-desktop-wsl-2).
2. From the Docker settings, Open Resources > WSL Integration, and make sure Ubuntu is selected. Then, hit "Apply and Restart".
1. From VS Code, press Ctrl + Shift + P to open the command palette, and type "WSL". Select "Connect to WSL in new Window using distro..." and select Ubuntu.
1. Open a terminal in the new WSL window and try to `ping google.com`.
1. If you cannot ping google.com, you may not be able to connect to the internet from within the WSL instance. The steps at [this stack overflow article](https://stackoverflow.com/questions/55649015/could-not-resolve-host-github-com-only-in-windows-bash#:~:text=It%20could%20be%20that%20your%20/etc/resolv.conf%20file%20is%20corrupt%20%2D%20it%20happened%20to%20me!) should resolve the issue. If it does not, open cmd and run `nslookup`. Copy the Default Address, then in your wsl instance type `sudo nano /etc/resolv.conf`. Add the default address as another nameserver.
1. Continue from step 2 in [Installation](#installation).
{: .fs-3 .lh-default}
___
#### Installation
1. Install [Docker](https://www.docker.com/get-started).
1. Install Ruby. It is highly recommended that you install ruby via a [ruby
version
manager](https://www.ruby-lang.org/en/documentation/installation/#managers).
manager](https://www.ruby-lang.org/en/documentation/installation/#managers). Use the manager's documentation for instructions on installing/switching ruby versions, and be sure to download the same ruby version that is in `.ruby-version` in the repo.
1. Install [Docker](https://www.docker.com/get-started).
1. Clone the [Inferno Template
repository](https://github.com/inferno-framework/inferno-template). You can
Expand Down