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

Streamline setting up dev env #588

Merged
merged 3 commits into from
Jun 25, 2020
Merged

Streamline setting up dev env #588

merged 3 commits into from
Jun 25, 2020

Conversation

balloob
Copy link
Member

@balloob balloob commented Jun 24, 2020

Proposed change

Streamlines setting up a dev env.

  • Remove CentOS instructions
  • Point at Microsoft documentation on how to setup WSL
  • Merge some instructions that could be in 1 line
  • Remove $ from shell command blocks containing a single command
  • Remove venv instructions as it will be part of script/setup
  • Remove logging config as it will be part of script/setup

Requires core PR: home-assistant/core#37075

Type of change

  • Document existing features within Home Assistant
  • 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:

TomBrien
TomBrien previously approved these changes Jun 24, 2020
Copy link
Member

@TomBrien TomBrien 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. Only thing not covered I’ve run into is that if you run script/setup in WSL and then try and commit via Windows you may need to setup pre-commit again in Windows. I think that’s a topic for elsewhere though.


```shell
$ hass
hass -c config
Copy link
Member

Choose a reason for hiding this comment

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

Maybe, we should make the config loading/search of HA look for a local config folder first, next the other options currently already there.

If none exists and config is created, skip the local config folder as a possible option to create the config files.

Copy link
Member Author

Choose a reason for hiding this comment

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

I think that would be too much of a breaking change right now.

frenck
frenck previously approved these changes Jun 25, 2020
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Some small comments, but in general: 🎉

Co-authored-by: Franck Nijhof <git@frenck.dev>
@balloob balloob dismissed stale reviews from frenck and TomBrien via 77a55c2 June 25, 2020 18:37
@balloob balloob merged commit 0ace618 into master Jun 25, 2020
@balloob balloob deleted the dev-env-streamline branch June 25, 2020 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants