Possible confusion in the installation guide

README.md

@@ -1,8 +1,42 @@
 # Lightning Network Daemon Developer Site
-Documentation for the Lightning Network Daemon
+Developer guides and resources for the Lightning Network Daemon
+
+## Overview
+
+This repository contains functionality for programmatically pulling guides from
+the lnd repo, using a Python script and Jinja2 templates to output markdown
+files, which are the corresponding pages in the fully rendered Jekyll static
+site. 
+
+Pay special attention to these files:
+- `templates/base.md`: The Jinja2 template fed into the Python
+  script, holding the Jeykll header to be prepended to the guide content pulled
+  from Github. The `templates` dir also holds the templates for special cases
+  where for example a dev site-specific footer needs to be appended
+- `update_and_render.sh`: Update local guides to the latest version available
+- `render.py`: The Python script that uses local guides and Jinja template to
+  strip out redundant titles, add page headers/footers, and output Jekyll
+  markdown
+- `deploy.sh`: Build static site from Jekyll markdown and deploy to Google Cloud
+  Platform
+
+The rest of the files in this repo are the standard Jekyll site files.
 
 ## Running the site locally
 
+### Prerequisites
+
+You're going to need:
+
+ - **Linux or OS X** — Windows may work, but is unsupported.
+ - **Ruby, version 2.2.5 or newer**
+ - **Bundler** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal.
+
+### Running locally
+
+```shell
+git clone https://github.com/lightninglabs/lightning-dev-site
+```
 Install Jekyll:
 ```
 $ gem install jekyll bundler
@@ -11,23 +45,65 @@ Run the site and watch for changes:
 ```
 $ bundle exec jekyll serve
 ```
+* If running remotely add: `--host=0.0.0.0`
 
-## Deployment
 
-The Lightning Dev Site is deployed with `s3_website`. Visit their [github
-repo](https://github.com/laurilehmijoki/s3_website) for more information.
+## Regenerating documentation
 
-### Steps
+```shell
+# Install Jinja for python templating
+pip install Jinja2
+```
+
+### Get the latest INSTALL.md
+```shell
+curl -o INSTALL.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docs/INSTALL.md
+```
+
+### Fetch the latest Docker guide
+```shell
+curl -o DOCKER-README.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docker/README.md
+```
 
-1. Add the deployment credentials for `s3_config.yml`
+### Get the latest gRPC guides
+```shell
+curl -o python.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docs/grpc/python.md
+curl -o javascript.md -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/docs/grpc/javascript.md
 ```
-$ export LN_S3_ID="YOUR_S3_ID"
-$ export LN_S3_SECRET="YOUR_S3_SECRET"
-$ export LN_CLOUDFRONT_DISTRIBUTION_ID="YOUR_CLOUDFRONT_DISTRIBUTION_ID"
+
+Let's run the script to render the guides:
+```shell
+python render.py
 ```
 
-2. Deploy the site from local changes:
+Now that you're all set up, you can just run `./update_and_render.sh` to
+automatically pull the latest markdown files and render the local Jekyll docs.
+
+## Deployment
+
+The Lightning API is deployed with Google Cloud Platform. Visit [this blog
+post](https://little418.com/2015/07/jekyll-google-cloud-storage.html) for more
+information.
 
+### Steps
+
+1. Install Google Cloud SDK and authenticate into it:
+```bash
+brew cask install google-cloud-sdk
+gcloud auth login
+```
+
+2. Build
+```bash
+bundle exec jekyll build
 ```
-s3_website push
+
+3. Push to Google Cloud Bucket
+```bash
+# -m use faster multithreaded uploads
+# -d delete remote files that aren't in the source
+# -r recurse into source subdirectories
+gsutil -m rsync -d -r ./_site gs://dev.lightning.community
 ```
+
+In the future, you can just run `./deploy.sh` to deploy automatically.

_config.yml

@@ -14,14 +14,13 @@
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
 title: Lightning Network Developers
-email: [email protected]
+email: [email protected]
 description: > # this means to ignore newlines until "baseurl:"
-  Developer resources, documentation, and education for the Lightning Network
-  Daemon.
+  Developer resources and documentation for the Lightning Network Daemon.
 baseurl: "" # the subpath of your site, e.g. /blog
-url: "" # the base hostname & protocol for your site, e.g. http://example.com
+url: "http://dev.lightning.community" # the base hostname & protocol for your site, e.g. http://example.com
 twitter_username: lightning
-github_username: lightninglabs
+github_username: lightningnetwork/lnd
 
 # Build settings
 markdown: kramdown
@@ -34,11 +33,15 @@ permalink: pretty
 # Exclude from processing.
 # The following items will not be processed, by default. Create a custom list
 # to override the default setting.
-# exclude:
-#   - Gemfile
-#   - Gemfile.lock
-#   - node_modules
-#   - vendor/bundle/
-#   - vendor/cache/
-#   - vendor/gems/
-#   - vendor/ruby/
+exclude:
+  - Gemfile
+  - Gemfile.lock
+  - node_modules
+  - vendor/bundle/
+  - vendor/cache/
+  - vendor/gems/
+  - vendor/ruby/
+  - templates
+  - render.py
+  - update_and_render.sh
+  - s3_website.yml

_includes/footer.html

@@ -0,0 +1,49 @@
+<footer class="site-footer">
+
+  <div class="wrapper">
+
+    <div class="footer-col-wrapper">
+      <div class="footer-col footer-col-1">
+        <ul class="contact-list">
+          <li>
+          <li>
+            {% if site.author %}
+              {{ site.author | escape }}
+            {% else %}
+              {{ site.title | escape }}
+            {% endif %}
+            </li>
+            {% if site.email %}
+            <li>
+              <a href="mailto:{{ site.email }}">
+                <span>{{ site.email }}</span>
+              </a>
+            </li>
+            {% endif %}
+        </ul>
+      </div>
+
+      <div class="footer-col footer-col-2">
+        <ul class="social-media-list">
+          {% if site.github_username %}
+          <li>
+            {% include icon-github.html username=site.github_username %}
+          </li>
+          {% endif %}
+
+          {% if site.twitter_username %}
+          <li>
+            {% include icon-twitter.html username=site.twitter_username %}
+          </li>
+          {% endif %}
+        </ul>
+      </div>
+
+      <div class="footer-col footer-col-3">
+        <p>{{ site.description | escape }}</p>
+      </div>
+    </div>
+
+  </div>
+
+</footer>

_includes/head.html

@@ -0,0 +1,17 @@
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="X-UA-Compatible" content="IE=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
+  <title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
+  <meta name="description" content="{{ page.excerpt | default: site.description | strip_html | normalize_whitespace | truncate: 160 | escape }}">
+
+  <link rel="stylesheet" href="{{ "/assets/main.css" | relative_url }}">
+  <link rel="stylesheet" href="{{ "/assets/dropdown.css" | relative_url }}">
+  <link rel="canonical" href="{{ page.url | replace:'index.html','' | absolute_url }}">
+  <link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ "/feed.xml" | relative_url }}">
+
+  {% if jekyll.environment == 'production' and site.google_analytics %}
+  {% include google-analytics.html %}
+  {% endif %}
+</head>

_includes/header.html

@@ -4,7 +4,7 @@
     {% assign default_paths = site.pages | map: "path" %}
     {% assign page_paths = site.header_pages | default: default_paths %}
     <a class="site-title" href="{{ "/" | relative_url }}">{{ site.title | escape }}</a>
-  
+
     {% if page_paths %}
       <nav class="site-nav">
         <input type="checkbox" id="nav-trigger" class="nav-trigger" />
@@ -19,8 +19,18 @@
         </label>
 
         <div class="trigger">
-          <a class="page-link" onclick="alert('kek')" href="">Learn</a>
-          <a class="page-link" onclick="alert('ico')" href="">Develop</a>
+          <div class="dropdown">
+            <a class="page-link" href="/guides"><button class="dropbtn">Guides</button></a>
+            <div class="dropdown-content">
+              <a href="/overview/">Overview</a>
+              <a href="/guides/installation/">Installation</a>
+              <a href="/tutorial/">Tutorial</a>
+              <a href="/guides/python-grpc/">Python</a>
+              <a href="/guides/javascript-grpc/">Javascript</a>
+              <a href="/guides/docker/">Docker</a>
+            </div>
+          </div>
+          <a class="page-link" href="//api.lightning.community">API</a>
         </div>
       </nav>
     {% endif %}

_includes/icon-github.html

@@ -0,0 +1 @@
+<a href="https://github.com/{{ include.username }}"><span class="icon icon--github">{% include icon-github.svg %}</span><span class="username">lnd</span></a>

_layouts/home.html

@@ -4,15 +4,92 @@
 
 <div class="home">
 
-  <h1 class="page-heading">Building on the Lightning Network Daemon</h1>
-  <p>New to lnd?
-    <a href="/installation/">Installation</a> and
-    <a href="/tutorial/">Tutorial</a>
+  <h1 class="page-heading">LND Developer Site</h1>
+
+  <section>
+    <p>Resources and documentation for the
+      <a href="https://github.com/lightningnetwork/lnd">Lightning Network Daemon (LND)</a>
+    </p>
+  </section>
+
+  <section class="page-content">
+    <h2>Learn</h2>
+    <p>New to LND?
+      <a href="/overview/">Overview</a>,
+      <a href="/guides/installation/">Installation</a>, and
+      <a href="/tutorial/">Tutorial</a>
+    </p>
+    <p>Curious about the Lightning Network? <a href="/resources/">Resources</a></p>
+  </section>
+
+  <section class="page-content">
+    <h2>Develop</h2>
+    <p>Looking for detailed dev manuals? <a href="/guides/">Developer Guides</a></p>
+    <p>API Reference Documentation? <a href="//api.lightning.community">API site</a></p>
+    <p>Want to help build the future? <a href="/contribute/">Contribute</a></p>
+    <p>Looking to read the code? <a href="https://github.com/lightningnetwork/lnd">Github</a></p>
+  </section>
+
+  <section class="page-content">
+  <h2>Community</h2>
+  <p>Follow the
+    <a href="//lightning.community">Lightning Labs community blog</a>
+    to keep posted about LND.
   </p>
-  <p>Need a reference? <a href="/docs/">Documentation</a></p>
-  <p>Want to learn about Lightning Network? <a href="/resources/">Resources</a></p>
-  <p>Want to help build the future? <a href="/contribute/">Contribute</a></p>
-
-  {{ content }}
+  <p>Join the 
+    <a href="https://lightning.engineering/slack.html">LND Developer Slack</a>
+    to meet the team, discuss development, and hang out!
+  </p>
+  </section>
+
+  <section class="page-content">
+    <h2>Ecosystem</h2>
+    <p>See the cool apps and wallets built on Lightning: <a href="/lapps/">Lapp directory</a></p>
+  </section>
+
+  <section class="page-content">
+    <h1>Overview</h1>
+    <p>
+      The Lightning Network scales blockchains and enables trustless instant
+      payments by keeping most transactions off-chain and leveraging the
+      security of the underlying blockchain as an arbitration layer.
+    </p>
+    <p>
+      This is accomplished primarily through "payment-channels", wherein two
+      parties commit funds and pay each other by updating the balance
+      redeemable by either party in the channel. This process is instant and
+      saves users from having to wait for block confirmations before they can
+      render goods or services.
+    </p>
+    <p>
+      Payment channels are trustless, since any attempt to defraud the current
+      agreed-upon balance in the channel results in the complete forfeiture of
+      funds by the liable party.
+    </p>
+    <p>
+      By moving payments off-chain, the cost of opening and closing channels
+      (in the form of on-chain transaction fees) is ammortized over the volume
+      of payments in that channel, enabling micropayments and small-value
+      transactions for which the on-chain transaction fees would otherwise be
+      too expensive to justify.  Furthermore, the Lightning Network scales not
+      with the transaction throughput of the underlying blockchain, but with
+      modern data processing and latency limits - payments can be made nearly
+      as quickly as packets can be sent.
+    </p>
+    <p>
+      Hash Time-Locked Contracts (HTLCs) allow transactions to be sent between
+      parties who do not have a direct channels by routing it through multiple
+      hops, so anyone connected to the Lightning Network is part of a single,
+      interconnected global financial system.
+    </p>
+    <p>
+      In short, the Lightning Network enables scalable blockchains through a
+      high-volume of instant transactions not requiring custodial delegation.
+    </p>
+    <p>
+      Continue reading at the full <a href="/overview/">LND Overview and
+        Developer Guide</a>.
+    </p>
+  </section>
 
 </div>