From eec59a0ca145a7d5c89f9a5655bf929d145108fb Mon Sep 17 00:00:00 2001 From: Laurence de Bruxelles Date: Fri, 26 Aug 2022 14:18:03 +0100 Subject: [PATCH 1/2] Rename default branch to 'main' Update links to use new name. Also leave a note to change the default branch name for the contribution banner link; we can't change this without it being a breaking change for users. --- CHANGELOG.md | 14 +++++++------- README.md | 4 ++-- lib/govuk_tech_docs/contribution_banner.rb | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5be520b5..639a90d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -422,7 +422,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 @@ -434,15 +434,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 @@ -450,8 +450,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 @@ -463,7 +463,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 diff --git a/README.md b/README.md index b537cf5c..06aab5e4 100644 --- a/README.md +++ b/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](blob/main/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/ diff --git a/lib/govuk_tech_docs/contribution_banner.rb b/lib/govuk_tech_docs/contribution_banner.rb index 9f42a082..2a28f24a 100644 --- a/lib/govuk_tech_docs/contribution_banner.rb +++ b/lib/govuk_tech_docs/contribution_banner.rb @@ -39,7 +39,7 @@ def repo_url 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 From f6fcf79c562d0d476a27a2ab9b55659aaee3b57b Mon Sep 17 00:00:00 2001 From: Laurence de Bruxelles Date: Fri, 26 Aug 2022 17:15:54 +0100 Subject: [PATCH 2/2] Update README.md Co-authored-by: Oliver Byford --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 06aab5e4..9c0781b6 100644 --- a/README.md +++ b/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/main/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