From 446ea1d1037cb0fa117ec5048e83498f6d19da26 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 14 Mar 2024 12:16:11 +0000 Subject: [PATCH 1/2] npm: bump cypress from 13.6.6 to 13.7.0 (#393) Bumps [cypress](https://github.com/cypress-io/cypress) from 13.6.6 to 13.7.0. - [Release notes](https://github.com/cypress-io/cypress/releases) - [Changelog](https://github.com/cypress-io/cypress/blob/develop/CHANGELOG.md) - [Commits](https://github.com/cypress-io/cypress/compare/v13.6.6...v13.7.0) --- updated-dependencies: - dependency-name: cypress dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- package-lock.json | 14 +++++++------- package.json | 2 +- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/package-lock.json b/package-lock.json index 60071e83..67d45861 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ }, "devDependencies": { "axe-core": "^4.8.4", - "cypress": "^13.6.6", + "cypress": "^13.7.0", "cypress-axe": "^1.5.0" } }, @@ -2058,9 +2058,9 @@ } }, "node_modules/cypress": { - "version": "13.6.6", - "resolved": "https://registry.npmjs.org/cypress/-/cypress-13.6.6.tgz", - "integrity": "sha512-S+2S9S94611hXimH9a3EAYt81QM913ZVA03pUmGDfLTFa5gyp85NJ8dJGSlEAEmyRsYkioS1TtnWtbv/Fzt11A==", + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/cypress/-/cypress-13.7.0.tgz", + "integrity": "sha512-UimjRSJJYdTlvkChcdcfywKJ6tUYuwYuk/n1uMMglrvi+ZthNhoRYcxnWgTqUtkl17fXrPAsD5XT2rcQYN1xKA==", "dev": true, "hasInstallScript": true, "dependencies": { @@ -8421,9 +8421,9 @@ } }, "cypress": { - "version": "13.6.6", - "resolved": "https://registry.npmjs.org/cypress/-/cypress-13.6.6.tgz", - "integrity": "sha512-S+2S9S94611hXimH9a3EAYt81QM913ZVA03pUmGDfLTFa5gyp85NJ8dJGSlEAEmyRsYkioS1TtnWtbv/Fzt11A==", + "version": "13.7.0", + "resolved": "https://registry.npmjs.org/cypress/-/cypress-13.7.0.tgz", + "integrity": "sha512-UimjRSJJYdTlvkChcdcfywKJ6tUYuwYuk/n1uMMglrvi+ZthNhoRYcxnWgTqUtkl17fXrPAsD5XT2rcQYN1xKA==", "dev": true, "requires": { "@cypress/request": "^3.0.0", diff --git a/package.json b/package.json index a455cd50..58618e8d 100644 --- a/package.json +++ b/package.json @@ -35,6 +35,6 @@ "devDependencies": { "axe-core": "^4.8.4", "cypress-axe": "^1.5.0", - "cypress": "^13.6.6" + "cypress": "^13.7.0" } } From 52e86487a594243f4c61e3940f70fa89dc2c6a82 Mon Sep 17 00:00:00 2001 From: Jeff Horton <87995501+jeff-horton-ho-sas@users.noreply.github.com> Date: Thu, 14 Mar 2024 15:03:40 +0000 Subject: [PATCH 2/2] #364 - Review SEGAS-00003 Minimal documentation set for a product (#391) * #364 - Review SEGAS-00003 Minimal documentation set for a product After discussion in the ways of working guild meeting on 7th March 2024 we agreed that a lot of the incident management information is included in the product description section. This is now called out in that section, and the incident management has been rewritten to be about runbooks for expected tasks. * #364 - Update modified date * Call out disaster recovery Co-authored-by: Robert Deniszczyc <72561986+robertdeniszczyc2@users.noreply.github.com> * Bump updated date --------- Co-authored-by: Robert Deniszczyc <72561986+robertdeniszczyc2@users.noreply.github.com> --- .../minimal-documentation-set-for-a-product.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/standards/minimal-documentation-set-for-a-product.md b/docs/standards/minimal-documentation-set-for-a-product.md index 99fdb1fe..d364a8a6 100644 --- a/docs/standards/minimal-documentation-set-for-a-product.md +++ b/docs/standards/minimal-documentation-set-for-a-product.md @@ -2,7 +2,7 @@ layout: standard order: 1 title: Minimal documentation set for a product -date: 2023-10-26 +date: 2024-03-14 id: SEGAS-00003 tags: - Documentation @@ -18,7 +18,7 @@ A product should be documented to a minimum standard so that new engineers can b - [Product documentation MUST include a description of the product and what it is for](#product-documentation-must-include-a-description-of-the-product-and-what-it-is-for) - [Product documentation MUST include key architectural views](#product-documentation-must-include-key-architectural-views) - [Product documentation MUST include a decision log](#product-documentation-must-include-a-decision-log) -- [Product documentation MUST include incident management information](#product-documentation-must-include-incident-management-information) +- [Product documentation MUST include runbooks for expected tasks](#product-documentation-must-include-runbooks-for-expected-tasks) - [Product documentation MUST include information about observability](#product-documentation-must-include-information-about-observability) - [Product documentation MUST include build, release and deployment processes](#product-documentation-must-include-build%2C-release-and-deployment-processes) @@ -28,6 +28,7 @@ The description should provide domain context to an engineer and link to product - Information about the team - Key stakeholders + - Include contacts in case of a technical incident with the product - Who the [Senior Responsible Owner (SRO)](https://www.gov.uk/government/publications/the-role-of-the-senior-responsible-owner/the-role-of-the-senior-responsible-owner) is - User research findings - Product roadmap @@ -35,7 +36,7 @@ The description should provide domain context to an engineer and link to product - Governance and assurance documentation - IT health check reports - Security audits - - Service design package + - Service design package which MUST include the incident management process ### Product documentation MUST include key architectural views @@ -45,9 +46,11 @@ The architectural views may contain architecture diagrams, security models, enti A decision log should record key design decisions in context. A pattern should be selected to complement the team ways of working, and may include for example [Architecture Decision Records](https://adr.github.io/). -### Product documentation MUST include incident management information +### Product documentation MUST include runbooks for expected tasks -An incident management process should include technical points of contact, runbooks, and disaster recovery information. +Document any incident support, disaster recovery, and maintenance tasks that are the responsibility of the product team. + +Where a task can't be automated, provide a runbook detailing how to carry out that task. ### Product documentation MUST include information about observability