govuk_tech_docs 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12cf51405932e8a1b1963c5d8141de6c474fd1e0
-  data.tar.gz: 4c71d9bcfe45396525f7acc05d7d157c15f483be
+  metadata.gz: f5e6745794ab18eb8c628384b868c10edaecfe5a
+  data.tar.gz: 6d93cae1fd2a09c0addc299fa7b43bceecd6208f
 SHA512:
-  metadata.gz: ce6a2aa3153afe322cd76568389fac64338e5772e45cb2459230b4b2bc2021fdcf6af8237d46a1a4030cb72a357c11020e075c866da5c14a58d2b55fb4c623a6
-  data.tar.gz: 573e40e4ccfd26d6f48e73458db1d26581cdcb0d65fadfd114680a2c13a82fd5edc233203ead0608cb534d1232f6253cc01c23095cdac33c3a885dbc1ef499dc
+  metadata.gz: c9a3f2c71458829e25e27d0cf79cea3d19e125bafb8e3c2c28827312e2a6d6a4d28cd9b0e01aa999f051f3b0881a081d1b14dbe250e47d6d055ba48765ec1e02
+  data.tar.gz: b77c6acc475897e7423b3067abcc41f339539bd6cd5b4eb85c219fafc6a0cf8de60eec81ce55df3e7469c6a2fecedd0088261edf0c003c860f3935cd03905233

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Layout/IndentHeredoc:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Lint/NestedMethodDefinition:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/CHANGELOG.md

@@ -1,11 +1,45 @@
 # Changelog
 
+## 1.2.0
+
+### New feature: redirects
+
+You can now specify redirects in the frontmatter and `config/tech-docs.yml`.
+
+You can use this when you change a page URL.
+
+More info:
+
+- https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#redirects
+- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#old_paths
+
+### New feature: contribution banner
+
+You can now show a block at the bottom of the page that links to
+the page source on GitHub, so readers can easily contribute back to the documentation.
+
+https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#show_contribution_banner
+
+### New feature: page review system
+
+An optional page review system to make sure documentation stays up to date.
+
+More info:
+
+- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#last_reviewed_on
+- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#owner_slack
+
+
+### Better meta tags
+
+Pages now include better meta tags for search engines, Twitter, Facebook and Slack to pick up.
+
 ## 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 
+https://github.com/alphagov/tech-docs-gem/blob/master/docs/configuration.md#google_site_verification
 
 ## 1.0.0
 

data/README.md

@@ -42,6 +42,6 @@ Or, on the command line, run `bundle exec rake jasmine:ci`.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](LICENSE.md).
+The gem is available as open source under the terms of the [MIT License](LICENSE).
 
 [jas]: https://jasmine.github.io/

data/Rakefile

@@ -6,4 +6,8 @@ RSpec::Core::RakeTask.new(:spec)
 
 load 'jasmine/tasks/jasmine.rake'
 
-task default: ['spec', 'jasmine:ci']
+task :lint do
+  sh "govuk-lint-ruby example lib spec Rakefile"
+end
+
+task default: ['lint', 'spec', 'jasmine:ci']

data/docs/configuration.md

@@ -4,44 +4,57 @@ You can configure the site using `config/tech-docs.yml`. [See the PaaS tech docs
 
 These are all the available options:
 
-## `host`
-
-Host to use for canonical URL generation (without trailing slash).
+## `ga_tracking_id`
 
-Example:
+Tracking ID from Google Analytics
 
 ```yaml
-host: https://docs.cloud.service.gov.uk
+ga_tracking_id: UA-XXXX-Y
 ```
 
-## `show_govuk_logo`
+## `github_repo`
 
-Whether to show the GOV.UK crown logo.
+Your repository. Required if [show_contribution_banner](#show-contribution-banner) is true.
 
-default: `true`
+```yaml
+github_repo: alphagov/example-repo
+```
+
+## `google_site_verification`
+
+Adds a [Google Site Verification code](https://support.google.com/webmasters/answer/35179?hl=en) to the meta tags.
 
 ```yaml
-show_govuk_logo: true
+google_site_verification: TvDTuyvdstyusadrCSDrctyd
 ```
 
-## `service_name`
+## `header_links`
 
-The service name in the header.
+Right hand side navigation.
 
 Example:
 
 ```yaml
-service_name: "Platform as a Service"
+header_links:
+  Documentation: /
 ```
 
-## `service_link`
+## `host`
 
-What the service name in the header links to.
+Host to use for canonical URL generation (without trailing slash).
 
-default: '/'
+Example:
 
 ```yaml
-service_link: "/"
+host: https://docs.cloud.service.gov.uk
+```
+
+## `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
 ```
 
 ## `phase`
@@ -50,45 +63,64 @@ service_link: "/"
 phase: "Beta"
 ```
 
-## `header_links`
+## `prevent_indexing`
 
-Right hand side navigation.
+Prevent robots from indexing (e.g. whilst in development)
 
-Example:
+```yaml
+prevent_indexing: false
+```
+
+## `redirects`
+
+A list of redirects, from old to new location. Use this to set up external
+redirects or if [setting `old_paths` in the frontmatter](docs/frontmatter.md#old_paths) doesn't work.
 
 ```yaml
-header_links:
-  Documentation: /
+redirects:
+  /old-page.html: https://example.org/something-else.html
+  /another/old-page.html: /another/new-page.html
 ```
 
-## `prevent_indexing`
+## `service_name`
 
-Prevent robots from indexing (e.g. whilst in development)
+The service name in the header.
+
+Example:
 
 ```yaml
-prevent_indexing: false
+service_name: "Platform as a Service"
 ```
 
-## `ga_tracking_id`
+## `service_link`
 
-Tracking ID from Google Analytics
+What the service name in the header links to.
+
+default: '/'
 
 ```yaml
-ga_tracking_id: UA-XXXX-Y
+service_link: "/"
 ```
 
-## `max_toc_heading_level`
+## `show_contribution_banner`
 
-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.
+Show a block at the bottom of the page that links to the page source, so readers
+can easily contribute back to the documentation. If turned on [github_repo](#github-repo) is
+required.
+
+Off by default.
 
 ```yaml
-max_toc_heading_level: 6
+show_contribution_banner: true
+github_repo: alphagov/example-repo
 ```
 
-## `google_site_verification`
+## `show_govuk_logo`
 
-Adds a [Google Site Verification code](https://support.google.com/webmasters/answer/35179?hl=en) to the meta tags.
+Whether to show the GOV.UK crown logo.
+
+default: `true`
 
 ```yaml
-google_site_verification: TvDTuyvdstyusadrCSDrctyd
+show_govuk_logo: true
 ```

data/docs/frontmatter.md

@@ -0,0 +1,113 @@
+# Available frontmatter
+
+"Frontmatter" allows page-specific variables to be included at the top of a template using YAML. For a general introduction on frontmatter, see the [Middleman frontmatter docs][mm].
+
+## `last_reviewed_on` and `review_in`
+
+These attributes determine the date when the page needs to be reviewed next.
+
+If the page doesn't need to be reviewed, we show a blue box with the last-reviewed date, when it needs review again, and the owner.
+
+![](not-expired-page.png)
+
+If the page needs to be reviewed, we show a red box saying the page might not be accurate.
+
+![](expired-page.png)
+
+Example:
+
+```yaml
+---
+last_reviewed_on: 2018-01-18
+review_in: 6 weeks
+---
+```
+
+You can use this in combination with [owner_slack](#owner-slack) to set an owner for the page.
+
+## `layout`
+
+The layout of the page.
+
+```yaml
+---
+layout: core
+---
+```
+
+There are 2 available page layouts.
+
+### The `layout` layout (default)
+
+By default, pages will use the `layout` layout. This layout will parse the page and generate a sidebar with a table of contents consisting of each `h2`, `h3`, `h4` heading.
+
+```md
+---
+layout: layout
+---
+
+# The title
+
+## A subheader
+
+### A h3 subheader
+
+## Another subheader
+```
+
+Will generate a page with the headings from the content in the sidebar.
+
+![](layout-layout.png)
+
+### `core` layout
+
+If you want more control about the layout, use `core` layout. This allows you to specify the sidebar manually with a `content_for` block.
+
+```rb
+---
+layout: core
+---
+
+<% content_for :sidebar do %>
+  You can put anything in the sidebar.
+<% end %>
+
+This page has a configurable sidebar that is independent of the content.
+```
+
+![](core-layout.png)
+
+## `old_paths`
+
+Any paths of pages that should redirect to this page.
+
+Example:
+
+```yaml
+---
+old_paths:
+  - /some-old-page.html
+---
+```
+
+## `owner_slack`
+
+The Slack username or channel of the page owner. This can be used to appoint an individual or team as responsible for keeping the page up to date.
+
+```yaml
+---
+owner_slack: "#operations-teams"
+---
+```
+
+## `title`
+
+The browser title of the page.
+
+```yaml
+---
+title: My beautiful page
+---
+```
+
+[mm]: https://middlemanapp.com/basics/frontmatter

data/example/config.rb

@@ -1,3 +1,9 @@
 require 'govuk_tech_docs'
 
 GovukTechDocs.configure(self)
+
+ignore 'templates/*'
+
+proxy '/a-proxied-page.html', 'templates/proxy_template.html', locals: {
+  title: 'I am a title'
+}

data/example/config/tech-docs.yml

@@ -1,5 +1,5 @@
 # Host to use for canonical URL generation (without trailing slash)
-host:
+host: https://docs.example.com
 
 # Header-related options
 show_govuk_logo: true
@@ -10,6 +10,9 @@ phase: Beta
 # Links to show on right-hand-side of header
 header_links:
   Documentation: /
+  Expired page: /expired-page.html
+  Expired with owner: /expired-page-with-owner.html
+  Not expired page: /not-expired-page.html
 
 # Tracking ID from Google Analytics (e.g. UA-XXXX-Y)
 ga_tracking_id:
@@ -23,3 +26,10 @@ max_toc_heading_level: 6
 prevent_indexing: false
 
 google_site_verification: dstbao8TVS^DRVDS&rv76
+
+show_contribution_banner: true
+
+github_repo: alphagov/example-repo
+
+redirects:
+  /something/old.html: /index.html

data/example/source/core-layout.html.md.erb

@@ -0,0 +1,12 @@
+---
+layout: core
+---
+
+<% content_for :sidebar do %>
+  You can put anything in the sidebar.
+<% end %>
+
+
+# Hello!
+
+This page has a configurable sidebar that is independent of the content.

data/example/source/expired-page-with-owner.html.md

@@ -0,0 +1,10 @@
+---
+title: This is an expired page
+last_reviewed_on: 1983-01-18
+review_in: 18 years
+owner_slack: '@foo'
+---
+
+# This is an expired page with owner
+
+See the banner on this page.

data/example/source/expired-page.html.md

@@ -0,0 +1,9 @@
+---
+title: This is an expired page
+last_reviewed_on: 1983-01-18
+review_in: 18 years
+---
+
+# This is an expired page
+
+See the banner on this page.

data/example/source/headings.html.md

@@ -0,0 +1,11 @@
+---
+layout: layout
+---
+
+# The title
+
+## A subheader
+
+### A h3 subheader
+
+## Another subheader

data/example/source/index.html.md.erb

@@ -1,5 +1,7 @@
 ---
 title: GOV.UK Documentation Example
+old_paths:
+ - /something/old-as-well.html
 ---
 
 # Hello, World!

data/example/source/not-expired-page.html.md

@@ -0,0 +1,9 @@
+---
+title: This is an expired page
+last_reviewed_on: 2050-01-18
+review_in: 1 month
+---
+
+# This is not an expired page
+
+See the banner on this page.

data/example/source/templates/proxy_template.html.md

@@ -0,0 +1,8 @@
+---
+title: Proxied page
+source_url: http://example.org/source.md
+---
+
+# Proxied page
+
+This is a proxied page.

data/govuk_tech_docs.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport"
+  spec.add_dependency "chronic", "~> 0.10.2"
   spec.add_dependency "middleman", "~> 4.0"
   spec.add_dependency "middleman-autoprefixer", "~> 2.7.0"
   spec.add_dependency "middleman-compass", ">= 4.0.0"
@@ -33,6 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.15"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "capybara", "~> 2.18.0"
+  spec.add_development_dependency "govuk-lint", "~> 3.7.0"
   spec.add_development_dependency "jasmine", "~> 3.1.0"
   spec.add_development_dependency "rspec", "~> 3.7.0"
 end

data/lib/assets/javascripts/_modules/page-expiry.js

@@ -0,0 +1,15 @@
+(function($, Modules) {
+  'use strict';
+
+  Modules.PageExpiry = function PageExpiry() {
+    this.start = function start($element) {
+      var rawDate = $element.data('last-reviewed-on');
+      var isExpired = Date.parse(rawDate) < new Date();
+
+      if (isExpired) {
+        $element.find('.page-expiry--not-expired').hide(0);
+        $element.find('.page-expiry--expired').show(0);
+      }
+    };
+  };
+})(jQuery, window.GOVUK.Modules);

data/lib/assets/javascripts/_start-modules.js

@@ -2,6 +2,7 @@
 //= require _modules/anchored-headings
 //= require _modules/in-page-navigation
 //= require _modules/navigation
+//= require _modules/page-expiry
 //= require _modules/table-of-contents
 
 $(document).ready(function() {

data/lib/assets/stylesheets/_core.scss

@@ -24,8 +24,10 @@ $desktop-breakpoint: 992px !default;
 @import "modules/footer";
 @import "modules/govuk-logo";
 @import "modules/header";
+@import "modules/page-review";
 @import "modules/phase-banner";
 @import "modules/skip-link";
+@import "modules/contribution-banner";
 @import "modules/technical-documentation";
 @import "modules/toc";
 

data/lib/assets/stylesheets/modules/_contribution-banner.scss

@@ -0,0 +1,22 @@
+.contribution-banner {
+  padding: 0;
+  max-width: 40em;
+  margin-top: $gutter * 2;
+  margin-left: $gutter-half;
+  margin-right: $gutter-half;
+
+  @include media(tablet) {
+    margin-left: $gutter + 2px;
+    margin-right: $gutter + 2px;
+  }
+
+  a {
+    margin-right: $gutter-half;
+  }
+
+  li {
+    display: inline-block;
+    list-style: none;
+    margin: 2px 0;
+  }
+}

data/lib/assets/stylesheets/modules/_page-review.scss

@@ -0,0 +1,34 @@
+.page-expiry--not-expired {
+  padding: $gutter-half;
+  margin-top: $gutter;
+  margin-bottom: $gutter;
+  background-color: $govuk-blue;
+  color: $page-colour;
+
+  @include media(tablet) {
+    padding: $gutter;
+  }
+
+  a:link,
+  a:visited {
+    color: inherit;
+  }
+
+  a:hover {
+    color: $link-hover-colour;
+  }
+
+  a:active {
+    color: $link-active-colour;
+  }
+}
+
+.page-expiry--expired {
+  display: none;
+
+  padding: $gutter-half;
+  margin-top: $gutter * 2;
+  background-color: $error-background;
+  border: 1px solid $error-colour;
+  color: $error-colour;
+}

data/lib/govuk_tech_docs.rb

@@ -7,8 +7,15 @@ require 'middleman-livereload'
 require 'middleman-syntax'
 
 require 'nokogiri'
+require 'chronic'
+require 'active_support/all'
 
+require 'govuk_tech_docs/redirects'
 require 'govuk_tech_docs/table_of_contents/helpers'
+require 'govuk_tech_docs/contribution_banner'
+require 'govuk_tech_docs/meta_tags'
+require 'govuk_tech_docs/page_review'
+require 'govuk_tech_docs/pages'
 require 'govuk_tech_docs/tech_docs_html_renderer'
 require 'govuk_tech_docs/unique_identifier_extension'
 require 'govuk_tech_docs/unique_identifier_generator'
@@ -45,10 +52,31 @@ module GovukTechDocs
 
     context.helpers do
       include GovukTechDocs::TableOfContents::Helpers
+      include GovukTechDocs::ContributionBanner
+
+      def meta_tags
+        @meta_tags ||= GovukTechDocs::MetaTags.new(config, current_page)
+      end
+
+      def current_page_review
+        @current_page_review ||= GovukTechDocs::PageReview.new(current_page)
+      end
+
+      def format_date(date)
+        date.strftime('%-e %B %Y')
+      end
     end
 
     context.page '/*.xml', layout: false
     context.page '/*.json', layout: false
     context.page '/*.txt', layout: false
+
+    context.ready do
+      redirects = GovukTechDocs::Redirects.new(context).redirects
+
+      redirects.each do |from, to|
+        context.redirect from, to
+      end
+    end
   end
 end

data/lib/govuk_tech_docs/contribution_banner.rb

@@ -0,0 +1,52 @@
+module GovukTechDocs
+  # Helper included
+  module ContributionBanner
+    def source_urls
+      SourceUrls.new(current_page, config)
+    end
+  end
+
+  class SourceUrls
+    attr_reader :current_page, :config
+
+    def initialize(current_page, config)
+      @current_page = current_page
+      @config = config
+    end
+
+    def view_source_url
+      override_from_page || source_from_yaml_file || source_from_file
+    end
+
+    def report_issue_url
+      "#{repo_url}/issues/new?labels=bug&title=Re: '#{current_page.data.title}'&body=Problem with '#{current_page.data.title}' (#{config[:tech_docs][:host]}#{current_page.url})"
+    end
+
+    def repo_url
+      "https://github.com/#{config[:tech_docs][:github_repo]}"
+    end
+
+  private
+
+    # If a `page` local exists, see if it has a `source_url`. This is used by the
+    # pages that are created by the proxy system because they can't use frontmatter
+    def override_from_page
+      locals.key?(:page) ? locals[:page].try(:source_url) : false
+    end
+
+    # In the frontmatter we can specify a `source_url`. Use this if the actual
+    # source of the page is in another GitHub repo.
+    def source_from_yaml_file
+      current_page.data.source_url
+    end
+
+    # As the last fallback link to the source file in this repository.
+    def source_from_file
+      "#{repo_url}/blob/master/source/#{current_page.file_descriptor[:relative_path]}"
+    end
+
+    def locals
+      current_page.metadata[:locals]
+    end
+  end
+end

data/lib/govuk_tech_docs/meta_tags.rb

@@ -0,0 +1,67 @@
+module GovukTechDocs
+  class MetaTags
+    def initialize(config, current_page)
+      @config = config
+      @current_page = current_page
+    end
+
+    def tags
+      all_tags = {
+        'description' => page_description,
+        'og:description' => page_description,
+        'og:image' => page_image,
+        'og:site_name' => site_name,
+        'og:title' => page_title,
+        'og:type' => 'object',
+        'og:url' => canonical_url,
+        'twitter:card' => 'summary',
+        'twitter:domain' => URI.parse(host).host,
+        'twitter:image' => page_image,
+        'twitter:title' => browser_title,
+        'twitter:url' => canonical_url,
+      }
+
+      Hash[all_tags.select { |_k, v| v }]
+    end
+
+    def browser_title
+      [page_title, site_name].select(&:present?).uniq.join(' | ')
+    end
+
+    def canonical_url
+      "#{host}#{current_page.url}"
+    end
+
+  private
+
+    attr_reader :config, :current_page
+
+    def page_image
+      "#{host}/images/govuk-large.png"
+    end
+
+    def site_name
+      config[:tech_docs][:service_name]
+    end
+
+    def page_description
+      locals[:description] || frontmatter.description
+    end
+
+    def page_title
+      locals[:title] || frontmatter.title
+    end
+
+    def host
+      config[:tech_docs][:host]
+    end
+
+    def locals
+      current_page.metadata[:locals]
+    end
+
+    def frontmatter
+      current_page.data
+    end
+  end
+end

data/lib/govuk_tech_docs/page_review.rb

@@ -0,0 +1,36 @@
+module GovukTechDocs
+  class PageReview
+    attr_reader :page
+
+    def initialize(page)
+      @page = page
+    end
+
+    def review_by
+      return unless last_reviewed_on
+
+      @review_by ||= Chronic.parse(
+        "in #{page.data.review_in}",
+        now: last_reviewed_on.to_time
+      ).to_date
+    end
+
+    def under_review?
+      page.data.review_in.present?
+    end
+
+    def last_reviewed_on
+      page.data.last_reviewed_on
+    end
+
+    def owner_slack
+      page.data.owner_slack
+    end
+
+    def owner_slack_url
+      # Slack URLs don't have the # (channels) or @ (usernames)
+      slack_identifier = owner_slack.to_s.delete('#').delete('@')
+      "https://govuk.slack.com/messages/#{slack_identifier}"
+    end
+  end
+end

data/lib/govuk_tech_docs/pages.rb

@@ -0,0 +1,31 @@
+module GovukTechDocs
+  class Pages
+    attr_reader :sitemap
+
+    def initialize(sitemap, config)
+      @sitemap = sitemap
+      @config = config
+    end
+
+    def to_json
+      as_json.to_json
+    end
+
+  private
+
+    def as_json
+      pages.map do |page|
+        {
+          title: page.data.title,
+          url: "#{@config[:tech_docs][:host]}#{page.url}",
+          review_by: PageReview.new(page).review_by,
+          owner_slack: page.data.owner_slack,
+        }
+      end
+    end
+
+    def pages
+      sitemap.resources.select { |page| page.url.end_with?('.html') && page.data.title }
+    end
+  end
+end

data/lib/govuk_tech_docs/redirects.rb

@@ -0,0 +1,39 @@
+module GovukTechDocs
+  class Redirects
+    LEADING_SLASH = %r[\A\/]
+
+    def initialize(context)
+      @context = context
+    end
+
+    def redirects
+      all_redirects = redirects_from_config + redirects_from_frontmatter
+
+      all_redirects.map do |from, to|
+        # Middleman needs paths without leading slashes
+        [from.sub(LEADING_SLASH, ''), to: to.sub(LEADING_SLASH, '')]
+      end
+    end
+
+  private
+
+    attr_reader :context
+
+    def redirects_from_config
+      context.config[:tech_docs][:redirects].to_a
+    end
+
+    def redirects_from_frontmatter
+      reds = []
+      context.sitemap.resources.each do |page|
+        next unless page.data.old_paths
+
+        page.data.old_paths.each do |old_path|
+          reds << [old_path, page.path]
+        end
+      end
+
+      reds
+    end
+  end
+end

data/lib/govuk_tech_docs/table_of_contents/helpers.rb

@@ -8,12 +8,14 @@ module GovukTechDocs
   module TableOfContents
     module Helpers
       def table_of_contents(html, max_level: nil)
-        HeadingTreeRenderer.new(
-          HeadingTreeBuilder.new(
-            HeadingsBuilder.new(html).headings
-          ).tree,
-          max_level: max_level
-        ).html
+        headings = HeadingsBuilder.new(html).headings
+
+        if headings.none? { |heading| heading.size == 1 }
+          raise "No H1 tag found. You have to at least add one H1 heading to the page."
+        end
+
+        tree = HeadingTreeBuilder.new(headings).tree
+        HeadingTreeRenderer.new(tree, max_level: max_level).html
       end
     end
   end

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "1.1.0"
+  VERSION = "1.2.0".freeze
 end

data/lib/source/api/pages.json.erb

@@ -0,0 +1 @@
+<%= GovukTechDocs::Pages.new(sitemap, config).to_json %>

data/lib/source/layouts/_page_review.erb

@@ -0,0 +1,18 @@
+<% if current_page_review.under_review? %>
+  <div data-module='page-expiry' data-last-reviewed-on="<%= current_page_review.review_by %>">
+    <div class='page-expiry--not-expired'>
+      This page was last reviewed on <%= format_date current_page_review.last_reviewed_on %>.
+
+      It needs to be reviewed again on <%= format_date current_page_review.review_by %>
+      <% if current_page_review.owner_slack %>
+      by the page owner <%= link_to current_page_review.owner_slack, current_page_review.owner_slack_url %>
+      <% end %>.
+    </div>
+
+    <div class='page-expiry--expired'>
+      This page was set to be reviewed before <%= format_date current_page_review.review_by %><% if current_page_review.owner_slack %>
+       by the page owner <%= link_to current_page_review.owner_slack, current_page_review.owner_slack_url %><% end %>.
+      This might mean the content is out of date.
+    </div>
+  </div>
+<% end %>

data/lib/source/layouts/core.erb

@@ -8,13 +8,12 @@
       <meta name="robots" content="noindex">
     <% end %>
 
-    <!-- Use title if it's in the page YAML frontmatter -->
-    <title><%= current_page.data.title || "GOV.UK Documentation" %></title>
+    <title><%= meta_tags.browser_title %></title>
 
     <!--[if gt IE 8]><!--><%= stylesheet_link_tag :screen, media: 'screen' %><!--<![endif]-->
     <!--[if lte IE 8]><%= stylesheet_link_tag 'screen-old-ie', media: 'screen' %><![endif]-->
 
-    <link rel="canonical" href="<%= config[:tech_docs][:host] %><%= current_page.url %>">
+    <link rel="canonical" href="<%= meta_tags.canonical_url %>">
 
     <% if config[:tech_docs][:google_site_verification] %>
       <meta name="google-site-verification" content="<%= config[:tech_docs][:google_site_verification] %>" />
@@ -22,6 +21,10 @@
 
     <%= stylesheet_link_tag :print, media: 'print' %>
     <%= javascript_include_tag :application %>
+
+    <% meta_tags.tags.each do |property, content| %>
+      <%= tag :meta, property: property, content: content %>
+    <% end %>
   </head>
 
   <body>
@@ -51,8 +54,17 @@
         <div class="app-pane__content toc-open-disabled">
           <main id="content" class="technical-documentation" data-module="anchored-headings">
             <%= yield %>
+            <%= partial "layouts/page_review" %>
           </main>
 
+          <% if config[:tech_docs][:show_contribution_banner] %>
+            <ul class="contribution-banner">
+              <li><%= link_to "View source", source_urls.view_source_url %></li>
+              <li><%= link_to "Report problem", source_urls.report_issue_url %></li>
+              <li><%= link_to "GitHub Repo", source_urls.repo_url %></li>
+            </ul>
+          <% end %>
+
           <%= partial "layouts/footer" %>
         </div>
       </div>

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Government Digital Service
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-08 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.2
 - !ruby/object:Gem::Dependency
   name: middleman
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +192,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.18.0
+- !ruby/object:Gem::Dependency
+  name: govuk-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
   name: jasmine
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +245,8 @@ files:
 - ".editorconfig"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -210,21 +254,33 @@ files:
 - README.md
 - Rakefile
 - docs/configuration.md
+- docs/core-layout.png
+- docs/expired-page.png
+- docs/frontmatter.md
+- docs/layout-layout.png
+- docs/not-expired-page.png
 - example/.ruby-version
 - example/Gemfile
 - example/config.rb
 - example/config/tech-docs.yml
+- example/source/core-layout.html.md.erb
+- example/source/expired-page-with-owner.html.md
+- example/source/expired-page.html.md
+- example/source/headings.html.md
 - example/source/index.html.md.erb
 - example/source/javascripts/application.js
+- example/source/not-expired-page.html.md
 - example/source/stylesheets/print.css.scss
 - example/source/stylesheets/screen-old-ie.css.scss
 - example/source/stylesheets/screen.css.scss
+- example/source/templates/proxy_template.html.md
 - govuk_tech_docs.gemspec
 - lib/assets/javascripts/_analytics.js
 - lib/assets/javascripts/_govuk/modules.js
 - lib/assets/javascripts/_modules/anchored-headings.js
 - lib/assets/javascripts/_modules/in-page-navigation.js
 - lib/assets/javascripts/_modules/navigation.js
+- lib/assets/javascripts/_modules/page-expiry.js
 - lib/assets/javascripts/_modules/table-of-contents.js
 - lib/assets/javascripts/_start-modules.js
 - lib/assets/javascripts/_vendor/fixedsticky.js
@@ -256,9 +312,11 @@ files:
 - lib/assets/stylesheets/govuk_frontend_toolkit/design-patterns/_media-player.scss
 - lib/assets/stylesheets/modules/_anchored-heading.scss
 - lib/assets/stylesheets/modules/_app-pane.scss
+- lib/assets/stylesheets/modules/_contribution-banner.scss
 - lib/assets/stylesheets/modules/_footer.scss
 - lib/assets/stylesheets/modules/_govuk-logo.scss
 - lib/assets/stylesheets/modules/_header.scss
+- lib/assets/stylesheets/modules/_page-review.scss
 - lib/assets/stylesheets/modules/_phase-banner.scss
 - lib/assets/stylesheets/modules/_skip-link.scss
 - lib/assets/stylesheets/modules/_technical-documentation.scss
@@ -268,6 +326,11 @@ files:
 - lib/assets/stylesheets/utilities/_printable.scss
 - lib/assets/stylesheets/vendor/_fixedsticky.scss
 - lib/govuk_tech_docs.rb
+- lib/govuk_tech_docs/contribution_banner.rb
+- lib/govuk_tech_docs/meta_tags.rb
+- lib/govuk_tech_docs/page_review.rb
+- lib/govuk_tech_docs/pages.rb
+- lib/govuk_tech_docs/redirects.rb
 - lib/govuk_tech_docs/table_of_contents/heading.rb
 - lib/govuk_tech_docs/table_of_contents/heading_tree.rb
 - lib/govuk_tech_docs/table_of_contents/heading_tree_builder.rb
@@ -278,6 +341,7 @@ files:
 - lib/govuk_tech_docs/unique_identifier_extension.rb
 - lib/govuk_tech_docs/unique_identifier_generator.rb
 - lib/govuk_tech_docs/version.rb
+- lib/source/api/pages.json.erb
 - lib/source/favicon.ico
 - lib/source/images/anchored-heading-icon-2x.png
 - lib/source/images/anchored-heading-icon.png
@@ -295,6 +359,7 @@ files:
 - lib/source/layouts/_analytics.erb
 - lib/source/layouts/_footer.erb
 - lib/source/layouts/_header.erb
+- lib/source/layouts/_page_review.erb
 - lib/source/layouts/core.erb
 - lib/source/layouts/layout.erb
 homepage: https://github.com/alphagov/tech-docs-gem
@@ -317,7 +382,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Gem to distribute the GOV.UK Tech Docs Template