Improve Windows Developer Environment [DOCS]
Open
Nobody has claimed this yet.
documentation
severity-medium
time-estimate-long-term
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Right now, we do not have good docs on how to install a salt dev environment on Windows.
We need to write a how to use build_env.ps1 salt/build_env.ps1 at master · saltstack/salt (github.com).
.ps1 script likes to hang and you need to restart PowerShell several times before salt will run.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading salt/build_env.ps1 and running it in a Windows PowerShell environment to observe the setup flow and reported hangs. Document how to use the script to create a Salt development environment, including the need to restart PowerShell when Salt does not run. Done means a newcomer can follow the Windows setup instructions successfully.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell, python
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100