Site updated at 2017-02-02 08:13:24 UTC

developers/website/index.html

@@ -148,6 +148,14 @@ Content...Written in markdown.
 
 <p>There are <a href="https://jekyllrb.com/docs/variables/">pre-definied variables</a> available but usually, it’s not necessary to use them when writing documentation.</p>
 
+<p>A couple of points to remember:</p>
+
+<ul>
+  <li>Document the needed steps to retrieve API keys or access token for the third party service or device if needed.</li>
+  <li>Keep the configuration sample minimal by only adding the <code class="highlighter-rouge">Required</code> options. Full configuration details with further explanations should go into a seperate section.</li>
+  <li>The description of all the configuration variables should contains information about the used defaults.</li>
+</ul>
+
 <h3><a class="title-link" name="embedding-code" href="#embedding-code"></a> Embedding Code</h3>
 
 <p>You can use the default markdown syntax to generate syntax highlighted code. For inline code wrap your code in `. For multi-line, syntax wrap your code as shown below.</p>
@@ -179,6 +187,15 @@ Content...Written in markdown.
 </code></pre>
 </div>
 
+<h3><a class="title-link" name="redirects" href="#redirects"></a> Redirects</h3>
+<p>If you rename or move an existing platform or component, create the redirect. Add the old location of the page to the header of the new one.</p>
+
+<pre><code class="language-test">---
+...
+redirect_from: /getting-started/android/
+---
+</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 to their purpose.</p>