jeena/home-assistant.github.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Site updated at 2016-04-09 06:05:38 UTC

Browse source
This commit is contained in:
Travis CI 2016-04-09 06:05:38 +00:00
parent c7eefae4a6
commit 6308b09c5f
18 changed files with 282 additions and 243 deletions
Download patch file Download diff file Expand all files Collapse all files

31
developers/index.html
View file

@ -115,19 +115,22 @@
<hr class="divider">
<p>Home Assistant is built from the ground up to be easily-extensible by other developers using components. It uses <a href="https://www.python.org/">Python 3</a> for the backend and <a href="https://www.polymer-project.org/">Polymer (Webcomponents)</a> for the frontend.</p>
<p>Home Assistant is built from the ground up to be easily-extensible by other developers using components. It uses <a href="https://www.python.org/">Python 3</a> for the backend and <a href="https://www.polymer-project.org/">Polymer (Web components)</a> for the frontend.</p>
<p>Home Assistant is open-source and MIT licensed. The source can be found here:</p>
<ul>
<li><a href="https://github.com/balloob/home-assistant">home-assistant</a> - Python server-backend</li>
<li><a href="https://github.com/balloob/home-assistant-js">home-assistant-js</a> - javascript-backend powering the client</li>
<li><a href="https://github.com/balloob/home-assistant">home-assistant</a> - Python server backend</li>
<li><a href="https://github.com/balloob/home-assistant-js">home-assistant-js</a> - JavaScript backend powering the client</li>
<li><a href="https://github.com/balloob/home-assistant-polymer">home-assistant-polymer</a> - Polymer UI</li>
</ul>
<h3><a class="title-link" name="starting-development" href="#starting-development"></a> Starting development</h3>
<p>You will need to set up a development environment if you want to start developing a new feature or component for Home Assistant. Please follow these steps to perform it. Visit the <a href="https://github.com/balloob/home-assistant">the Home Assistant repository</a> first and click fork in the top right.</p>
<p>You will need to set up a development environment if you want to start developing a new feature or component for Home Assistant. Please follow these steps to get setup. <br />
Visit the <a href="https://github.com/balloob/home-assistant">the Home Assistant repository</a> first and click fork in the top right.</p>
<p>We suggest that you setup a <a href="https://docs.python.org/3.4/library/venv.html">virtual environment</a> aka <code>venv</code> before running the setup script.</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre>$ git clone https://github.com/YOUR_GIT_USERNAME/home-assistant.git
@ -138,13 +141,19 @@ $ script/setup
</div>
</div>
<p>We suggest that you setup a <a href="https://docs.python.org/3.4/library/venv.html">virtual environment</a> aka <code>venv</code> before running the setup script.</p>
<p>Testing your work requires <code>tox</code> to be installed:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre>$ pip3 install tox
</pre></div>
</div>
</div>
<p>After following these steps, running <code>hass</code> will invoke your local installation.</p>
<h3><a class="title-link" name="submitting-improvements" href="#submitting-improvements"></a> Submitting improvements</h3>
<p>Improvements to Home Assistant should be submitted one feature at a time using Github pull requests.</p>
<p>Improvements to Home Assistant should be submitted one feature at a time using GitHub <a href="https://help.github.com/articles/using-pull-requests">pull requests</a>.</p>
<ol>
<li>From your fork, create a new branch to hold your changes<br />
@ -155,19 +164,11 @@ $ script/setup
<li>Commit the changes<br />
<code>git add .</code><br />
<code>git commit -m "Added some-feature"</code></li>
<li>Push your commited changes back to your fork on GitHub<br />
<li>Push your committed changes back to your fork on GitHub<br />
<code>git push origin HEAD</code></li>
<li>Follow <a href="https://help.github.com/articles/creating-a-pull-request/">these steps</a> to create your pull request.</li>
</ol>
<p>Note that the above requires <code>tox</code> to be installed. If you don’t have it, do this:</p>
<div class="highlighter-coderay"><div class="CodeRay">
<div class="code"><pre>$ pip3 install tox
</pre></div>
</div>
</div>
<h3><a class="title-link" name="further-reading" href="#further-reading"></a> Further reading</h3>
<ul>

25
developers/website/index.html
View file

@ -115,21 +115,32 @@
<hr class="divider">
<p>The home of Home Assistant is <a href="https://home-assistant.io">https://home-assistant.io</a>. This is the place where we provide documentation and additional details about Home Assistant for end users and developers.</p>
<p>The website you’re reading now is the home of Home Assistant: <a href="https://home-assistant.io">https://home-assistant.io</a>. This is the place where we provide documentation and additional details about Home Assistant for end users and developers.</p>
<p>home-assistant.io is using the <a href="http://octopress.org/">Octopress</a> framework for <a href="http://github.com/mojombo/jekyll">Jekyll</a>. To get more details, please checkout the <a href="http://octopress.org/docs/">documentation</a>. That means that creating a new page is simple. The pages are written in <a href="http://daringfireball.net/projects/markdown/">markdown</a>, you don’t need to care about HTML or alike.</p>
<p>home-assistant.io uses the <a href="http://octopress.org/">Octopress</a> framework for <a href="http://github.com/mojombo/jekyll">Jekyll</a>. To get more details, please checkout the <a href="http://octopress.org/docs/">Octopress documentation</a>. <br />
That means that creating a new page is simple. The pages are written in <a href="http://daringfireball.net/projects/markdown/">markdown</a>; you don’t need to care about HTML or the like.</p>
<p>To work on the website the process is no different to working on Home Assistant itself.</p>
<p>The process for working on the website is no different from working on Home Assistant itself.</p>
<p>To test your changes locally, you need to install the <strong>Ruby</strong> dependencies (gems):</p>
<ul>
<li>Fork the home-assistant.io <a href="https://github.com/balloob/home-assistant.io">git repository</a>.</li>
<li><a href="https://www.ruby-lang.org/en/documentation/installation/">Install Ruby</a> if you don’t have it already.</li>
<li>Install <code>bundler</code>, which is a dependency manager for Ruby: <code>gem install bundler</code></li>
<li>In your home-assistant.io root directory, run <code>bundle</code> to install the gems you need.</li>
</ul>
<p>Then you can work on the documentation:</p>
<ul>
<li>Fork home-assistant.io <a href="https://github.com/balloob/home-assistant.io">git repository</a>.</li>
<li>Create/edit/update a page in the directory <code>source/_components/</code> for your platform/component.</li>
<li>To test changes to home-assistant.io locally, run <code>rake preview</code> and navigate to http://127.0.0.1:4000.</li>
<li>Test your changes to home-assistant.io locally: run <code>rake preview</code> and navigate to <a href="http://127.0.0.1:4000">http://127.0.0.1:4000</a></li>
<li>Create a Pull Request (PR) against the <strong>next</strong> branch of home-assistant.io if your documentation is for a new feature, platform, or component.</li>
<li>Create a Pull Request (PR) against the <strong>master</strong> branch of home-assistant.io if you fix stuff, create Cookbook entries, or expand existing documentation.</li>
</ul>
<p>For a platform page it would be the fastest way to make a copy of an existing page and edit it. The <a href="/components/">component overview</a> is generated automatically, so there is no need to add a link to that your page.</p>
<p>For a platform page, the fastest way is to make a copy of an existing page and edit it. The <a href="/components/">component overview</a> is generated automatically, so there is no need to add a link to your page.</p>
<h3><a class="title-link" name="code" href="#code"></a> Code</h3>
<p>To take advantage of the built-in features of Octopress to display code snippets, just use the default markdown syntax. Please use <code>$</code> and <code>#</code> if it’s a command and to differ from output.</p>
@ -146,7 +157,7 @@
</code></pre>
<h3><a class="title-link" name="images-icons-and-logos" href="#images-icons-and-logos"></a> Images, icons, and logos</h3>
<p>The images which are displayed on the pages are stored in various directories according their purpose.</p>
<p>The images which are displayed on the pages are stored in various directories according to their purpose.</p>
<table>
<thead>