alphagov / govuk-content-api-docs

Documentation for the GOV.UK Content API.
https://content-api.publishing.service.gov.uk
MIT License
4 stars 7 forks source link

Bump govuk_tech_docs from 2.3.0 to 3.2.1 #87

Closed dependabot[bot] closed 2 years ago

dependabot[bot] commented 2 years ago

Bumps govuk_tech_docs from 2.3.0 to 3.2.1.

Release notes

Sourced from govuk_tech_docs's releases.

Release v3.2.1

Fixes

Release v3.2.0

New features

You can now configure your Tech Docs Template (TDT) to build your documentation site to use relative links to pages and assets.

Thanks @​eddgrant for contributing this feature and the associated fixes.

This change was introduced in [pull request #291: Support sites deployed on paths other than "/" (by generating relative links)](alphagov/tech-docs-gem#291).

v3.1.0

New features

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.
  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 for more information.

v3.0.1

Fixes

We’ve made the following fixes to the tech docs gem in [pull request #281: Don't break TOC when OpenAPI description includes headers](alphagov/tech-docs-gem#281):

  • we now render OpenAPI Markdown with the same Markdown renderer as other documents
  • table of contents (TOC) uses TechDocsHTMLRenderer to render the headings with IDs

Thanks to @​jamietanna for contributing to this issue and its solution.

v3.0.0

Breaking changes

The search user experience is now more accessible for screenreader users. Search results are now on a separate page instead of a modal window.

Users can no longer see search results as they type. They must press the Return key or select the search button to see the search results page.

This was added in [pull request #263: Change search to only show results after submit](alphagov/tech-docs-gem#263).

Fixes

v2.4.3

v2.4.2

... (truncated)

Changelog

Sourced from govuk_tech_docs's changelog.

3.2.1

Fixes

3.2.0

New features

You can now configure your Tech Docs Template (TDT) to build your documentation site to use relative links to pages and assets.

Thanks @​eddgrant for contributing this feature and the associated fixes.

This change was introduced in [pull request #291: Support sites deployed on paths other than "/" (by generating relative links)](alphagov/tech-docs-gem#291).

3.1.0

New features

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.
  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 for more information.

3.0.1

Fixes

We’ve made the following fixes to the tech docs gem in [pull request #281: Don't break TOC when OpenAPI description includes headers](alphagov/tech-docs-gem#281):

  • we now render OpenAPI Markdown with the same Markdown renderer as other documents
  • table of contents (TOC) uses TechDocsHTMLRenderer to render the headings with IDs

Thanks to @​jamietanna for contributing to this issue and its solution.

3.0.0

Breaking changes

The search user experience is now more accessible for screenreader users. Search results are now on a separate page instead of a modal window.

Users can no longer see search results as they type. They must press the Return key or select the search button to see the search results page.

This was added in [pull request #263: Change search to only show results after submit](alphagov/tech-docs-gem#263).

Fixes

... (truncated)

Commits
  • 3609472 Merge pull request #300 from alphagov/release-3.2.1
  • 6782c71 Release v3.2.1
  • d1a503b Merge pull request #298 from alphagov/ldeb-fix-deprecation-warning
  • bb8e10d Update changelog
  • a8f0ed8 Merge pull request #296 from timja/fix-deprecation-warning
  • cae2eee Pass a document rather than a fragment to new node
  • 1034346 Convert html table to markdown
  • b539e92 Merge pull request #294 from alphagov/release-3.2.0
  • 3fbf5c2 Release v3.2.0
  • 71febdb Merge pull request #293 from alphagov/ldeb-update-changelog
  • Additional commits viewable in compare view


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
brucebolt commented 2 years ago

@dependabot rebase