Website fixes (Part 1) (#223)

* Fixed base template - Made responsive for small screens - Added DOCTYPE - Added meta charset * Added page titles * Beautified CSS
2024-12-24 08:42:24 +08:00 · 2017-10-11 08:33:17 -04:00 · 2017-10-11 08:33:17 -04:00 · a202b8ae53
commit a202b8ae53
parent 2cfd67e4fa
27 changed files with 141 additions and 103 deletions
--- a/docs/_layouts/default.html
+++ b/docs/_layouts/default.html
@ -1,3 +1,4 @@
+<!DOCTYPE html>
 <html>

 <head>
@ -10,9 +11,12 @@
        crossorigin="anonymous"></script>
    <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js" integrity="sha384-0mSbJDEHialfmuBBQP6A4Qrprq5OVfW37PRR3j5ELqxss1yVqOtnepnHVP9aJ7xS"
        crossorigin="anonymous"></script>
-     <link rel="stylesheet" href="{{site.github.url}}/css/site.css">
+    <link rel="stylesheet" href="{{site.github.url}}/css/site.css">
    <link rel="stylesheet" href="{{site.github.url}}/css/syntax.css">
-
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta http-equiv="X-UA-Compatible" content="ie=edge">
+    <title>{{ page.title }}</title>
 </head>

 <body>
@ -20,11 +24,11 @@
        <div class="container">
            <div class="navbar-header">
                <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#nav-collapse" aria-expanded="false">
-        <span class="sr-only">Toggle navigation</span>
-        <span class="icon-bar"></span>
-        <span class="icon-bar"></span>
-        <span class="icon-bar"></span>
-      </button>
+                    <span class="sr-only">Toggle navigation</span>
+                    <span class="icon-bar"></span>
+                    <span class="icon-bar"></span>
+                    <span class="icon-bar"></span>
+                </button>
                <a class="navbar-brand" href="{{site.github.url}}/">
                    DNSControl
                </a>
@ -36,27 +40,27 @@
                    <li><a href="{{site.github.url}}/provider-list">Providers</a></li>
                    <li>
                        <a href="https://github.com/StackExchange/dnscontrol" style="padding:10px 12px"><span class="fa fa-github fa-2x" aria-hidden="true"></span></a>
-</li>
-</ul>
-</div>
-</div>
-</nav>
-<div class='container'>
-    {{ content}}
-</div>
+                    </li>
+                </ul>
+            </div>
+        </div>
+    </nav>
+    <div class='container'>
+        {{ content }}
+    </div>

- {% comment %} This script makes the examples collapse appropriately {% endcomment %}
+    {% comment %} This script makes the examples collapse appropriately {% endcomment %}

-<script>
-    $('.example-collapse').click(function (e) {
-        e.preventDefault();
-        $(this).parent().next().collapse('toggle');
-        $(this).toggleClass('expanded')
-    });
-    $(function () {
-        $('[data-toggle="tooltip"]').tooltip()
-    })
-</script>
+    <script>
+        $('.example-collapse').click(function (e) {
+            e.preventDefault();
+            $(this).parent().next().collapse('toggle');
+            $(this).toggleClass('expanded')
+        });
+        $(function () {
+            $('[data-toggle="tooltip"]').tooltip()
+        })
+    </script>
 </body>

-</html>
+</html>
--- a/docs/_providers/activedir.md
+++ b/docs/_providers/activedir.md
@ -2,6 +2,7 @@
 name: ActiveDirectory_PS
 layout: default
 jsId: ACTIVEDIRECTORY_PS
+title: ActiveDirectory_PS Provider
 ---
 # ActiveDirectory_PS Provider

--- a/docs/_providers/bind.md
+++ b/docs/_providers/bind.md
@ -1,9 +1,10 @@
 ---
-name: Bind
+name: BIND
+title: BIND Provider
 layout: default
 jsId: BIND
 ---
-# Bind Provider
+# BIND Provider

 This provider simply maintains a directory with a collection of .zone files. We currently copy zone files to our production servers and restart bind via
 a script external to DNSControl.
--- a/docs/_providers/cloudflare.md
+++ b/docs/_providers/cloudflare.md
@ -1,5 +1,6 @@
 ---
 name: Cloudflare
+title: Cloudflare Provider
 layout: default
 jsId: CLOUDFLAREAPI
 ---
--- a/docs/_providers/digitalocean.md
+++ b/docs/_providers/digitalocean.md
@ -1,9 +1,10 @@
 ---
-name: Digitalocean
+name: DigitalOcean
+title: DigitalOcean Provider
 layout: default
 jsId: DIGITALOCEAN
 ---
-# Digitalocean Provider
+# DigitalOcean Provider

 ## Configuration

--- a/docs/_providers/dnsimple.md
+++ b/docs/_providers/dnsimple.md
@ -1,10 +1,10 @@
 ---
-name: Dnsimple
+name: DNSimple
+title: DNSimple Provider
 layout: default
 jsId: DNSIMPLE
 ---
-# Dnsimple Provider
-
+# DNSimple Provider
 ## Configuration

 In your providers config json file you must provide a DNSimple account access token:
--- a/docs/_providers/gandi.md
+++ b/docs/_providers/gandi.md
@ -1,5 +1,6 @@
 ---
 name: Gandi
+title: Gandi Provider
 layout: default
 jsId: GANDI
 ---
--- a/docs/_providers/gcloud.md
+++ b/docs/_providers/gcloud.md
@ -1,10 +1,11 @@
 ---
-name: "Google cloud DNS"
+name: Google Cloud DNS
+title: Google Cloud DNS Provider 
 layout: default
 jsId: GCLOUD
 ---

-# Google cloud DNS Provider
+# Google Cloud DNS Provider

 ## Configuration

--- a/docs/_providers/name.com.md
+++ b/docs/_providers/name.com.md
@ -1,5 +1,6 @@
 ---
-name: "Name.com"
+name: Name.com
+title: Name.com Provider
 layout: default
 jsId: NAMEDOTCOM
 ---
--- a/docs/_providers/namecheap.md
+++ b/docs/_providers/namecheap.md
@ -1,5 +1,5 @@
 ---
-name: "Namecheap"
+name: Namecheap Provider
 layout: default
 jsId: NAMECHEAP
 ---
--- a/docs/_providers/ns1.md
+++ b/docs/_providers/ns1.md
@ -1,5 +1,6 @@
 ---
 name: NS1
+title: NS1 Provider
 layout: default
 jsId: NS1
 ---
--- a/docs/_providers/softlayer.md
+++ b/docs/_providers/softlayer.md
@ -1,5 +1,6 @@
 ---
-name: "SoftLayer DNS"
+name: SoftLayer DNS
+title: SoftLayer DNS Provider
 layout: default
 jsId: SOFTLAYER
 ---
@ -8,7 +9,7 @@ jsId: SOFTLAYER

 ## Configuration

-To authenticate with softlayer requires at least a `username` and `api_key` for authentication.
+To authenticate with SoftLayer requires at least a `username` and `api_key` for authentication.
 It can also optionally take a `timeout` and `endpoint_url` parameter however these are optional and will use standard defaults if not provided.
 These can be supplied via the standard 'creds.json' like so:
 {% highlight json %}
--- a/docs/adding-new-rtypes.md
+++ b/docs/adding-new-rtypes.md
@ -1,8 +1,9 @@
 ---
 layout: default
+title: Creating new DNS Resource Types (rtypes)
 ---

-# Creating new DNS Resource Types (Rtypes)
+# Creating new DNS Resource Types (rtypes)

 Everyone is familiar with A, AAAA, CNAME, NS and other Rtypes.
 However there are new record types being added all the time (possibly
--- a/docs/alias.md
+++ b/docs/alias.md
@ -1,8 +1,9 @@
 ---
 layout: default
+title: ALIAS Records
 ---

-# ALIAS records
+# ALIAS Records

 ALIAS records are not widely standardized across DNS providers. Some (Route 53, DNSimple) have a native ALIAS record type. Others (Cloudflare) implement transparent CNAME flattening.

--- a/docs/css/site.css
+++ b/docs/css/site.css
@ -1,76 +1,83 @@
-.expanded > .expand-arrow {
-   display: none;
+.expanded>.expand-arrow {
+  display: none;
 }

-.expanded > .collapse-arrow {
-    display: inherit;
+.expanded>.collapse-arrow {
+  display: inherit;
 }

 .collapse-arrow {
-    display:none;
+  display: none;
 }

 body {
-    padding-bottom: 50px;
+  padding-bottom: 50px;
 }

 .table-header-rotated {
-    border-collapse: collapse;
-  }
+  border-collapse: collapse;
+}

-  .table-header-rotated td {
-    width: 30px;
-  }
+.table-header-rotated td {
+  width: 30px;
+}

-  .table-header-rotated th {
-    padding: 5px 10px;
-  }
+.table-header-rotated th {
+  padding: 5px 10px;
+}

-  .table-header-rotated td {
-    text-align: center;
-    padding: 10px 5px;
-    border: 1px solid #ccc;
-  }
+.table-header-rotated td {
+  text-align: center;
+  padding: 10px 5px;
+  border: 1px solid #ccc;
+}

-  .table-header-rotated th.rotate {
-    height: 140px;
-    white-space: nowrap;
-  }
+.table-header-rotated th.rotate {
+  height: 140px;
+  white-space: nowrap;
+}

-  .table-header-rotated th.rotate>div {
-    -webkit-transform: translate(25px, 51px) rotate(315deg);
-    -ms-transform: translate(25px, 51px) rotate(315deg);
-    transform: translate(25px, 51px) rotate(315deg);
-    width: 30px;
-  }
+.table-header-rotated th.rotate>div {
+  -webkit-transform: translate(25px, 51px) rotate(315deg);
+  -ms-transform: translate(25px, 51px) rotate(315deg);
+  transform: translate(25px, 51px) rotate(315deg);
+  width: 30px;
+}

-  .table-header-rotated th.rotate>div>span {
-    border-bottom: 1px solid #ccc;
-    padding: 5px 10px;
-  }
+.table-header-rotated th.rotate>div>span {
+  border-bottom: 1px solid #ccc;
+  padding: 5px 10px;
+}

-  .table-header-rotated th.row-header {
-    padding: 0 10px;
-    border-bottom: 1px solid #ccc;
-  }
-  .success {
-    background-color: #dff0d8;
-  }
-  .warning {
-    background-color: #faf2cc;
-  }
-  .danger {
-    background-color: #f2dede;
-  }
-  .info {
-    background-color: #d9edf7;
-  }
-  .fa {
-    font-size: 150%;
-  }
-  .has-tooltip:before{
-    text-decoration: underline;
-  }
-  .dim {
-    color: #eeeeee
-  }
+.table-header-rotated th.row-header {
+  padding: 0 10px;
+  border-bottom: 1px solid #ccc;
+}
+
+.success {
+  background-color: #dff0d8;
+}
+
+.warning {
+  background-color: #faf2cc;
+}
+
+.danger {
+  background-color: #f2dede;
+}
+
+.info {
+  background-color: #d9edf7;
+}
+
+.fa {
+  font-size: 150%;
+}
+
+.has-tooltip:before {
+  text-decoration: underline;
+}
+
+.dim {
+  color: #eeeeee
+}
--- a/docs/examples.md
+++ b/docs/examples.md
@ -1,5 +1,6 @@
 ---
 layout: default
+title: Examples
 ---

 # Examples
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@ -1,5 +1,6 @@
 ---
 layout: default
+title: Getting Started
 ---
 # Getting Started

--- a/docs/index.md
+++ b/docs/index.md
@ -1,5 +1,6 @@
 ---
 layout: default
+title: DnsControl
 ---

 <div class="row jumbotron">
@ -81,7 +82,7 @@ layout: default

 			<ul>
 				<li>
-          <a href="{{site.github.url}}/getting-started">Getting Started</a>: A walk-through of the basics
+          			<a href="{{site.github.url}}/getting-started">Getting Started</a>: A walk-through of the basics
 				</li>
 				<li>
 					<a href="{{site.github.url}}/provider-list">Providers</a>: Which DNS providers are supported
--- a/docs/js.md
+++ b/docs/js.md
@ -1,5 +1,6 @@
 ---
 layout: default
+title: JavaScript DSL
 ---

 # Javascript DSL
--- a/docs/migrating.md
+++ b/docs/migrating.md
@ -1,5 +1,6 @@
 ---
 layout: default
+title: Migrating zones to DNSControl
 ---

 # Migrating zones to DNSControl
--- a/docs/nameservers.md
+++ b/docs/nameservers.md
@ -1,8 +1,9 @@
 ---
 layout: default
+title: Namservers
 ---

-# Nameservers in DNSControl
+# Nameservers

 DNSControl can handle a variety of provider scenarios for you:

--- a/docs/provider-list.md
+++ b/docs/provider-list.md
@ -1,7 +1,8 @@
 ---
 layout: default
+title: Service Providers
 ---
-<h1> Service providers </h1>
+<h1> Service Providers </h1>

 <table class='table table-bordered'>
  <thead>
--- a/docs/release-engineering.md
+++ b/docs/release-engineering.md
@ -1,3 +1,8 @@
+---
+layout: default
+title: How to build and ship a release
+---
+
 # How to build and ship a release

 Here are my notes from producing the v0.2.2 release.  Change the version number as appropriate.
--- a/docs/toc.md
+++ b/docs/toc.md
@ -1,5 +1,6 @@
 ---
 layout: default
+title: TOC
 ---

 ## Getting Started
--- a/docs/unittests.md
+++ b/docs/unittests.md
@ -1,5 +1,6 @@
 ---
 layout: default
+title: Unit Testing DNS Data
 ---

 # Unit Testing DNS Data
--- a/docs/why-the-dot.md
+++ b/docs/why-the-dot.md
@ -1,5 +1,6 @@
 ---
 layout: default
+title: Why CNAME/MX/NS targets require a "dot"
 ---

 # Short version
--- a/docs/writing-providers.md
+++ b/docs/writing-providers.md
@ -1,5 +1,6 @@
 ---
 layout: default
+title: Writing new DNS providers
 ---

 # Writing new DNS providers