developers.home-assistant icon indicating copy to clipboard operation
developers.home-assistant copied to clipboard

Add WSL2 instructions

Open adamoutler opened this issue 4 years ago • 7 comments
trafficstars

Man, this had me tearing out my hair! I saw a lot of complaints in the forums while searching as well.

Proposed change

Type of change

  • [x] Document existing features within Home Assistant
  • [x] Document new or changing features which there is an existing pull request elsewhere
  • [ ] Spelling or grammatical corrections, or rewording for improved clarity
  • [ ] Changes to the backend of this documentation
  • [ ] Removed stale or deprecated documentation

Additional information

  • This PR fixes or closes issue: fixes #
  • Link to relevant existing code or pull request:

Summary by CodeRabbit

  • Documentation
    • Added detailed instructions for developing the Supervisor, including environment setup with Windows WSL2, tool installation, and development workflow using Visual Studio Code.

adamoutler avatar Feb 15 '21 21:02 adamoutler

Added full reset instructions to begin anew, quick setup instructions, enumerated minimum dependencies, and everything should be good to go factually. It's now a matter of how to present the information.

adamoutler avatar Feb 17 '21 15:02 adamoutler

Should I unwrap the herefile script?

adamoutler avatar Mar 19 '21 21:03 adamoutler

@frenck what are your thoughts on the herefile versus single-line explanation? Should it be a commented script put in here or multiple breaks? As it stands, it is the cleanest format as the set -e prevents further execution if a command fails. The user may then look up the problem. If they copy-paste blocks, as one does, without the wrapping, execution continues until the end with invalid values. Are you sure you want it unwrapped? The wrapping in this case prevents continuing execution after failure.

adamoutler avatar Apr 04 '21 17:04 adamoutler

I already gave feedback on that above.

frenck avatar Apr 04 '21 17:04 frenck

I'm ok with this PR (language/content-wise). However, as said, I'm the proud owner of no-Windows enabled machines for 13 years already. The factual content has to be verified and approved by someone else.

frenck avatar Apr 05 '21 10:04 frenck

Does this still need to be reviewed?

ikifar2012 avatar Jan 07 '22 22:01 ikifar2012

Yes.

adamoutler avatar Jan 07 '22 23:01 adamoutler