govuk_tech_docs 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02e41ba09a532d75fa642d0eb9ab0b1960fc83d6
-  data.tar.gz: 676133bd3cf4b436638be2699b60a62530101ba0
+  metadata.gz: 12cf51405932e8a1b1963c5d8141de6c474fd1e0
+  data.tar.gz: 4c71d9bcfe45396525f7acc05d7d157c15f483be
 SHA512:
-  metadata.gz: 820f02328cc40233559cf3f4cfc1757bc194706e123729cb927856da064a700c5d8bf00c1dc030d444560cc7aec794fc7fc030cd8e342c857759a46aa274f471
-  data.tar.gz: c7ea93749ef1bf236eac5e58865406278313a7ce068b2aed51236997803f3c30bfab5daf7c0f810e7b82a69b9587e1ae0a876c6a3d5ac8ec486f7d74ea586a5f
+  metadata.gz: ce6a2aa3153afe322cd76568389fac64338e5772e45cb2459230b4b2bc2021fdcf6af8237d46a1a4030cb72a357c11020e075c866da5c14a58d2b55fb4c623a6
+  data.tar.gz: 573e40e4ccfd26d6f48e73458db1d26581cdcb0d65fadfd114680a2c13a82fd5edc233203ead0608cb534d1232f6253cc01c23095cdac33c3a885dbc1ef499dc

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 1.1.0
+
+You can now specify `google_site_verification` in tech-docs.yml. You can use
+this to verify your site in Google Webmaster tools.
+
+https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#google_site_verification 
+
 ## 1.0.0
 
 The first release of the template as a gem. Most CSS, JS, images and layouts are
@@ -26,11 +33,17 @@ $ie-version: 8;
 
 echo "require 'govuk_tech_docs'
 
-TechDocs.configure(self)" > config.rb
+GovukTechDocs.configure(self)" > config.rb
 
 echo "source 'https://rubygems.org'
 
-gem 'govuk_tech_docs', path: '../govuk_tech_docs'" > Gemfile
+# For faster file watcher updates on Windows:
+gem 'wdm', '~> 0.1.0', platforms: [:mswin, :mingw]
+
+# Windows does not come with time zone data
+gem 'tzinfo-data', platforms: [:mswin, :mingw, :jruby]
+
+gem 'govuk_tech_docs'" > Gemfile
 
 bundle install
 ```

data/docs/configuration.md

@@ -0,0 +1,94 @@
+# Configuration
+
+You can configure the site using `config/tech-docs.yml`. [See the PaaS tech docs for an example](https://github.com/alphagov/paas-tech-docs/blob/master/config/tech-docs.yml).
+
+These are all the available options:
+
+## `host`
+
+Host to use for canonical URL generation (without trailing slash).
+
+Example:
+
+```yaml
+host: https://docs.cloud.service.gov.uk
+```
+
+## `show_govuk_logo`
+
+Whether to show the GOV.UK crown logo.
+
+default: `true`
+
+```yaml
+show_govuk_logo: true
+```
+
+## `service_name`
+
+The service name in the header.
+
+Example:
+
+```yaml
+service_name: "Platform as a Service"
+```
+
+## `service_link`
+
+What the service name in the header links to.
+
+default: '/'
+
+```yaml
+service_link: "/"
+```
+
+## `phase`
+
+```yaml
+phase: "Beta"
+```
+
+## `header_links`
+
+Right hand side navigation.
+
+Example:
+
+```yaml
+header_links:
+  Documentation: /
+```
+
+## `prevent_indexing`
+
+Prevent robots from indexing (e.g. whilst in development)
+
+```yaml
+prevent_indexing: false
+```
+
+## `ga_tracking_id`
+
+Tracking ID from Google Analytics
+
+```yaml
+ga_tracking_id: UA-XXXX-Y
+```
+
+## `max_toc_heading_level`
+
+Table of contents depth – how many levels to include in the table of contents. If your ToC is too long, reduce this number and we'll only show higher-level headings.
+
+```yaml
+max_toc_heading_level: 6
+```
+
+## `google_site_verification`
+
+Adds a [Google Site Verification code](https://support.google.com/webmasters/answer/35179?hl=en) to the meta tags.
+
+```yaml
+google_site_verification: TvDTuyvdstyusadrCSDrctyd
+```

data/example/config/tech-docs.yml

@@ -21,3 +21,5 @@ max_toc_heading_level: 6
 
 # Prevent robots from indexing (e.g. whilst in development)
 prevent_indexing: false
+
+google_site_verification: dstbao8TVS^DRVDS&rv76

data/govuk_tech_docs.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.email         = ["govuk-dev@digital.cabinet-office.gov.uk"]
 
   spec.summary       = %q{Gem to distribute the GOV.UK Tech Docs Template}
-  spec.description   = %q{Gem to distribute the GOV.UK Tech Docs Template. See https://github.com/alphagov/govuk-tech-docs for the project.}
-  spec.homepage      = "https://github.com/alphagov/govuk-tech-docs"
+  spec.description   = %q{Gem to distribute the GOV.UK Tech Docs Template. See https://github.com/alphagov/tech-docs-gem for the project.}
+  spec.homepage      = "https://github.com/alphagov/tech-docs-gem"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/source/layouts/core.erb

@@ -16,6 +16,10 @@
 
     <link rel="canonical" href="<%= config[:tech_docs][:host] %><%= current_page.url %>">
 
+    <% if config[:tech_docs][:google_site_verification] %>
+      <meta name="google-site-verification" content="<%= config[:tech_docs][:google_site_verification] %>" />
+    <% end %>
+
     <%= stylesheet_link_tag :print, media: 'print' %>
     <%= javascript_include_tag :application %>
   </head>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-06 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman
@@ -192,7 +192,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.7.0
-description: Gem to distribute the GOV.UK Tech Docs Template. See https://github.com/alphagov/govuk-tech-docs
+description: Gem to distribute the GOV.UK Tech Docs Template. See https://github.com/alphagov/tech-docs-gem
   for the project.
 email:
 - govuk-dev@digital.cabinet-office.gov.uk
@@ -209,6 +209,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- docs/configuration.md
 - example/.ruby-version
 - example/Gemfile
 - example/config.rb
@@ -296,7 +297,7 @@ files:
 - lib/source/layouts/_header.erb
 - lib/source/layouts/core.erb
 - lib/source/layouts/layout.erb
-homepage: https://github.com/alphagov/govuk-tech-docs
+homepage: https://github.com/alphagov/tech-docs-gem
 licenses:
 - MIT
 metadata: {}