govuk_tech_docs 2.0.8 → 2.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0b123cc9f0def3edb572706b6a436e5f13077651bb2707fed1e367b5c5c7941
-  data.tar.gz: 7e1d5525805495efbec0b8c3192eba9022763f557df3a7a4d31b5a6ae419697e
+  metadata.gz: 35c96cfb5a9198c31ad6a4e4d4a3676299c938089127b1c2a564d2401c50ac10
+  data.tar.gz: 7ea84b4a4c0601a8c291020f538817b4d7dd7503aa57c22124e2dedf8deb3f34
 SHA512:
-  metadata.gz: e6db970cf21bff4276d957b6db10df14c160cf361169be7a6c131de6a69c93ba1e8da3f856cfa10a28e14b28f453202ec91f60c34424775e2642c8ca5638c5bd
-  data.tar.gz: 1db9a29bc0833e07f7b06c57fa7e3bc93fdf5b8c11bd682edfbe925f4244470e456104f23c7be3f58c6858c5d6ce8f380834fd4dfcc11c8a005a62ef9e2e9cf7
+  metadata.gz: 3b906c3c277e8f1a5a923c7e05a57491b801109d61d8bda3f3ab393905eff5b39297663ce856ec06735703df5bc1a2389be39948e6b23f633657cc6744226233
+  data.tar.gz: 0ffe6a62bed3f6f8e32c4a087fb3d1a7fb617ff1867e27d3d99f20c08e098de53230885e4dcd438348347596368366212bf17a81042528e5767abe5baa6300d0

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_gem:
   rubocop-govuk:
     - config/default.yml
 
-Layout/IndentHeredoc:
+Layout/HeredocIndentation:
   Enabled: false
 
 Naming/HeredocDelimiterNaming:

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## 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)
+
+## 2.0.12
+
+- [Pull request #179: Use current markup for header and footer](https://github.com/alphagov/tech-docs-gem/pull/179)
+- [Pull request #178: Update dependencies and fix tests](https://github.com/alphagov/tech-docs-gem/pull/178) – includes updating GOV.UK Frontend to v3.6.0.
+- [Pull request #176: Use correct separator for page titles](https://github.com/alphagov/tech-docs-gem/pull/176)
+
+## 2.0.11
+
+### Fixes
+
+- [Pull request #162: Fix line height spacing for multiline code elements](https://github.com/alphagov/tech-docs-gem/pull/162)
+- [Pull request #165: Update header alignment to match layout](https://github.com/alphagov/tech-docs-gem/pull/165)
+
+## 2.0.10
+
+### Fixes
+
+- [Pull request #160: Make sure IDs on collapsible navigation are unique](https://github.com/alphagov/tech-docs-gem/pull/160)
+
+## 2.0.9
+
+### Fixes
+
+- [Pull request #154: Fix table columns breaking content](https://github.com/alphagov/tech-docs-gem/pull/154).
+- [Pull request #155: Ensure the page can be pinch to zoomed](https://github.com/alphagov/tech-docs-gem/pull/155).
+
 ## 2.0.8
 
 Use of  `govuk-lint` replaced with `rubocop-govuk` due to the former [becoming deprecated](https://github.com/alphagov/govuk-lint/pull/133).

data/CONTRIBUTING.md

@@ -3,7 +3,10 @@
 Everybody who uses this project is encouraged to contribute to this project. If you're part of the [alphagov GitHub organisation](https://www.github.com/alphagov) you probably have write access to this repo. If you don't, ask a GitHub admin or #tech-docs-format on Slack.
 
 - Before adding your feature, [check the backlog to see if someone is already talking about it](https://github.com/alphagov/tech-docs-template/issues)
-- If you add a new option to `config/tech-docs.yml`, make sure you [document the option in docs/configuration.md](docs/configuration.md)
-- If you add a new option to the page frontmatter, make sure you [document the option in docs/frontmatter.md](docs/frontmatter.md)
+- If you add a new option to `config/tech-docs.yml`, make sure you [document the new configuration option][configuration]
+- If you add a new option to the page frontmatter, make sure you [document the new frontmatter configuration](docs/frontmatter.md)
 - You can test your contribution using [unit tests](spec/govuk_tech_docs), [javascript tests](spec/javascripts) or [integration tests](spec/features)
 - If your change is relevant to the users of the gem, add something to [CHANGELOG](CHANGELOG.md). You don't have to do this if it's just refactoring. Make sure that you include any upgrade instructions.
+
+[configuration]: https://github.com/alphagov/tdt-documentation/blob/master/source/amend_project/configuration/index.html.md.erb
+[frontmatter]: https://github.com/alphagov/tdt-documentation/blob/master/source/frontmatter.html.md.erb

data/Rakefile

@@ -6,6 +6,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 load "jasmine/tasks/jasmine.rake"
 
+desc "Lint Ruby and JavaScript"
 task :lint do
   sh "rubocop example lib spec Rakefile"
   sh "npm run lint --silent"

data/docs/configuration.md

@@ -1,228 +1,3 @@
 # 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:
-
-## `ga_tracking_id`
-
-Tracking ID from Google Analytics
-
-```yaml
-ga_tracking_id: UA-XXXX-Y
-```
-
-## `github_repo`
-
-Your repository. Required if [show_contribution_banner](#show-contribution-banner) is true.
-
-```yaml
-github_repo: alphagov/example-repo
-```
-
-## `github_branch`
-
-Your github branch name. Useful if your default branch is not named master.
-
-```yaml
-github_branch: source
-```
-
-## `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
-```
-
-## `enable_search`
-
-Enables search functionality. This indexes pages only and is not recommended for single-page sites.
-
-```yaml
-enable_search: true
-```
-
-## `header_links`
-
-Right hand side navigation.
-
-Example:
-
-```yaml
-header_links:
-  Documentation: /
-```
-
-## `footer_links`
-
-Links to show in footer.
-
-Example:
-
-```yaml
-footer_links:
-  Accessibility: /accessibility
-```
-
-## `host`
-
-Host to use for canonical URL generation (without trailing slash).
-
-Example:
-
-```yaml
-host: https://docs.cloud.service.gov.uk
-```
-
-## `collapsible_nav`
-
-Enable collapsible navigation in the sidebar. Defaults to false;
-
-```yaml
-collapsible_nav: true
-```
-
-## `multipage_nav`
-
-Enable multipage navigation in the sidebar. Defaults to false;
-
-```yaml
-multipage_nav: true
-```
-
-## `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`
-
-```yaml
-phase: "Beta"
-```
-
-## `prevent_indexing`
-
-Prevent robots from indexing (e.g. whilst in development)
-
-```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
-redirects:
-  /old-page.html: https://example.org/something-else.html
-  /another/old-page.html: /another/new-page.html
-```
-
-## `service_name`
-
-The service name in the header.
-
-Example:
-
-```yaml
-service_name: "Platform as a Service"
-```
-
-## `full_service_name`
-
-The full service name (maybe with GOV.UK)
-
-Example:
-
-```yaml
-full_service_name: "GOV.UK Pay"
-```
-
-## `service_link`
-
-What the service name in the header links to.
-
-default: '/'
-
-```yaml
-service_link: "/"
-```
-
-## `show_contribution_banner`
-
-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
-show_contribution_banner: true
-github_repo: alphagov/example-repo
-```
-
-## `source_urls`
-
-Customise the URLs that the contribution banner links to. Only useful if
-[show_contribution_banner](#show_contribution_banner) is turned on. By default, "Report issue" links
-to raising a GitHub issue but by modifying the `report_issue_url` it can link to an email address
-or another page.
-
-```yaml
-source_urls:
-  report_issue_url: mailto:support@example.com
-```
-
-## `show_govuk_logo`
-
-Whether to show the GOV.UK crown logo.
-
-default: `true`
-
-```yaml
-show_govuk_logo: true
-```
-
-## `api_path`
-
-Define a path to an Open API V3 spec file. This can be a relative file path or a URI to a raw file.
-
-```yaml
-api_path: ./source/pets.yml
-```
-
-## `owner_slack_workspace` and `default_owner_slack`
-
-These attributes are used to specify the owner of a page.  See the separate
-[documentation for page expiry][expiry] for more details.
-
-## `show_expiry`
-
-Decides whether or not to show a red banner when the page needs to be reviewed.
-
-If not present or set to `true`, the red banner will appear when the page needs to be reviewed. This is the default behaviour.
-
-If set to `false`, the red banner will not appear when the page needs to be reviewed.
-
-See the separate [documentation for page expiry][expiry] for more details.
-
-[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review
-
-## `show_review_banner`
-
-Decides whether or not to display the page review banner, regardless of whether the page needs to be reviewed or not.
-
-If not present or set to `true`, the banner will be displayed on the page. This is the default behaviour.
-
-If set to `false`, the banner will not be displayed.
-
-See the separate [documentation for page expiry][expiry] for more details.
-
-[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review
+This content has been moved to <https://tdt-documentation.london.cloudapps.digital/amend_project/configuration/#configuration-options>.

data/docs/frontmatter.md

@@ -1,156 +1,3 @@
 # 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.
-See the separate [documentation for page expiry][expiry] for more details.
-
-[expiry]: https://tdt-documentation.london.cloudapps.digital/page-expiry.html#page-expiry-and-review
-
-Example:
-
-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)
-
-If you do not specify a sidebar, you will get a simple one-column layout without one.
-
-```rb
----
-layout: core
----
-
-This page does not have a sidebar.
-```
-
-![](core-layout-without-sidebar.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"
----
-```
-
-## `source_url`
-
-If the contribution banner is turned on, you can override the "View source" link
-using `source_url`.
-
-Example:
-
-```yaml
-source_url: http://example.org/source.md
-```
-
-## `title`
-
-The browser title of the page.
-
-```yaml
----
-title: My beautiful page
----
-```
-
-## `weight`
-
-Affects the order a page is displayed in the sidebar navigation tree. Lower
-weights float to the top. Higher weights sink to the bottom.
-
-```yaml
----
-weight: 20
----
-```
-
-## `hide_in_navigation`
-
-Set `hide_in_navigation: true` to prevent the page from being rendered in the
-main page tree navigation.
-
-```yaml
----
-hide_in_navigation: true
----
-```
-
-## `parent`
-
-The page that should be highlighted as ‘active’ in the navigation.
-
-```yaml
----
-parent: shaving-yaks.html
----
-```
-
-[mm]: https://middlemanapp.com/basics/frontmatter
+This content has been moved to <https://tdt-documentation.london.cloudapps.digital/frontmatter.html#frontmatter>.