govuk_tech_docs 6.3.0.beta → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4749230e0456525bafbee2e00579a1b1170ce58c40d33a5c00672e6d1f14e61a
-  data.tar.gz: fad8867ac7acfc14d5e46108dbf592705c3d527a679474f9dc421b36648d196e
+  metadata.gz: e14e31166315775ce210071e6369ceed8e305111f6667a75e9dfb56216879616
+  data.tar.gz: 79b82c15e10ac592f12fa635db39838d0676cb86abcc2a33e654ed22cbe2cd7c
 SHA512:
-  metadata.gz: b38a0ea5499072b25c6500ef301958482189bd65a33766158061a8dc4c8af6625095d5ff807d28b2bd50610068c9f27d6dd845c45b070574a39abce5a346ddc2
-  data.tar.gz: a0d16ce398a23cfa9ee149ee2993522d13e72754931fe480e518f4ef8ee3bbee44c26eedc17c7e93c116705f077061b81a97be0746b1da53b66378dc28b12352
+  metadata.gz: 8fea921277de197457d49755c9c7ddee7cf60cfcff80e599304824a47b6f094e58947a7673f849719b00a730a7d2a6b4c9e5933b5c70b5d0d9b627d797c30cf2
+  data.tar.gz: 2009a67d569ae66cfeda08739e7223a74da595bdba126a9bb0f440bb5c5704ec90e8285ea543a4943ea794350b7fdffafb0e230f2aa308d8c71d9db1ed24fc3b

data/.github/ISSUE_TEMPLATE/documentation.yaml

@@ -0,0 +1,29 @@
+name: ✨ New or updated documentation
+description: Suggest a new feature or improvement
+title: "[Documentation]: "
+labels: ["documentation"]
+body:
+  - type: checkboxes
+    id: documentation-type
+    attributes:
+      label: Is this
+      options:
+        - label: a suggestion for new content
+          required: false
+        - label: an update to existing content
+          required: false
+        - label: a suggestion to remove content
+          required: false
+
+  - type: textarea
+    id: user-need
+    attributes:
+      label: User need
+      description: Do you have evidence that the change will meet the needs of users? Let us know about any user research or testing you’ve done
+
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: Optional — describe how you think this would look or link to a draft
+

data/.github/workflows/build-middleman-artifact.yaml

@@ -0,0 +1,41 @@
+name: 'Build middleman artifact'
+on:
+  workflow_call:
+    inputs:
+      upload-artifact:
+        default: false
+        required: false
+        type: boolean
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: documentation
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3
+        with:
+          fetch-depth: 0
+      - name: Setup Node
+        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
+        with:
+          node-version-file: 'documentation/.nvmrc'
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@89f90524b88a01fe6e0b732220432cc6142926af # v1.313.0
+        with:
+          bundler-cache: true
+          working-directory: documentation
+          ruby-version: '3'
+      - name: Install gems
+        run: bundle install
+      - name: Build
+        run: bundle exec middleman build
+      - name: Upload artifact
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v4.1.3
+        if: ${{ inputs.upload-artifact }}
+        with:
+          name: build
+          path: documentation/build/**
+          retention-days: 1

data/.github/workflows/deploy-to-pages.yaml

@@ -0,0 +1,39 @@
+name: 'Deploy to GitHub Pages'
+on:
+  push:
+    branches: ["main", "feature/publish-documentation"]
+    paths: ['documentation/**']
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    uses: ./.github/workflows/build-middleman-artifact.yaml
+    with:
+      upload-artifact: true
+  deploy-to-pages:
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download build artifact
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c #v8.0.1
+        with:
+          name: build
+          path: build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 #v5.0.0
+        with:
+          path: "build"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0

data/.github/workflows/publish.yaml

@@ -20,7 +20,7 @@ jobs:
         with:
           show-progress: false
 
-      - uses: ruby/setup-ruby@afeafc3d1ab54a631816aba4c914a0081c12ff2f # v1.310.0
+      - uses: ruby/setup-ruby@89f90524b88a01fe6e0b732220432cc6142926af # v1.313.0
         with:
           ruby-version: '3'
 
@@ -57,7 +57,7 @@ jobs:
           node-version-file: '.nvmrc'
           cache: 'npm'
 
-      - uses: ruby/setup-ruby@afeafc3d1ab54a631816aba4c914a0081c12ff2f # v1.310.0
+      - uses: ruby/setup-ruby@89f90524b88a01fe6e0b732220432cc6142926af # v1.313.0
         with:
           ruby-version: '3'
           bundler-cache: true

data/.github/workflows/test.yaml

@@ -31,10 +31,16 @@ jobs:
           node-version-file: '.nvmrc'
           cache: 'npm'
 
-      - uses: ruby/setup-ruby@afeafc3d1ab54a631816aba4c914a0081c12ff2f # v1.310.0
+      - uses: ruby/setup-ruby@89f90524b88a01fe6e0b732220432cc6142926af # v1.313.0
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
 
-      - name: Run tests
-        run: bundle exec rake
+      - name: Lint Ruby and javascript files
+        run: bundle exec rake lint
+
+      - name: Run Ruby unit tests
+        run: bundle exec rake spec
+
+      - name: Run Javascript tests
+        run: bundle exec rake jasmine:ci

data/.gitignore

@@ -10,7 +10,7 @@
 /test/tmp/
 /test/version_tmp/
 /tmp/
-
+.idea/
 # Used by dotenv library to load environment variables.
 # .env
 
@@ -28,9 +28,10 @@
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
 
-/example/build
-/example/.bundle
-/example/.sass-cache
+/spec/test-site/build
+/spec/test-site/.bundle
+/spec/test-site/.sass-cache
 
 Gemfile.lock
 node_modules
+documentation/build/

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 6.3.0
+
+- Bugfix [issue 258](https://github.com/alphagov/tech-docs-template/issues/258) - page layout structure to remove whitespace on short pages ([pull request 513](https://github.com/alphagov/tech-docs-gem/pull/513))  
+- [6.3.0.beta](#630beta) 
+
 ## 6.3.0.beta
 
 - Add `exe/tech_docs_jobs` to allow executable `Rake` commands
@@ -227,7 +232,7 @@ You can see more detail about this issue at [#323: Fix XSS vulnerability on sear
 
 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/).
+1. Update your documentation site to use the latest template version. You can [follow the TDT guidance on using the latest template version](https://alphagov.github.io/tech-docs-gem/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
@@ -244,7 +249,7 @@ There are some steps you should follow as the Technical Documentation Template (
 
 ### New features
 
-You can now [configure your Tech Docs Template (TDT) to build your documentation site to use relative links to pages and assets](https://tdt-documentation.london.cloudapps.digital/configure_project/global_configuration/#build-your-site-using-relative-links).
+You can now [configure your Tech Docs Template (TDT) to build your documentation site to use relative links to pages and assets](https://alphagov.github.io/tech-docs-gem/configure_project/global_configuration/#build-your-site-using-relative-links).
 
 Thanks [@eddgrant](https://github.com/eddgrant) for contributing this feature and the associated fixes.
 
@@ -256,7 +261,7 @@ This change was introduced in [pull request #291: Support sites deployed on path
 
 There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.0.0.
 
-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/).
+1. Update your documentation site to use the latest template version. You can [follow the TDT guidance on using the latest template version](https://alphagov.github.io/tech-docs-gem/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 4.0.0 release note](https://github.com/alphagov/govuk-frontend/releases/tag/v4.0.0) for more information.
 
 ## 3.0.1
@@ -465,7 +470,7 @@ Fixes bug where search results disappear when opening results in a new tab, maki
 
 Adds a `show_expiry` config option to allow you to choose whether to show the review due date and expired banner from your pages. Find out more about the [page expiry and review feature][expiry].
 
-[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review
+[expiry]: https://alphagov.github.io/tech-docs-gem/page-expiry.html#page-expiry-and-review
 
 ## 1.8.1
 

data/README.md

@@ -11,7 +11,7 @@ the [Tech Docs Template documentation][tdt-docs].
 
 Everybody who uses this project is encouraged to contribute.
 
-Find out how to [contribute](https://tdt-documentation.london.cloudapps.digital/support/#contribute).
+Find out how to [contribute](https://alphagov.github.io/tech-docs-gem/support/#contribute).
 
 ## Rake tasks
 
@@ -52,7 +52,7 @@ the [GOV.UK Design System](https://design-system.service.gov.uk/).
 
 This gem can also use [GOV.UK Design System nunjucks components](https://design-system.service.gov.uk/components/). It
 is recommended that you use these as they are user researched and accessibility tested. An example using the
-`govukButton` component is available in the [example site in this gem](./example/source/index.html.md.erb).
+`govukButton` component is available in the [example site in this gem](spec/example/source/index.html.md.erb).
 
 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`.
@@ -122,7 +122,7 @@ resources will also be included.
 There are 2 ways to develop with this gem. You can see your changes on either:
 
 - your own Tech Docs Template website
-- the example in this repository
+- the documentation in this repository
 
 ### Use your own Tech Docs Template website
 
@@ -133,17 +133,17 @@ gem 'govuk_tech_docs', path: '../tech-docs-gem'
 ```
 
 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).
+the [Tech Docs Template documentation on previewing your documentation](https://alphagov.github.io/tech-docs-gem/create_project/preview/#preview-your-documentation).
 
 If you experience [the FFI gem issue for Mojave users](https://github.com/alphagov/tech-docs-gem/issues/254), you should
 refer to this [list of possible fixes](#issue-with-ffi-on-osx-mohave).
 
-### Use the example in this repo
+### Use the documentation in this repo
 
-To start the example in this repo, run:
+To start the documentation in this repo, run:
 
 ```sh
-cd example
+cd documentation
 bundle install
 bundle exec middleman server
 ```
@@ -154,7 +154,7 @@ If you experience [the FFI gem issue for Mojave users](https://github.com/alphag
 refer to this [list of possible fixes](#issue-with-ffi-on-osx-mohave).
 
 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).
+the [Tech Docs template documentation on previewing your documentation](https://alphagov.github.io/tech-docs-gem/create_project/preview/#preview-your-documentation).
 
 ## Tests
 
@@ -237,7 +237,7 @@ licence.
 
 [ogl]: http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/
 
-[tdt-docs]: https://github.com/alphagov/tdt-documentation/
+[tdt-docs]: https://alphagov.github.io/tech-docs-gem/
 
 [tdt-template]: https://github.com/alphagov/tech-docs-template
 

data/Rakefile

@@ -16,7 +16,7 @@ end
 
 desc "Lint Ruby and JavaScript"
 task :lint do
-  sh "rubocop example lib spec Rakefile"
+  sh "rubocop -a spec/test-site documentation lib spec Rakefile"
   sh "npm run lint --silent"
 end
 

data/documentation/.nvmrc

@@ -0,0 +1 @@
+20

data/documentation/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+# For faster file watcher updates on Windows:
+gem "wdm", "~> 0.1.0", platforms: %i[mswin mingw]
+
+# Windows does not come with time zone data
+gem "tzinfo-data", platforms: %i[mswin mingw jruby]
+
+gem "govuk_tech_docs", path: ".."
+
+gem "middleman-gh-pages"

data/documentation/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Crown Copyright (Government Digital Service)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/documentation/README.md

@@ -0,0 +1,30 @@
+# Tech Docs Template Documentation
+
+This directory contains the documentation for the [`tech-docs-template`](https://github.com/alphagov/tech-docs-template), which uses the gem in this repository.
+
+The documentation covers:
+
+- creating and updating a site with the tech docs template
+- examples of how to use the gem helpers
+
+To start the documentation in this repo, run:
+
+```sh
+cd documentation
+bundle install
+bundle exec middleman server
+```
+
+## Publishing changes
+
+GitHub Actions automatically publishes changes merged into the main branch of this repository to [https://alphagov.github.io/tech-docs-gem/](https://alphagov.github.io/tech-docs-gem/).
+
+## Code of conduct
+
+Refer to the `alphagov` [code of conduct](https://github.com/alphagov/code-of-conduct).
+
+## Licence
+
+Unless stated otherwise, the codebase is released under the [MIT License](LICENSE). This covers both the codebase and any sample code in the documentation.
+
+The documentation is [© Crown copyright](http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/copyright-and-re-use/crown-copyright/) and available under the terms of the [Open Government 3.0 licence](https://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/).

data/documentation/Staticfile

@@ -0,0 +1,4 @@
+root: build 
+http_strict_transport_security: true
+http_strict_transport_security_include_subdomains: true
+location_include: includes/*.conf

data/documentation/config/tech-docs.yml

@@ -0,0 +1,45 @@
+# Host to use for canonical URL generation (without trailing slash)
+host: https://alphagov.github.io/tech-docs-gem
+
+# Header-related options
+show_govuk_logo: false
+service_name: Tech docs template
+service_link: https://alphagov.github.io/tech-docs-gem
+phase: Beta
+
+# Uncomment if you do not want to activate the GOV.UK Design System component extension
+enable_govuk_components: true
+
+# Links to show on right-hand-side of header
+header_links:
+  Template: https://github.com/alphagov/tech-docs-template
+  Ruby gem: https://github.com/alphagov/tech-docs-gem
+  Support: /support
+footer_links:
+  Accessibility: /accessibility/
+  
+# 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.
+max_toc_heading_level: 1
+
+# Multi-page options
+multipage_nav: true
+collapsible_nav: true
+
+# Show links to contribute on GitHub
+show_contribution_banner: true
+github_repo: https://github.com/alphagov/tech-docs-gem/documentation
+
+# Enable search
+enable_search: true
+
+# Ownership for page reviews
+default_owner_slack: '#gds-technical-writing'
+owner_slack_workspace: gds
+
+redirects:
+  page-expiry.html: configure_project/page_expiry_and_review/#set-review-date-for-pages
+  search.html: configure_project/global_configuration/#enable-search
+  content.html: write_docs/content/#write-your-content
+  create_new_project.html: create_project/create_new_project/#create-a-new-documentation-project

data/{example → documentation}/config.rb

@@ -1,12 +1,9 @@
 require "govuk_tech_docs"
 
-GovukTechDocs.configure(self)
-
-ignore "templates/*"
+set :relative_links, true
+activate :relative_assets
 
-proxy "/a-proxied-page.html", "templates/proxy_template.html", locals: {
-  title: "I am a title",
-}
+GovukTechDocs.configure(self)
 
 gem_root = File.expand_path("..", __dir__)
 files.watch :reload, path: File.join(gem_root, "lib")

data/documentation/source/accessibility/index.html.md.erb

@@ -0,0 +1,64 @@
+---
+title: Accessibility statement for Technical Documentation Template and documentation
+last_reviewed_on: 2021-10-06
+review_in: 6 months
+hide_in_navigation: true
+---
+
+# Accessibility
+
+The GOV.UK Technical Documentation Template and its documentation are maintained by the technical writing team at the Government Digital Service (GDS).
+
+## Accessibility statement for the Technical Documentation Template documentation website
+
+This accessibility statement applies to the documentation at [https://alphagov.github.io/tech-docs-gem](https://alphagov.github.io/tech-docs-gem/).
+
+This website is run by GDS. We want as many people as possible to be able to use this website. For example, that means you should be able to:
+
+- change colours, contrast levels and fonts
+- zoom in up to 300% without problems
+- navigate most of the website using just a keyboard
+- navigate most of the website using speech recognition software
+- listen to most of the website using a screen reader (including the most recent versions of JAWS, NVDA and VoiceOver)
+
+We’ve also made the website text as simple as possible to understand.
+
+[AbilityNet](https://mcmw.abilitynet.org.uk/) has advice on making your device easier to use if you have a disability.
+
+### How accessible this website is
+
+This website is fully compliant with the [Web Content Accessibility Guidelines version 2.1](https://www.w3.org/TR/WCAG21/) AA standard.
+
+#### Feedback and contact information
+
+If you need information on this website in a different format like accessible PDF, large print, easy read, audio recording or braille, email [technical-writers@digital.cabinet-office.gov.uk](mailto:technical-writers@digital.cabinet-office.gov.uk).
+
+We’ll consider your request and get back to you in 3 working days.
+
+##### Reporting accessibility problems with this website
+
+We’re always looking to improve the accessibility of this website. If you find any problems not listed on this page or think we’re not meeting accessibility requirements, email [technical-writers@digital.cabinet-office.gov.uk](mailto:technical-writers@digital.cabinet-office.gov.uk).
+
+##### Enforcement procedure
+
+The Equality and Human Rights Commission (EHRC) is responsible for enforcing the Public Sector Bodies (Websites and Mobile Applications) (No. 2) Accessibility Regulations 2018 (the ‘accessibility regulations’). If you’re not happy with how we respond to your complaint, [contact the Equality Advisory and Support Service (EASS)](https://www.equalityadvisoryservice.com/).
+
+#### Technical information about this website’s accessibility
+
+##### Compliance status
+
+This website is fully compliant with the [Web Content Accessibility Guidelines version 2.1](https://www.w3.org/TR/WCAG21/) AA standard.
+
+### Preparation of this accessibility statement
+
+This statement was prepared on 2 September 2020. It was last reviewed on 6 October 2021.
+
+This website was last tested in April 2021.
+
+## Using the Technical Documentation Template for your own documentation
+
+This [Technical Documentation Template](https://github.com/alphagov/tech-docs-template) was last tested in April 2021. The test was carried out by the [Digital Accessibility Centre (DAC)](https://digitalaccessibilitycentre.org/).
+
+While GDS takes steps to ensure the Technical Documentation Template is as accessible as possible by default, you’ll still need to make sure your documentation as a whole meets accessibility requirements. You must research your documentation content to ensure that it’s in context.
+
+Find out what you need to do to [make your service accessible](https://www.gov.uk/service-manual/helping-people-to-use-your-service/making-your-service-accessible-an-introduction) in the GOV.UK Service Manual.