From a202b8ae530ea76c2ea0ae2d7087ff185695e96d Mon Sep 17 00:00:00 2001 From: Patrick G Date: Wed, 11 Oct 2017 08:33:17 -0400 Subject: [PATCH] Website fixes (Part 1) (#223) * Fixed base template - Made responsive for small screens - Added DOCTYPE - Added meta charset * Added page titles * Beautified CSS --- docs/_layouts/default.html | 58 ++++++++------- docs/_providers/activedir.md | 1 + docs/_providers/bind.md | 5 +- docs/_providers/cloudflare.md | 1 + docs/_providers/digitalocean.md | 5 +- docs/_providers/dnsimple.md | 6 +- docs/_providers/gandi.md | 1 + docs/_providers/gcloud.md | 5 +- docs/_providers/name.com.md | 3 +- docs/_providers/namecheap.md | 2 +- docs/_providers/ns1.md | 1 + docs/_providers/softlayer.md | 5 +- docs/adding-new-rtypes.md | 3 +- docs/alias.md | 3 +- docs/css/site.css | 123 +++++++++++++++++--------------- docs/examples.md | 1 + docs/getting-started.md | 1 + docs/index.md | 3 +- docs/js.md | 1 + docs/migrating.md | 1 + docs/nameservers.md | 3 +- docs/provider-list.md | 3 +- docs/release-engineering.md | 5 ++ docs/toc.md | 1 + docs/unittests.md | 1 + docs/why-the-dot.md | 1 + docs/writing-providers.md | 1 + 27 files changed, 141 insertions(+), 103 deletions(-) diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 370a6be2f..73e57f3c3 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -1,3 +1,4 @@ + @@ -10,9 +11,12 @@ crossorigin="anonymous"> - + - + + + + {{ page.title }} @@ -20,11 +24,11 @@
+ Toggle navigation + + + + DNSControl @@ -36,27 +40,27 @@
  • Providers
  • -
    • - -
    -
    - -
    - {{ content}} -
    + + + + + +
    + {{ content }} +
    - {% comment %} This script makes the examples collapse appropriately {% endcomment %} + {% comment %} This script makes the examples collapse appropriately {% endcomment %} - + - + \ No newline at end of file diff --git a/docs/_providers/activedir.md b/docs/_providers/activedir.md index 170624a03..7ccc4f24f 100644 --- 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 diff --git a/docs/_providers/bind.md b/docs/_providers/bind.md index 5d4fc8811..896b87dcb 100644 --- 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. diff --git a/docs/_providers/cloudflare.md b/docs/_providers/cloudflare.md index b3917a344..d04038fb7 100644 --- a/docs/_providers/cloudflare.md +++ b/docs/_providers/cloudflare.md @@ -1,5 +1,6 @@ --- name: Cloudflare +title: Cloudflare Provider layout: default jsId: CLOUDFLAREAPI --- diff --git a/docs/_providers/digitalocean.md b/docs/_providers/digitalocean.md index c28dd1127..7c7e6ffba 100644 --- 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 diff --git a/docs/_providers/dnsimple.md b/docs/_providers/dnsimple.md index d9cc3e079..8ff7ed2cc 100644 --- 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: diff --git a/docs/_providers/gandi.md b/docs/_providers/gandi.md index 6bcaab3da..ef564b99c 100644 --- a/docs/_providers/gandi.md +++ b/docs/_providers/gandi.md @@ -1,5 +1,6 @@ --- name: Gandi +title: Gandi Provider layout: default jsId: GANDI --- diff --git a/docs/_providers/gcloud.md b/docs/_providers/gcloud.md index 0afda1d9c..a71f7d4d5 100644 --- 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 diff --git a/docs/_providers/name.com.md b/docs/_providers/name.com.md index 545225bd2..13fcab40c 100644 --- 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 --- diff --git a/docs/_providers/namecheap.md b/docs/_providers/namecheap.md index 04ef46d3b..fb154e27f 100644 --- a/docs/_providers/namecheap.md +++ b/docs/_providers/namecheap.md @@ -1,5 +1,5 @@ --- -name: "Namecheap" +name: Namecheap Provider layout: default jsId: NAMECHEAP --- diff --git a/docs/_providers/ns1.md b/docs/_providers/ns1.md index de2fcc293..71c862fd4 100644 --- a/docs/_providers/ns1.md +++ b/docs/_providers/ns1.md @@ -1,5 +1,6 @@ --- name: NS1 +title: NS1 Provider layout: default jsId: NS1 --- diff --git a/docs/_providers/softlayer.md b/docs/_providers/softlayer.md index 32521ebb5..6a136c869 100644 --- 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 %} diff --git a/docs/adding-new-rtypes.md b/docs/adding-new-rtypes.md index 61ff934b1..943aee04d 100644 --- 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 diff --git a/docs/alias.md b/docs/alias.md index 0a9972a45..4d02fcfec 100644 --- 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. diff --git a/docs/css/site.css b/docs/css/site.css index 609921331..ea1edf5d7 100644 --- 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 - } \ No newline at end of file +.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 +} \ No newline at end of file diff --git a/docs/examples.md b/docs/examples.md index 4436dfa34..333a9dd3d 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,5 +1,6 @@ --- layout: default +title: Examples --- # Examples diff --git a/docs/getting-started.md b/docs/getting-started.md index ccc57e4bc..07b34ec43 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,5 +1,6 @@ --- layout: default +title: Getting Started --- # Getting Started diff --git a/docs/index.md b/docs/index.md index e52a7d434..1971ce99e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ --- layout: default +title: DnsControl ---
    @@ -81,7 +82,7 @@ layout: default