govuk_tech_docs 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06ad063ddc3de387b2bae379df43d4ecd6996a42bdc1f0472e2eb46b404b5701
-  data.tar.gz: 23b17f1d49d77303d7acb06be0ee2f30cd8ec9b40407b18689696008bf594b89
+  metadata.gz: 1fe53bb05a63a24a2d7d501d04fa172433d89e8f5fcd48bc4fc9313e97325ad0
+  data.tar.gz: 4b53d1f86522ae3807c40ba806befd97c5da2b42d92666fde35ac00bc0c89eba
 SHA512:
-  metadata.gz: dfff9af883e1eb613f704789bd55f65947309e5df3a7a1d1280f4a28483a55d38200108d9808279d3985e2fd75bdc86adccea94520bb7469a78cdfa654def53c
-  data.tar.gz: '09ae4a42091646b3850af6e4db030a0912e48a10df7b0db296621cdaa58c5df236c17399374201fe2f4af4bd38ce9525837a0811145cfea5fa380b70c5836541'
+  metadata.gz: 1b5bbfc06fe8387ddc6eae181fef27fca01d2afdefa68a7a5833e77d8eeb30e76335dc32fd13ca20501b88a107e8f0dfe3f0a64ba3cd8dcd9cfa1dc73e0c738f
+  data.tar.gz: 50751bf31f0ab377dca9618e749b9f8cbc029cf7a096085e8fdcea3d7004f42ce5901703bbb2c3cb11768aed369232226d74764a9347f02a5787b8822a9ef90d

data/.github/workflows/publish.yaml

@@ -3,7 +3,7 @@ name: Publish
 on:
   push:
     branches:
-      - master
+      - main
   workflow_dispatch:
 
 concurrency: rubygems

data/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 ## Unreleased
 
+## 3.3.0
+
+### New features
+
+There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.4.1.
+
+1. Update your documentation site to use the latest template version. You can [follow the TDT guidance on using the latest template version](https://tdt-documentation.london.cloudapps.digital/maintain_project/use_latest_template/).
+2. Check your documentation site displays correctly. If your site does not display correctly, you can refer to the [GOV.UK Frontend release notes](https://github.com/alphagov/govuk-frontend/releases/) for more information, or [contact the GOV.UK Design System team](https://design-system.service.gov.uk/get-in-touch/).
+
+### Fixes
+
+- [#242: Make scrollable area keyboard (and voice) focusable](https://github.com/alphagov/tech-docs-gem/pull/242) (thanks [@colinbm](https://github.com/colinbm))
+
+## 3.2.1
+
+### Fixes
+
+- [#296: Fix Nokogiri Node.new deprecation warnings](https://github.com/alphagov/tech-docs-gem/pull/296) (thanks [@timja](https://github.com/timja))
+
 ## 3.2.0
 
 ### New features
@@ -412,7 +431,7 @@ which item is selected in the navigation.
 More info:
 
 - https://github.com/alphagov/tech-docs-gem/pull/19
-- https://github.com/alphagov/tech-docs-gem/blob/master/docs/frontmatter.md#parent
+- https://github.com/alphagov/tech-docs-gem/blob/main/docs/frontmatter.md#parent
 
 ## 1.2.0
 
@@ -424,15 +443,15 @@ 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
+- https://github.com/alphagov/tech-docs-gem/blob/main/docs/configuration.md#redirects
+- https://github.com/alphagov/tech-docs-gem/blob/main/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
+https://github.com/alphagov/tech-docs-gem/blob/main/docs/configuration.md#show_contribution_banner
 
 ### New feature: page review system
 
@@ -440,8 +459,8 @@ 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
+- https://github.com/alphagov/tech-docs-gem/blob/main/docs/frontmatter.md#last_reviewed_on
+- https://github.com/alphagov/tech-docs-gem/blob/main/docs/frontmatter.md#owner_slack
 
 
 ### Better meta tags
@@ -453,7 +472,7 @@ Pages now include better meta tags for search engines, Twitter, Facebook and Sla
 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/main/docs/configuration.md#google_site_verification
 
 ## 1.0.0
 

data/README.md

@@ -15,7 +15,7 @@ Find out how to [contribute](https://tdt-documentation.london.cloudapps.digital/
 
 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 the [package.json file](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](package.json) and run `npm update`.
 
 ## Developing locally
 
@@ -96,7 +96,7 @@ The documentation is [© Crown copyright][copyright] and available under the ter
 [ogl]: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
 [tdt-docs]: https://tdt-documentation.london.cloudapps.digital
 [tdt-template]: https://github.com/alphagov/tech-docs-template
-[tdt-readme]: https://github.com/alphagov/tech-docs-template/blob/master/README.md
+[tdt-readme]: https://github.com/alphagov/tech-docs-template/blob/main/README.md
 [mmt]: https://middlemanapp.com/advanced/project_templates/
 
 [jas]: https://jasmine.github.io/

data/example/source/code.html.md

@@ -10,32 +10,9 @@ A paragraph with a `code` element within it.
 
 An example of a table with a `code` element within it.
 
-<div class="table-container">
-  <table>
-    <thead>
-      <tr>
-        <th style="text-align:left">httpResult</th>
-        <th style="text-align:left">Message</th>
-        <th style="text-align:left">How to fix</th>
-      </tr>
-    </thead>
-    <tbody>
-      <tr>
-        <td style="text-align:left"><code>400</code></td>
-        <td style="text-align:left">
-          <code>[{</code>
-          <br />
-          <code>"error": "BadRequestError",</code>
-          <br />
-          <code>"message": "Can't send to this recipient using a team-only API key"</code>
-          <br />
-          <code>]}</code>
-        </td>
-        <td style="text-align:left">Use the correct type of API key</td>
-      </tr>
-    </tbody>
-  </table>
-</div>
+| httpResult | Message | How to fix |
+| -          | -       | -          |
+| `400`      | `[{`<br>`"error": "BadRequestError",`<br>`"message": "Can't send to this recipient using a team-only API key"`<br>`]}` | Use the correct type of API key |
 
 An example of a code block with a long line length
 

data/lib/govuk_tech_docs/contribution_banner.rb

@@ -39,7 +39,7 @@ module GovukTechDocs
     end
 
     def repo_branch
-      config[:tech_docs][:github_branch] || "master"
+      config[:tech_docs][:github_branch] || "master" # TODO: change this to 'main' in a future breaking release
     end
 
   private

data/lib/govuk_tech_docs/tech_docs_html_renderer.rb

@@ -69,7 +69,7 @@ module GovukTechDocs
         first_child.content = leading_text.sub(/# */, "")
       end
 
-      tr = Nokogiri::XML::Node.new "tr", fragment
+      tr = Nokogiri::XML::Node.new "tr", fragment.document
       tr.children = fragment.children
 
       tr.to_html
@@ -95,9 +95,9 @@ module GovukTechDocs
         # be `defined?`, so we can jump straight to rendering HTML ourselves.
 
         fragment = Nokogiri::HTML::DocumentFragment.parse("")
-        pre = Nokogiri::XML::Node.new "pre", fragment
+        pre = Nokogiri::XML::Node.new "pre", fragment.document
         pre["tabindex"] = "0"
-        code = Nokogiri::XML::Node.new "code", fragment
+        code = Nokogiri::XML::Node.new "code", fragment.document
         code["class"] = lang
         code.content = text
         pre.add_child code

data/lib/govuk_tech_docs/version.rb

@@ -1,3 +1,3 @@
 module GovukTechDocs
-  VERSION = "3.2.0".freeze
+  VERSION = "3.3.0".freeze
 end

data/lib/source/layouts/core.erb

@@ -53,7 +53,7 @@
           </div>
         <% end %>
 
-        <div class="app-pane__content toc-open-disabled">
+        <div class="app-pane__content toc-open-disabled" aria-label="Content" tabindex="0">
           <main id="content" class="technical-documentation" data-module="anchored-headings">
             <%= yield %>
             <%= partial "layouts/page_review" %>