mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-15 05:16:28 +00:00
Prepend rake with bundle exec (#129)
It's highly advisable to run the bundled rake version to prevent errors like `Gem::LoadError: You have already activated rake 12.3.1, but your Gemfile requires rake 10.5.0. Prepending `bundle exec` to your command may solve this.`
This commit is contained in:
parent
b0d075b956
commit
c9bd65dc24
@ -25,13 +25,13 @@ Then you can work on the documentation:
|
||||
|
||||
- Fork home-assistant.io [git repository](https://github.com/home-assistant/home-assistant.io).
|
||||
- Create/edit/update a page. The components/platforms documentation is located in `source/_components/`. `source/_docs/` contains the Home Assistant documentation itself.
|
||||
- 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)
|
||||
- Test your changes to home-assistant.io locally: run `bundle exec 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.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.
|
||||
It could be necessary that you run `bundle exec rake generate` prior to `bundle exec rake preview` for the very first preview.
|
||||
|
||||
Site generated by `rake` is only available locally. If you are developing on a headless machine, use port forwarding:
|
||||
Site generated by `bundle exec rake` is only available locally. If you are developing on a headless machine, use port forwarding:
|
||||
|
||||
```bash
|
||||
$ ssh -L 4000:localhost:4000 user_on_headless_machine@ip_of_headless_machine
|
||||
|
Loading…
x
Reference in New Issue
Block a user