govuk_tech_docs 6.6.0.rc.local.tested → 6.6.0

data/documentation/README.md

@@ -1,30 +0,0 @@
-# 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

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

data/documentation/config/tech-docs.yml

@@ -1,56 +0,0 @@
-# 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
-product_name:
-service_name: Tech docs template
-service_link: https://alphagov.github.io/tech-docs-gem
-phase: Beta
-
-
-#These can be used to add custom classes to the GOV.UK header, footer and service navigation components. You can find more detail about these on the component documentation at:
-#https://design-system.service.gov.uk/components/header/
-#https://design-system.service.gov.uk/components/service-navigation/
-#https://design-system.service.gov.uk/components/footer/
-
-headerContainerClasses:
-headerClasses:
-navigationContainerClasses:
-navigationClasses:
-footerContainerClasses:
-footerClasses:
-
-# Links to show on service navigation below 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
-
-# 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/documentation/config.rb

@@ -1,21 +0,0 @@
-require "govuk_tech_docs"
-
-set :relative_links, true
-activate :relative_assets
-
-GovukTechDocs.configure(self)
-
-gem_root = File.expand_path("..", __dir__)
-files.watch :reload, path: File.join(gem_root, "lib")
-
-configure :development do
-  ready do
-    files.on_change :reload do |changed|
-      changed.each do |file|
-        next unless file.full_path.extname == ".rb"
-
-        load file.full_path.to_s
-      end
-    end
-  end
-end

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

@@ -1,64 +0,0 @@
----
-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.

data/documentation/source/configure_project/frontmatter/index.html.md.erb

@@ -1,206 +0,0 @@
----
-title: Configure page settings
-weight: 34
-last_reviewed_on: 2020-07-01
-review_in: 1 year
----
-
-# Configure page settings
-
-You configure individual pages in your documentation by editing the page frontmatter.
-
-The page frontmatter contains page-specific variables at the top of the page.
-
-For a general introduction on frontmatter, see the [Middleman frontmatter documentation][mm].
-
-For example:
-
-```html
----
-title: Page title
-weight: 100
-last_reviewed_on: 2100-01-01
-review_in: 1 year
----
-
-# Configure page settings
-
-You configure individual pages in your documentation by editing the page frontmatter.
-```
-
-<%= warning_text('You should enable or disable settings to increase the usability of your documentation or because of best practice.') %>
-
-If you are not sure which settings to enable or disable, [contact the GDS tech writers][contact-email].
-
-## Required frontmatter settings
-
-There are no required frontmatter settings in a single page documentation site.
-
-In a multipage documentation site, you must include the weight frontmatter setting.
-
-### weight
-
-Sets the order of pages in the left hand navigation.
-
-This setting works the same way as page numbers in a book. A lower weight value is higher in the navigation. A higher weight value is lower in the navigation.
-
-For example a page with a weight of 10 will appear higher in the navigation than a page with a weight of 20.
-
-```yaml
----
-weight: 20
----
-```
-
-## Optional frontmatter settings
-
-You can enable and disable the following optional settings in the page frontmatter.
-
-### description
-
-Sets the description for the page, which will be used in search engine results or on social media.
-
-```yaml
----
-description: Configuring page settings in the GDS Technical Documentation Template.
----
-```
-
-### hide_in_navigation
-
-Set `hide_in_navigation: true` to prevent the page from being rendered in the main left hand navigation.
-
-```yaml
----
-hide_in_navigation: true
----
-```
-
-### "last_reviewed_on" and "review_in"
-
-These attributes determine the date when the page needs to be reviewed next.
-
-See [page expiry and review documentation][expiry] for more details.
-
-You can use this in combination with the [owner_slack variable](#owner-slack) to set an owner for the page.
-
-### layout
-
-The layout of the page. 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
-```
-
-This layout generates a page with the headings from the content in the sidebar.
-
-If you want more control about the layout, you can use the `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.
-```
-
-If you do not specify a sidebar, you get a one-column layout without a sidebar.
-
-```rb
----
-layout: core
----
-
-This page does not have a sidebar.
-```
-
-You can use layouts to group pages and customise your Table of Contents (ToC).  To create a layout, create a new ruby file in the `source/layouts` directory, for example `source/layouts/live_support.erb`.  
-
-Apply the template by including it in the frontmatter block of a page. In this example, we're applying the `live_support` layout to the page:
-
-```rb
----
-layout: live_support
----
-```
-
-The `tech-docs-gem` also has [helper functions you can use to manage your Table of Contents](https://github.com/alphagov/tech-docs-gem?tab=readme-ov-file#table-of-contents-helper-functions).
-
-### 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. Use this to appoint an individual or team as responsible for keeping the page up to date.
-
-```yaml
----
-owner_slack: "#operations-teams"
----
-```
-
-### parent
-
-Defines the page that should be highlighted as ‘active’ in the navigation.
-
-```yaml
----
-parent: shaving-yaks.html
----
-```
-
-### prevent_indexing
-
-Set `prevent_indexing: true` to prevent the page from being indexed by search engines.
-
-```yaml
----
-prevent_indexing: true
----
-```
-
-### 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
----
-```
-
-<%= partial "partials/links" %>