diff --git a/.eleventy.js b/.eleventy.js index e0ccd249..f44afb8c 100644 --- a/.eleventy.js +++ b/.eleventy.js @@ -30,7 +30,7 @@ module.exports = function(eleventyConfig) { }, footer: { copyright: { - html: '© Crown Copyright (Home Office)' + html: '© Crown Copyright (Home Office)' }, meta: { items: [ @@ -47,7 +47,7 @@ module.exports = function(eleventyConfig) { text: 'Accessibility' }, { - href: 'https://github.com/HO-CTO/engineering-guidance-and-standards', + href: 'https://github.com/UKHomeOffice/engineering-guidance-and-standards', text: 'GitHub repository' } ] diff --git a/.github/ISSUE_TEMPLATE/propose-a-new-principle.md b/.github/ISSUE_TEMPLATE/propose-a-new-principle.md index ef391d97..48dd7915 100644 --- a/.github/ISSUE_TEMPLATE/propose-a-new-principle.md +++ b/.github/ISSUE_TEMPLATE/propose-a-new-principle.md @@ -6,7 +6,7 @@ labels: 'content, principle' assignees: '' --- -Our engineering principles are the high-level direction we want to encourage engineers to follow or consider when they are making decisions and implementing things. Look at the ['writing a principle' standard](https://ho-cto.github.io/engineering-guidance-and-standards/docs/standards/writing-a-principle/) and provide some brief information below +Our engineering principles are the high-level direction we want to encourage engineers to follow or consider when they are making decisions and implementing things. Look at the ['writing a principle' standard](https://engineering.homeoffice.gov.uk/standards/writing-a-principle/) and provide some brief information below **What is the principle you are suggesting?** A concise description of the principle diff --git a/.github/ISSUE_TEMPLATE/propose-a-new-standard.md b/.github/ISSUE_TEMPLATE/propose-a-new-standard.md index e944e0af..a41ac082 100644 --- a/.github/ISSUE_TEMPLATE/propose-a-new-standard.md +++ b/.github/ISSUE_TEMPLATE/propose-a-new-standard.md @@ -6,7 +6,7 @@ labels: 'content, standard' assignees: '' --- -Our engineering standards are the things that we expect engineers to do. Look at the ['writing a standard' standard](https://ho-cto.github.io/engineering-guidance-and-standards/docs/standards/writing-a-standard/) and provide some brief information below +Our engineering standards are the things that we expect engineers to do. Look at the ['writing a standard' standard](https://engineering.homeoffice.gov.uk/standards/writing-a-standard/) and provide some brief information below **What is the standard you are suggesting?** A concise description of the standard diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8df37e52..f77aa7c7 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,7 +3,7 @@ Is this pull request a content or a code change? (Please fill in the relevant se # Code change I can confirm: ## Accessibility considerations -- [ ] Please review the [accessibility checks for layout changes](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/technical-docs/accessibility/layout-checks.md). +- [ ] Please review the [accessibility checks for layout changes](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/technical-docs/accessibility/layout-checks.md). - [ ] This change will not change layouts, page structures or anything else that might impact accessibility @@ -15,12 +15,12 @@ or (If the change might impact accessibility then please add some further information here) # Content change -- [ ] Please review the [accessibility checks for content changes](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/technical-docs/accessibility/content-checks.md). +- [ ] Please review the [accessibility checks for content changes](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/technical-docs/accessibility/content-checks.md). I can confirm: - [ ] Content does not include any code or configuration changes (excluding frontmatter information) - [ ] Content meets the content standards -e.g. [Writing a principle](https://ho-cto.github.io/engineering-guidance-and-standards/docs/standards/writing-a-principle/) and [Writing a standard](https://ho-cto.github.io/engineering-guidance-and-standards/docs/standards/writing-a-standard/) +e.g. [Writing a principle](https://engineering.homeoffice.gov.uk/standards/writing-a-principle/) and [Writing a standard](https://engineering.homeoffice.gov.uk/standards/writing-a-standard/) - [ ] Content is suitable to open source, i.e.: - Content does not relate to unreleased gov policy - Content does not refer to anti-fraud mechanisms diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 82391c10..d5a2c96a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,7 +5,7 @@ expect contributions to be made, which is adding new principles, standards, guid To contact the team you can get us at [segas@digital.homeoffice.gov.uk](mailto:segas@digital.homeoffice.gov.uk) -Please read and follow our [Code of Conduct](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/CODE_OF_CONDUCT.md). +Please read and follow our [Code of Conduct](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/CODE_OF_CONDUCT.md). ## New to open source @@ -24,7 +24,7 @@ We will now look at the process we expect contributors to take when suggesting f ### Create an issue - Before submitting an issue, please search the issue tracker to check the issue is not already there. -- Please [create an issue](https://github.com/HO-CTO/engineering-guidance-and-standards/issues/new/choose) if you wish to: +- Please [create an issue](https://github.com/UKHomeOffice/engineering-guidance-and-standards/issues/new/choose) if you wish to: - report a bug - propose a new pattern - propose a new principle @@ -33,11 +33,11 @@ We will now look at the process we expect contributors to take when suggesting f ### Solve an issue -- Have a look at our [existing issues](https://github.com/HO-CTO/engineering-guidance-and-standards/issues), and you might find something you would like to help us on! +- Have a look at our [existing issues](https://github.com/UKHomeOffice/engineering-guidance-and-standards/issues), and you might find something you would like to help us on! ## Make changes -To start the process of making changes to an issue you have raised, firstly you should [fork our repo](https://github.com/HO-CTO/engineering-guidance-and-standards/fork). This is so you can make changes without affecting the original project until you're ready. +To start the process of making changes to an issue you have raised, firstly you should [fork our repo](https://github.com/UKHomeOffice/engineering-guidance-and-standards/fork). This is so you can make changes without affecting the original project until you're ready. ### Create a branch @@ -61,7 +61,7 @@ Don't forget to commit and push your changes to your forked repo ready for the c ### Report a security vulnerability -You can report a security vulnerability to the Home Office Engineering Guidance and Standards team using the [repository's security advisory page](https://github.com/HO-CTO/engineering-guidance-and-standards/security/advisories/new). +You can report a security vulnerability to the Home Office Engineering Guidance and Standards team using the [repository's security advisory page](https://github.com/UKHomeOffice/engineering-guidance-and-standards/security/advisories/new). ## Pull Requests @@ -99,11 +99,10 @@ However, if you feel that some changes are becoming more complex, then you may w ## Build, release, deploy -We are using [GitHub workflows](https://github.com/HO-CTO/engineering-guidance-and-standards/tree/main/.github/workflows) for build and deploy and automated end to end testing. +We are using [GitHub workflows](https://github.com/UKHomeOffice/engineering-guidance-and-standards/tree/main/.github/workflows) for build and deploy and automated end to end testing. The following actions are performed for each PR: - Automated end to end testing using Cypress. -- [Snyk](https://github.com/snyk/actions) to prevent known vulnerabilities being introduced. PRs must only be approved after they pass the above checks. @@ -123,7 +122,7 @@ You can tag any of the maintainers of this repo to get pre-pull request reviews Patterns, principles and standards should be created in the correct subdirectory in `/docs`. We are also using a tagging and metadata approach to organise content across the site by topic and related knowledge domain. -All patterns, principles and standards content should be tagged in the frontmatter of the .md file to reference at least one of the below topic domains. Follow the guidance on tagging from the ['writing a standard' standard](https://ho-cto.github.io/engineering-guidance-and-standards/standards/writing-a-standard/#a-standard-must-have-tags). +All patterns, principles and standards content should be tagged in the frontmatter of the .md file to reference at least one of the below topic domains. Follow the guidance on tagging from the ['writing a standard' standard](https://engineering.homeoffice.gov.uk/standards/writing-a-standard/#a-standard-must-have-tags). - Observability - the process of monitoring applications, services and reliability - Software Design - how our applications, services and software are architected at the software level @@ -132,18 +131,18 @@ All patterns, principles and standards content should be tagged in the frontmatt - Build, Release and Deploy - all things pipelines, building and platform engineering - Source Control - storing and managing the source code -You can view a list of [all the topic domain tags currently in use across the site](https://ho-cto.github.io/engineering-guidance-and-standards/tags/). Your content may cross cut many of these areas, and that is ok, tag everything that you think is relevant. +You can view a list of [all the topic domain tags currently in use across the site](https://engineering.homeoffice.gov.uk/tags/). Your content may cross cut many of these areas, and that is ok, tag everything that you think is relevant. ## Look at the standard for the content When creating content please take a look at the standard for that content. This helps to make sure we are all creating content correctly. -- [Writing a principle](https://ho-cto.github.io/engineering-guidance-and-standards/docs/standards/writing-a-principle/) -- [Writing a standard](https://ho-cto.github.io/engineering-guidance-and-standards/docs/standards/writing-a-standard/) +- [Writing a principle](https://engineering.homeoffice.gov.uk/standards/writing-a-principle/) +- [Writing a standard](https://engineering.homeoffice.gov.uk/standards/writing-a-standard/) ### Templates You can use the following templates when creating content: -- [Pattern template](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/docs/patterns/pattern.template.md) -- [Principle template](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/docs/principles/principle.template.md) -- [Standard template](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/docs/standards/standard.template.md) +- [Pattern template](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/docs/patterns/pattern.template.md) +- [Principle template](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/docs/principles/principle.template.md) +- [Standard template](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/docs/standards/standard.template.md) diff --git a/README.md b/README.md index 6613296c..97c97e3e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Engineering Guidance and Standards -This is the home of engineering guidance and standards for the Home Office. Learn more about this project on the [about page](https://ho-cto.github.io/engineering-guidance-and-standards/about/). +This is the home of engineering guidance and standards for the Home Office. Learn more about this project on the [about page](https://engineering.homeoffice.gov.uk/about/). It is built using Markdown, GOV.UK templates, HO styles, the x-gov Eleventy Plugin, GitHub Actions and GitHub pages. @@ -66,4 +66,4 @@ This will open up the Cypress UI, which you can use to run the end-to-end tests > The site must be running on localhost for the tests to work. See [Preview your changes locally](#preview-your-changes-locally). ## Contributing -See the [contributing page](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/CONTRIBUTING.md) for details on how to contribute. +See the [contributing page](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/CONTRIBUTING.md) for details on how to contribute. diff --git a/SECURITY.md b/SECURITY.md index 5248fc17..971b4adc 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -2,7 +2,7 @@ ## Report a security vulnerability -You can report a vulnerability to the Home Office Engineering Guidance and Standards team through the [repository's security advisory page](https://github.com/HO-CTO/engineering-guidance-and-standards/security/advisories/new). +You can report a vulnerability to the Home Office Engineering Guidance and Standards team through the [repository's security advisory page](https://github.com/UKHomeOffice/engineering-guidance-and-standards/security/advisories/new). Please enter as much information as possible in your report, this will help us better triage the vulnerability. diff --git a/docs/about.md b/docs/about.md index e391d4ec..7e9df665 100644 --- a/docs/about.md +++ b/docs/about.md @@ -27,7 +27,7 @@ This guidance was originally published on an internal content platform. We have Proposed content for principles, standards and patterns go through a short process of collaborative creation, and require approval from Home Office engineering leadership to be merged into the site. This is managed via a process which will be familiar to users of GitHub - creating issues and branches for new content, and raising pull requests for review. We also have a small group of engineers committed to the ongoing maintenance and improvement of this site. -You can find out more about how to contribute in our [CONTRIBUTING.md](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/CONTRIBUTING.md) and you can [raise an issue directly onto the GitHub repository](https://github.com/HO-CTO/engineering-guidance-and-standards/issues). +You can find out more about how to contribute in our [CONTRIBUTING.md](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/CONTRIBUTING.md) and you can [raise an issue directly onto the GitHub repository](https://github.com/UKHomeOffice/engineering-guidance-and-standards/issues). ## Our roadmap diff --git a/docs/accessibility-statement.md b/docs/accessibility-statement.md index 5bc4409a..f5104f1e 100644 --- a/docs/accessibility-statement.md +++ b/docs/accessibility-statement.md @@ -23,12 +23,12 @@ We've also made the website text as simple as possible to understand. ## How accessible this website is -Accessibility issues with the site are tracked in GitHub. You can [view a list of outstanding accessibility issues](https://github.com/HO-CTO/engineering-guidance-and-standards/issues?q=is%3Aissue+is%3Aopen+label%3Aaccessibility). +Accessibility issues with the site are tracked in GitHub. You can [view a list of outstanding accessibility issues](https://github.com/UKHomeOffice/engineering-guidance-and-standards/issues?q=is%3Aissue+is%3Aopen+label%3Aaccessibility). ## Reporting accessibility problems with this website If you are having difficulties accessing this site, please let us know. You can: -- [Raise a new issue in GitHub](https://github.com/HO-CTO/engineering-guidance-and-standards/issues/new?assignees=&labels=accessibility&projects=&template=report_an_accessibility_issue.md&title=%5BA11Y%5D) +- [Raise a new issue in GitHub](https://github.com/UKHomeOffice/engineering-guidance-and-standards/issues/new?assignees=&labels=accessibility&projects=&template=report_an_accessibility_issue.md&title=%5BA11Y%5D) - [Email us at segas@digital.homeoffice.gov.uk](mailto:segas@digital.homeoffice.gov.uk) ## Enforcement procedure @@ -47,7 +47,7 @@ This website is compliant with the [Web Content Accessibility Guidelines version ## Non-accessible content -At the time of writing there is no known non-accessible content. You can [list recently raised accessibility issues in GitHub](https://github.com/HO-CTO/engineering-guidance-and-standards/issues?q=is%3Aissue+is%3Aopen+label%3Aaccessibility). +At the time of writing there is no known non-accessible content. You can [list recently raised accessibility issues in GitHub](https://github.com/UKHomeOffice/engineering-guidance-and-standards/issues?q=is%3Aissue+is%3Aopen+label%3Aaccessibility). ## Preparation of this accessibility statement @@ -56,5 +56,5 @@ At the time of writing there is no known non-accessible content. You can [list r We test this site as it develops by running automated accessibility tests provided by [`axe-core`](https://github.com/dequelabs/axe-core) on all changes, and by following a script of manual checks to perform when reviewing changes to the site. These are stored in GitHub: -- [Checklist for content changes](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/technical-docs/accessibility/content-checks.md) -- [Checklist for layout and template changes](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/technical-docs/accessibility/layout-checks.md) +- [Checklist for content changes](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/technical-docs/accessibility/content-checks.md) +- [Checklist for layout and template changes](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/technical-docs/accessibility/layout-checks.md) diff --git a/docs/provide-feedback.md b/docs/provide-feedback.md index d9ffb7fa..79a9655e 100644 --- a/docs/provide-feedback.md +++ b/docs/provide-feedback.md @@ -15,7 +15,7 @@ This is the preferred option. If you raise an issue on our repository you can ea You will need a GitHub account in order to create an issue, which will involve agreeing to [GitHub's privacy policy](https://docs.github.com/en/site-policy/privacy-policies/github-privacy-statement). -[Raise an issue on our GitHub repository](https://github.com/HO-CTO/engineering-guidance-and-standards/issues/new/choose) +[Raise an issue on our GitHub repository](https://github.com/UKHomeOffice/engineering-guidance-and-standards/issues/new/choose) ## Get in touch directly diff --git a/docs/standards/open-source-licensing.md b/docs/standards/open-source-licensing.md index 6a4a65e9..4e377461 100644 --- a/docs/standards/open-source-licensing.md +++ b/docs/standards/open-source-licensing.md @@ -22,7 +22,7 @@ This standard is broadly similar to the [GDS Licensing Guidelines](https://gds-w ### Open source repositories MUST contain a licence file -Ensure that there is a LICENCE or LICENCE.md file in the root of your repository. This should be included in the repository as early as possible. The LICENCE file should contain minimal or no other information beyond the licence itself and the copyright notice. See the [LICENCE file for this site](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/LICENCE) for an example. +Ensure that there is a LICENCE or LICENCE.md file in the root of your repository. This should be included in the repository as early as possible. The LICENCE file should contain minimal or no other information beyond the licence itself and the copyright notice. See the [LICENCE file for this site](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/LICENCE) for an example. ### Open source repositories MUST have a licence that adheres to the Open Source Definition diff --git a/docs/standards/writing-a-principle.md b/docs/standards/writing-a-principle.md index fbc5c4d8..cfd0bf54 100644 --- a/docs/standards/writing-a-principle.md +++ b/docs/standards/writing-a-principle.md @@ -77,6 +77,6 @@ date: 2023-12-31 ## Template -You can use the [principle template](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/docs/principles/principle.template.md) when creating a new principle. +You can use the [principle template](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/docs/principles/principle.template.md) when creating a new principle. --- diff --git a/docs/standards/writing-a-standard.md b/docs/standards/writing-a-standard.md index 6764a60f..6084d8dd 100644 --- a/docs/standards/writing-a-standard.md +++ b/docs/standards/writing-a-standard.md @@ -83,6 +83,6 @@ date: 2023-12-31 ## Template -You can use the [standard template](https://github.com/HO-CTO/engineering-guidance-and-standards/blob/main/docs/standards/standard.template.md) when creating a new standard. +You can use the [standard template](https://github.com/UKHomeOffice/engineering-guidance-and-standards/blob/main/docs/standards/standard.template.md) when creating a new standard. --- diff --git a/helm/templates/ingress-external.yaml b/helm/templates/ingress-external.yaml index 70024efa..096491c5 100644 --- a/helm/templates/ingress-external.yaml +++ b/helm/templates/ingress-external.yaml @@ -5,7 +5,7 @@ kind: Ingress metadata: name: {{ include "app.name" . }}-external labels: - cert-manager.io/solver: route53 + cert-manager.io/solver: "http01" annotations: cert-manager.io/enabled: "true" ingress.kubernetes.io/force-ssl-redirect: "true"