govuk_tech_docs 2.0.13 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35c96cfb5a9198c31ad6a4e4d4a3676299c938089127b1c2a564d2401c50ac10
-  data.tar.gz: 7ea84b4a4c0601a8c291020f538817b4d7dd7503aa57c22124e2dedf8deb3f34
+  metadata.gz: 4ebb7068421c3f7bc160f08cc145763a4d85df044700f794193403de1774bde5
+  data.tar.gz: 2ac84d99205129b273d153bfba9223bfb03933f4ca0a9202f0074e68869e267d
 SHA512:
-  metadata.gz: 3b906c3c277e8f1a5a923c7e05a57491b801109d61d8bda3f3ab393905eff5b39297663ce856ec06735703df5bc1a2389be39948e6b23f633657cc6744226233
-  data.tar.gz: 0ffe6a62bed3f6f8e32c4a087fb3d1a7fb617ff1867e27d3d99f20c08e098de53230885e4dcd438348347596368366212bf17a81042528e5767abe5baa6300d0
+  metadata.gz: a8893b47757fcd32d00e863c58a0ca96d1dbc96d6eb139db9d7a6c56a852322040a737b56c64e0b6871a25bfdc84bfcd217e3786cd7d21afc66dbae24c770617
+  data.tar.gz: 05e1d0c02f4cf4a912afdb86e560e1cb31c5f74f67962baf392002e26c78d8567df5c51396b1546a71ae7e2476c30df5175f2e6aeea4ec0b9214ed3ff0695a67

data/.github/pull_request_template.md

@@ -0,0 +1 @@
+⚠️ Don't forget to update the gem version in the [CHANGELOG](https://github.com/alphagov/tech-docs-gem/blob/master/CHANGELOG.md) before merging! When you're ready to release bump [version file](https://github.com/alphagov/tech-docs-gem/blob/master/lib/govuk_tech_docs/version.rb) and generate a tag. ⚠️

data/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.7.2

data/.travis.yml

@@ -1,4 +1,7 @@
 language: ruby
+cache:
+  bundler: true
+  npm: true
 before_install:
   - gem update --system
   - gem install bundler

data/CHANGELOG.md

@@ -1,5 +1,59 @@
 # Changelog
 
+## 2.2.2
+
+- [#223: Remove unnecessary CSS class on the search submit button](https://github.com/alphagov/tech-docs-gem/pull/223)
+- [#224: Accessibility fix: Hide the 'table of contents close' button when search results are open](https://github.com/alphagov/tech-docs-gem/pull/224)
+
+## 2.2.1
+
+- [#218: Remove unnecessary explicit dependencies: sprockets, activesupport, sass and pry](https://github.com/alphagov/tech-docs-gem/pull/218)
+- [#125: Fix API docs showing required properties as optional](https://github.com/alphagov/tech-docs-gem/pull/125)
+
+## 2.2.0
+
+### Accessibility Fixes
+
+- [#205: Improve table of contents accessibility](https://github.com/alphagov/tech-docs-gem/pull/205)
+- [#209: Some search and keyboard navigation updates](https://github.com/alphagov/tech-docs-gem/pull/209)
+- [#210: Stop linking images to new tabs](https://github.com/alphagov/tech-docs-gem/pull/210)
+- [#214: Implement row level table headings to allow accessible tables with row headings](https://github.com/alphagov/tech-docs-gem/pull/214)
+- [#215: Add tabindex and focus states to code blocks](https://github.com/alphagov/tech-docs-gem/pull/215)
+
+### Docs
+
+- [#206: Remove tdt docs content from readme file](https://github.com/alphagov/tech-docs-gem/pull/206)
+
+## 2.1.1
+
+### Fixes
+
+We’ve made fixes in the following pull requests:
+
+- [#199: Fix page expiry box link colours (hover and focus) ](https://github.com/alphagov/tech-docs-gem/pull/199)
+
+### Ruby version bump
+
+We've updated the Ruby version supported:
+
+- [#201: Bump ruby to 2.7.2](https://github.com/alphagov/tech-docs-gem/pull/201)
+
+## 2.1.0
+
+### New features
+
+#### Exclude pages from search engine results
+
+You can now exclude a page from search engine results by including `prevent_indexing: true` in the page's frontmatter.
+
+This was added in [pull request #192: Fixes and improvements to meta tags](https://github.com/alphagov/tech-docs-gem/pull/192).
+
+### Fixes
+
+We’ve made fixes in the following pull requests:
+
+- [#192: Fixes and improvements to meta tags](https://github.com/alphagov/tech-docs-gem/pull/192)
+
 ## 2.0.13
 
 - [Pull request #189: Update orange code highlight colour to meet minimum AA colour contrast ratio criterion](https://github.com/alphagov/tech-docs-gem/pull/189)
@@ -56,7 +110,6 @@ You can look at the [2.0.6 milestone](https://github.com/alphagov/tech-docs-gem/
 
 ## 2.0.5
 
-
 Adds [new global configuration option](https://github.com/alphagov/tech-docs-gem/pull/122) that controls whether review banners appear or not at the bottom of pages when expiry dates are set in the frontmatter.
 
 [Fixes the hard-coded service link](https://github.com/alphagov/tech-docs-gem/pull/119) in the header.

data/README.md

@@ -3,23 +3,19 @@
 This repo contains the Ruby gem that distributes the [Tech Docs Template][tdt-template]. The Tech Docs Template is a [middleman template][mmt] that
 you can use to build technical documentation using a GOV.UK style.
 
-👉 Find out more about the template and its features from the [Tech Docs Template documentation][tdt-docs].
-
-## Usage
-
-👉 Find out how to [generate a new website with the Tech Docs Template][tdt-readme].
+To find out more about setting up and managing content for a website using this template, see the [Tech Docs Template documentation][tdt-docs].
 
 ## Contributing
 
 Everybody who uses this project is encouraged to contribute.
 
-👉 [See CONTRIBUTING.md](CONTRIBUTING.md) for guidance on making changes.
+You can find out more about contributing to this project from the[CONTRIBUTING.md file](CONTRIBUTING.md).
 
 ## GOV.UK frontend
 
 This gem uses [GOV.UK Frontend](https://github.com/alphagov/govuk-frontend), part of the [GOV.UK Design System](https://design-system.service.gov.uk/).
 
-We use `npm` to download the govuk-frontend package. To update to a new version, change the version in [package.json](blob/master/package.json) and run `npm update`.
+We use `npm` to download the govuk-frontend package. To update to a new version, change the version in the [package.json file](blob/master/package.json) and run `npm update`.
 
 ## Developing locally
 
@@ -30,19 +26,13 @@ There are 2 ways to develop with this gem. You can see your changes on either:
 
 ### Use your own Tech Docs Template website
 
-If you want to see how your changes to the gem affect your website, you have to point your site's Gemfile to your local checkout:
+To see how your changes to the gem affect your website, point your website's Gemfile to your local checkout:
 
 ```rb
 gem 'govuk_tech_docs', path: '../tech-docs-gem'
 ```
 
-To view your changes locally run:
-
-```sh
-bundle exec middleman server
-```
-
-See your website on `http://localhost:4567` in your browser.
+To preview your documentation changes locally, see the [Tech Docs Template documentation on previewing your documentation](https://tdt-documentation.london.cloudapps.digital/create_project/preview/#preview-your-documentation).
 
 ### Use the example in this repo
 
@@ -56,14 +46,16 @@ bundle exec middleman server
 
 See your website on `http://localhost:4567` in your browser.
 
+For more information on previewing your documentation locally, see the [Tech Docs template documentation on previewing your documentation](https://tdt-documentation.london.cloudapps.digital/create_project/preview/#preview-your-documentation).
+
 ## Tests
 
-The repository contains automated JavaScript tests that use [Jasmine][jas] test framework.
+This repository contains automated JavaScript tests that use the [Jasmine test framework][jas].
 
-To run the tests and see the results in your browser:
+You can run these tests and see the results in your browser.
 
-1. Run `bundle exec rake jasmine`
-2. Go to `http://localhost:8888` in your browser
+1. Run `bundle exec rake jasmine`.
+2. Go to `http://localhost:8888` in your browser.
 
 To run the tests and see the results in your terminal, run:
 
@@ -73,14 +65,15 @@ bundle exec rake jasmine:ci
 
 ## Releasing new versions
 
-To release a new version, create a new Pull Request that updates [version.rb](lib/govuk_tech_docs/version.rb) and [CHANGELOG.md](CHANGELOG.md). Don't mix this in with other changes - this makes it easier to find out what was released when. See [this PR to release a new version as an example](https://github.com/alphagov/tech-docs-gem/pull/15).
+To release a new version, create a new pull request (PR) that updates [version.rb](lib/govuk_tech_docs/version.rb) and [CHANGELOG.md](CHANGELOG.md).
+
+Do not include other changes in your pull request, as this makes it easier to find out what was released when. See an example of a [PR for releasing a new version](https://github.com/alphagov/tech-docs-gem/pull/15).
 
 Travis will automatically release a [new version to Rubygems.org](https://rubygems.org/gems/govuk_tech_docs).
 
 ## Licence
 
-Unless stated otherwise, the codebase is released under [the MIT License][mit].
-This covers both the codebase and any sample code in the documentation.
+Unless stated otherwise, the codebase is released under [the MIT License][mit]. This covers both the codebase and any sample code in the documentation.
 
 The documentation is [© Crown copyright][copyright] and available under the terms of the [Open Government 3.0][ogl] licence.
 

data/example/.ruby-version

@@ -1 +1 @@
-2.6.3
+2.7.2

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

@@ -1,5 +1,6 @@
 ---
 title: GOV.UK Documentation Example
+description: Example of a documentation homepage
 old_paths:
  - /something/old-as-well.html
 ---

data/example/source/prevent-index-page.html.md

@@ -0,0 +1,10 @@
+---
+title: Un-indexed Page
+prevent_indexing: true
+hide_in_navigation: true
+---
+
+# Un-indexed page
+
+This page should not be indexed by search engines, because it contains a 
+`<meta name="robots" content="noindex">` tag.

data/govuk_tech_docs.gemspec

@@ -32,7 +32,6 @@ 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.10.0"
@@ -42,14 +41,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "middleman-sprockets", "~> 4.0.0"
   spec.add_dependency "middleman-syntax", "~> 3.2.0"
   spec.add_dependency "nokogiri"
-  spec.add_dependency "openapi3_parser", "~> 0.5.0"
-  spec.add_dependency "pry"
+  spec.add_dependency "openapi3_parser", "~> 0.9.0"
   spec.add_dependency "redcarpet", "~> 3.5.0"
-  spec.add_dependency "sass"
-  spec.add_dependency "sprockets", "~> 4.0.0"
 
-
-  spec.add_development_dependency "bundler", "~> 2.1.4"
   spec.add_development_dependency "byebug"
   spec.add_development_dependency "capybara", "~> 3.32"
   spec.add_development_dependency "jasmine", "~> 3.5.0"

data/lib/assets/javascripts/_modules/search.js

@@ -6,6 +6,7 @@
   Modules.Search = function Search () {
     var s = this
     var $html = $('html')
+    var $tocNav
     var $searchForm
     var $searchLabel
     var $searchInput
@@ -26,6 +27,7 @@
       $searchResults = $searchResultsWrapper.find('.search-results__content')
       $searchResultsTitle = $searchResultsWrapper.find('.search-results__title')
       $searchResultsClose = $searchResultsWrapper.find('.search-results__close')
+      $tocNav = $('#toc')
       s.downloadSearchIndex()
       attach()
       changeSearchLabel()
@@ -67,7 +69,14 @@
       $searchForm.on('submit', function (e) {
         e.preventDefault()
         showResults()
-        $searchResults.find('.search-result__title a').first().focus()
+        var $firstResult = $searchResults.find('.search-result__title a').first()
+        if ($firstResult.length) {
+          $firstResult.focus()
+        } else {
+          // if there are no results, show the "0 results" state
+          results = []
+          updateTitle()
+        }
       })
 
       // Closing the search results, move focus back to the search input
@@ -98,7 +107,7 @@
     }
 
     function changeSearchLabel () {
-      $searchLabel.text('Search')
+      $searchLabel.text('Search this documentation')
     }
 
     function getResults (query) {
@@ -192,12 +201,14 @@
       $searchResultsWrapper.addClass('is-open')
         .attr('aria-hidden', 'false')
       $html.addClass('has-search-results-open')
+      $tocNav.addClass('search-results-open')
     }
 
     function hideResults () {
       $searchResultsWrapper.removeClass('is-open')
         .attr('aria-hidden', 'true')
       $html.removeClass('has-search-results-open')
+      $tocNav.removeClass('search-results-open')
     }
 
     function sendQueryToAnalytics () {

data/lib/assets/javascripts/_modules/table-of-contents.js

@@ -7,23 +7,22 @@
     var $toc
     var $tocList
 
-    var $openLink
-    var $closeLink
+    var $openButton
+    var $closeButton
 
     this.start = function ($element) {
       $toc = $element
       $tocList = $toc.find('.js-toc-list')
-
       // Open link is not inside the module
-      $openLink = $html.find('.js-toc-show')
-      $closeLink = $toc.find('.js-toc-close')
+      $openButton = $html.find('.js-toc-show')
+      $closeButton = $toc.find('.js-toc-close')
 
       fixRubberBandingInIOS()
       updateAriaAttributes()
 
       // Need delegated handler for show link as sticky polyfill recreates element
-      $openLink.on('click.toc', preventingScrolling(openNavigation))
-      $closeLink.on('click.toc', preventingScrolling(closeNavigation))
+      $openButton.on('click.toc', preventingScrolling(openNavigation))
+      $closeButton.on('click.toc', preventingScrolling(closeNavigation))
       $tocList.on('click.toc', 'a', closeNavigation)
 
       // Allow aria hidden to be updated when resizing from mobile to desktop or
@@ -65,21 +64,17 @@
 
       toggleBackgroundVisiblity(false)
       updateAriaAttributes()
-
-      focusFirstLinkInToc()
+      $toc.focus()
     }
 
     function closeNavigation () {
       $html.removeClass('toc-open')
+      $html.removeClass('has-search-results-open')
 
       toggleBackgroundVisiblity(true)
       updateAriaAttributes()
     }
 
-    function focusFirstLinkInToc () {
-      $('a', $tocList).first().focus()
-    }
-
     function toggleBackgroundVisiblity (visibility) {
       $('.toc-open-disabled').attr('aria-hidden', visibility ? '' : 'true')
     }
@@ -87,7 +82,7 @@
     function updateAriaAttributes () {
       var tocIsVisible = $toc.is(':visible')
 
-      $($openLink).add($closeLink)
+      $($openButton).add($closeButton)
         .attr('aria-expanded', tocIsVisible ? 'true' : 'false')
 
       $toc.attr('aria-hidden', tocIsVisible ? 'false' : 'true')

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

@@ -13,11 +13,9 @@
 
   a:link,
   a:visited {
-    color: inherit;
-  }
-
-  a:hover {
-    color: $govuk-link-hover-colour;
+    &:not(:focus) {
+      color: inherit;
+    }
   }
 
   a:active {

data/lib/assets/stylesheets/modules/_search.scss

@@ -1,16 +1,9 @@
+$input-size: 40px;
+
 @include govuk-media-query($media-type: screen) {
   .page-title + .search {
     margin-top: govuk-spacing(6);
   }
-
-  .js .search__label {
-    position: absolute;
-    left: -9999em;
-    top: auto;
-    width: 1px;
-    height: 1px;
-    overflow: hidden;
-  }
 }
 
 @include govuk-media-query($media-type: print) {
@@ -19,11 +12,55 @@
   }
 }
 
+.js .search__label {
+  @extend .govuk-visually-hidden;
+}
+
+.search__form {
+  position: relative;
+}
+
+.search__input {
+  width: 230px;
+  width: calc(100% - #{$input-size});
+}
+
+.search__button {
+  position: absolute;
+  bottom: 0;
+  right: 0;
+  border: 0;
+  background-color: govuk-colour('blue');
+  color: #fff;
+  cursor: pointer;
+  padding: 0;
+  width: $input-size;
+  height: 100%;
+  background-image: url('/images/search-button.png');
+  background-repeat: no-repeat;
+  background-position: 2px 50%;
+  text-indent: -5000px;
+  overflow: hidden;
+  &:focus {
+    outline: $govuk-focus-width solid $govuk-focus-colour;
+    outline-offset: 0;
+    box-shadow: inset 0 0 0 $govuk-border-width-form-element * 2 govuk-colour("black");
+
+    @include govuk-if-ie8 {
+      border-width: $govuk-border-width-form-element * 2;
+    }
+  }
+}
+
 html.has-search-results-open {
   overflow: hidden;
   .app-pane__content {
     overflow: hidden;
   }
+  
+  .toc__close{
+    display: none;
+  }
 }
 .search-results {
   display: none;
@@ -47,6 +84,7 @@ html.has-search-results-open {
       top: 0;
       // The width of the sidebar
       left: 330px;
+      min-height: auto;
     }
 
     a:link, a:visited {