From 7e3c5c355b3268d63e1491a1cd8d815f8912c3e8 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Wed, 26 Sep 2018 15:03:31 +0200 Subject: [PATCH] Update link (#94) * Update link * Add the docs location (fixes #90) --- docs/documentation_index.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/documentation_index.md b/docs/documentation_index.md index 33512d0f..08cc66d1 100644 --- a/docs/documentation_index.md +++ b/docs/documentation_index.md @@ -14,17 +14,17 @@ To test your changes locally, you need to install **Ruby** and its dependencies - [Install Ruby](https://www.ruby-lang.org/en/documentation/installation/) if you don't have it already. Ruby version 2.3.0 or higher is required. - Install `bundler`, a dependency manager for Ruby: `$ gem install bundler` -- In your home-assistant.github.io root directory, run `$ bundle` to install the gems you need. +- In your home-assistant.io root directory, run `$ bundle` to install the gems you need. Shortcut for Fedora: `$ sudo dnf -y install gcc-c++ ruby ruby-devel rubygem-bundler rubygem-json && bundle` Then you can work on the documentation: -- Fork home-assistant.io [git repository](https://github.com/home-assistant/home-assistant.github.io). -- Create/edit/update a page in the directory `source/_components/` for your platform/component. +- Fork home-assistant.io [git repository](https://github.com/home-assistant/home-assistant.io). +- Create/edit/update a page in the directory `source/_components/` for your platform/component. The Home Assistant documention itself is located in the directory `source/_docs/`. - Test your changes to home-assistant.io locally: run `rake preview` and navigate to [http://127.0.0.1:4000](http://127.0.0.1:4000) -- Create a Pull Request (PR) against the **next** branch of home-assistant.github.io if your documentation is a new feature, platform, or component. -- Create a Pull Request (PR) against the **current** branch of home-assistant.github.io if you fix stuff, create Cookbook entries, or expand existing documentation. +- Create a Pull Request (PR) against the **next** branch of home-assistant.io if your documentation is a new feature, platform, or component. +- Create a Pull Request (PR) against the **current** branch of home-assistant.io if you fix stuff, create Cookbook entries, or expand existing documentation. It could be necessary that you run `rake generate` prior to `rake preview` for the very first preview.