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

Updating Developer Docs #1545

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Updating Developer Docs #1545

wants to merge 4 commits into from

Conversation

rhinoella
Copy link
Contributor

@rhinoella rhinoella commented Jul 19, 2023

  • Added instructions for Nix Setup in WSL 2
  • Changed title from "Developing on IDAaas" to "Development Environment" and changed the description to make it less IDAaas-specific

Closes #1538.

@rhinoella rhinoella added the Scope: Documentation Related to documentation label Jul 19, 2023
Copy link
Member

@trisyoungs trisyoungs left a comment

Choose a reason for hiding this comment

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

Looks good - I was expecting the instructions to be way different! Couple of comments, but I've only requested changes because we should rename the file from idaaas.md to nix.md.

web/docs/userguide/developers/idaaas.md Outdated Show resolved Hide resolved
Comment on lines +72 to +79
#### WSL 2

```shell
echo "substituters = https://cache.nixos.org https://dissolve-nix.cachix.org" | sudo tee -a ~/.config/nix/nix.conf
echo "trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= nix-community.cachix.org-1:mB9FSh9qf2dCimDSUo8Zy7bkq5CX+/rkCWyvRCYg3Fs= dissolve-nix.cachix.org-1:b7kp954+mmuowr7XZsAIBugv+xp7+n3aSF/5obidRDE=" | sudo tee -a ~/.config/nix/nix.conf
sudo pkill nix-daemon
```

Copy link
Member

Choose a reason for hiding this comment

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

As far as I can see the only difference here is the file location where the config variables are redirected (/etc/nix/nix.conf vs ~/.config/nix/nix.conf). On Linux we could use the latter as well (i.e. a per-user config) to simplify the instructions although that doesn't quite match up with the use of a multi-user install.

Also, should you be using sudo on WSL2, since you're running everything as the local user, and modifying a file in your home dir?

web/docs/userguide/developers/idaaas.md Outdated Show resolved Hide resolved
rhinoella and others added 2 commits July 23, 2023 10:27
Co-authored-by: Tristan Youngs <tristan.youngs@stfc.ac.uk>
Closes #1538

Co-authored-by: Tristan Youngs <tristan.youngs@stfc.ac.uk>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Scope: Documentation Related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unfinished sentence in documentation
2 participants