From 5aa2e1d83cb76c800857c0aaba634a4691a8da2c Mon Sep 17 00:00:00 2001 From: WofWca Date: Fri, 5 Oct 2018 20:21:49 +0700 Subject: [PATCH] Mention Netlify preview, move sentences --- docs/documentation_index.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/documentation_index.md b/docs/documentation_index.md index ab10f1c4..09e15302 100644 --- a/docs/documentation_index.md +++ b/docs/documentation_index.md @@ -6,9 +6,11 @@ The user documentation is located at [https://www.home-assistant.io](https://www The [home-assistant.io](https://home-assistant.io) website is built using [Jekyll](http://github.com/mojombo/jekyll) and [these dependencies](https://pages.github.com/versions/). The pages are written in [Markdown](http://daringfireball.net/projects/markdown/). To add a page, you don't need to know HTML. -You can use the "**Edit this page on GitHub**" link to edit pages without creating a fork. Keep in mind that you can't upload images while working this way. +You can use the "**Edit this page on GitHub**" link to edit pages without creating a fork. Keep in mind that you can't upload images while working this way. You work on your change and propose it via a Pull Request (PR). -For larger changes, we suggest that you clone the website repository. This way, you can review your changes locally. The process of working on the website is no different from working on Home Assistant itself. You work on your change and propose it via a Pull Request (PR). +Once you've created a Pull Request (PR), you can see a preview of the proposed changes by clicking *Details* against Netlify checker in the checkers section of the PR as soon as deployment is complete. + +For larger changes, we suggest that you clone the website repository. This way, you can review your changes locally. The process of working on the website is no different from working on Home Assistant itself. To test your changes locally, you need to install **Ruby** and its dependencies (gems): @@ -33,4 +35,3 @@ Site generated by `rake` is only available locally. If you are developing on a h ```bash $ ssh -L 4000:localhost:4000 user_on_headless_machine@ip_of_headless_machine ``` -