From 98a86bb95fa26d7175313a057c5ef004ea73fc57 Mon Sep 17 00:00:00 2001 From: Alec Rust Date: Tue, 29 Jan 2019 18:07:57 +0000 Subject: [PATCH] Improve frontend development setup instructions (#171) * Improve frontend development setup instructions - Currently you recommend cloning the `home-assistant-polymer` repository directly. I assume you should instruct people to fork it, like you do in the [development environment documentation](https://developers.home-assistant.io/docs/en/development_environment.html) - I had some trouble setting `development_repo` in macOS, I believe a trailing slash was necessary in the path. Have updated to a realistic macOS example path * Link to Getting Started instead of macOS install instructions * Revert comment change * Change link to Installation Guide * Adjust link to point to dev setup docs --- docs/frontend_development.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/frontend_development.md b/docs/frontend_development.md index 8030d90e..32da85b9 100644 --- a/docs/frontend_development.md +++ b/docs/frontend_development.md @@ -13,15 +13,18 @@ The Home Assistant frontend is built using web components and powered by the [Po ### Getting the code -First step is to git clone the [home-assistant-polymer repository][hass-polymer]. You can place the repository anywhere on your system. +First step is to fork the [home-assistant-polymer repository][hass-polymer] and add the upstream remote. You can place the forked repository anywhere on your system. ```bash -$ git clone https://github.com/home-assistant/home-assistant-polymer.git +$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant-polymer.git $ cd home-assistant-polymer +$ git remote add upstream https://github.com/home-assistant-polymer/home-assistant-polymer.git ``` ### Configuring Home Assistant +You will need to have an instance of Home Assistant set up. See our guide on [setting up a development environment](https://developers.home-assistant.io/docs/en/development_environment.html). + Next step is to configure Home Assistant to use the development mode for the frontend. Do this by updating the frontend config in your `configuration.yaml` and set the path to the home-assistant-polymer repository that you cloned in the last step: ```yaml