From e068ffa03d86a818c7ed81601f733e3f2461188b Mon Sep 17 00:00:00 2001 From: Fraser Greenroyd Date: Mon, 12 Feb 2024 16:47:09 +0000 Subject: [PATCH] Update links --- .../Operating Procedures/Beta patching procedure.md | 10 +++++----- .../Operating Procedures/Beta testing procedure.md | 2 +- .../End of milestone procedure.md | 12 ++++++------ .../Preparing a new milestone.md | 2 +- .../Producing a beta installer.md | 4 ++-- 5 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/DevOps/Operating Procedures/Beta patching procedure.md b/docs/DevOps/Operating Procedures/Beta patching procedure.md index 7a7dbe77..207bd08d 100644 --- a/docs/DevOps/Operating Procedures/Beta patching procedure.md +++ b/docs/DevOps/Operating Procedures/Beta patching procedure.md @@ -6,8 +6,8 @@ The contents of this page detail the actions to be undertaken in the event of a The following documents are not considered part of this procedure, but contain additional information which may be beneficial. It is recommended these are read in conjunction with this document. - - [Beta testing procedure](Beta-testing-procedure) - - [Producing a beta installer guide](Producing-a-beta-installer) + - [Beta testing procedure](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/Beta%20testing%20procedure/) + - [Producing a beta installer guide](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/Producing%20a%20beta%20installer/) # 2 - Activation of this procedure @@ -45,11 +45,11 @@ An important note to make, is the `TargetCommit` must be set to `main` to target ## 5.3 - Produce the beta installers -Full details of producing a beta installer can be found in the [Producing a Beta Installer guide](Producing-a-beta-installer). +Full details of producing a beta installer can be found in the [Producing a Beta Installer guide](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/Producing%20a%20beta%20installer/). ## 5.4 - Testing the beta installer -DevOps is responsible for deciding the scope of testing the patched beta artefact. Where there is any doubt as to the potential scope of changes produced by the patch, a full beta test should be conducted, as per the guidelines in [this procedure](End-of-Milestone-procedure#release-beta-installer-for-testing). +DevOps is responsible for deciding the scope of testing the patched beta artefact. Where there is any doubt as to the potential scope of changes produced by the patch, a full beta test should be conducted, as per the guidelines in [this procedure](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/End%20of%20milestone%20procedure/). Where the scope of testing can be clearly defined, the Discipline Lead of the affected repository is responsible for reporting back on successful use of the beta patch artefact, using all available test procedures. This work may be delegated down as appropriate to other developers and users, but the Discipline Code Lead takes final responsibility for reporting back. @@ -57,7 +57,7 @@ The testing of the beta patch artefact should be a matter of priority, and the D ## 5.5 - Releasing the beta installer -This is to be done in line with the release of a standard beta, the procedure for which can be found [here](End-of-Milestone-procedure#release-beta-installer-publicly). +This is to be done in line with the release of a standard beta, the procedure for which can be found [here](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/End%20of%20milestone%20procedure/). # 6 - External website diff --git a/docs/DevOps/Operating Procedures/Beta testing procedure.md b/docs/DevOps/Operating Procedures/Beta testing procedure.md index 81511297..e25ab8fe 100644 --- a/docs/DevOps/Operating Procedures/Beta testing procedure.md +++ b/docs/DevOps/Operating Procedures/Beta testing procedure.md @@ -1,6 +1,6 @@ # Beta Testing -The contents of this page detail the actions to be undertaken, with approximate timings, at the end of a Milestone to test the Beta installers in the lead up to the release of that Milestones beta. These procedures may be updated at any point. This document forms part of the [End of Milestone Procedure](End-of-Milestone-procedure). +The contents of this page detail the actions to be undertaken, with approximate timings, at the end of a Milestone to test the Beta installers in the lead up to the release of that Milestones beta. These procedures may be updated at any point. This document forms part of the [End of Milestone Procedure](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/End%20of%20milestone%20procedure/). # 1 - Purpose diff --git a/docs/DevOps/Operating Procedures/End of milestone procedure.md b/docs/DevOps/Operating Procedures/End of milestone procedure.md index 88d4d665..038ee1bd 100644 --- a/docs/DevOps/Operating Procedures/End of milestone procedure.md +++ b/docs/DevOps/Operating Procedures/End of milestone procedure.md @@ -6,9 +6,9 @@ The contents of this page detail the actions to be undertaken at the end of a gi The following documents are considered part of this procedure, and contain more in-depth details about specific aspects. It is recommended these are read in conjunction with this document. - - [Beta testing procedure](Beta-testing-procedure) - - [Producing a beta installer guide](Producing-a-beta-installer) - - [Preparing a new Milestone](Preparing-a-new-Milestone) + - [Beta testing procedure](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/Beta%20testing%20procedure/) + - [Producing a beta installer guide](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/Producing%20a%20beta%20installer/) + - [Preparing a new Milestone](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/Preparing%20a%20new%20milestone/) # 1 - Scope @@ -28,7 +28,7 @@ Development teams are responsible for ensuring their developers undertake this p ### 2.2 - Beta Test Procedure takes effect -The Beta Test Procedure is outlined in [this document](Beta-testing-procedure) and will be followed in accordance with the above statement regarding developing against the Beta installers. The DevOps team will oversee this operation during the lifecycle of the final sprint. +The Beta Test Procedure is outlined in [this document](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/Beta%20testing%20procedure/) and will be followed in accordance with the above statement regarding developing against the Beta installers. The DevOps team will oversee this operation during the lifecycle of the final sprint. ### 2.3 - `develop` into `main` @@ -94,7 +94,7 @@ Authorisation for final execution of the script resides with the Governance team ### 2.10 - Produce beta installer -Full details of producing a beta installer can be found in the [Producing a Beta Installer guide](Producing-a-beta-installer). +Full details of producing a beta installer can be found in the [Producing a Beta Installer guide](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/Producing%20a%20beta%20installer/). ### 2.11 - Release beta installer for testing @@ -133,7 +133,7 @@ The milestone should be closed and the GitHub milestones updated to reflect the Following the close out of the milestone, the next milestone should be set up ready to begin as soon as is appropriate. Typically, this might be after a weekend, but should be set up in such a way that the next milestone could begin the next day after release. -Full details of actions needed to be undertaken to set up the next milestone can be found in the [Preparing a new Milestone Procedure](Preparing-a-new-Milestone) +Full details of actions needed to be undertaken to set up the next milestone can be found in the [Preparing a new Milestone Procedure](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/Preparing%20a%20new%20milestone/) # 3 - Communications of the end of the milestone diff --git a/docs/DevOps/Operating Procedures/Preparing a new milestone.md b/docs/DevOps/Operating Procedures/Preparing a new milestone.md index 5a686368..6231264e 100644 --- a/docs/DevOps/Operating Procedures/Preparing a new milestone.md +++ b/docs/DevOps/Operating Procedures/Preparing a new milestone.md @@ -6,7 +6,7 @@ The contents of this page detail the actions to be undertaken at the beginning o The following documents are considered related to this procedure. It is recommended these are read in conjunction with this document for a full understanding of the procedures being followed. - - [End of Milestone procedure](End-of-Milestone-procedure) + - [End of Milestone procedure](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/End%20of%20milestone%20procedure/) # 2 - Purpose diff --git a/docs/DevOps/Operating Procedures/Producing a beta installer.md b/docs/DevOps/Operating Procedures/Producing a beta installer.md index 7b1ae622..d4e6dfd2 100644 --- a/docs/DevOps/Operating Procedures/Producing a beta installer.md +++ b/docs/DevOps/Operating Procedures/Producing a beta installer.md @@ -1,6 +1,6 @@ # Producing a beta installer -This outlines the steps necessary to follow to obtain a beta installer, and make it available for testing and release. This document forms part of the [End of Milestone Procedure](End-of-Milestone-procedure). +This outlines the steps necessary to follow to obtain a beta installer, and make it available for testing and release. This document forms part of the [End of Milestone Procedure](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/End%20of%20milestone%20procedure/). # 1 - Scope @@ -10,7 +10,7 @@ This procedure/guide is designed for the creation of a beta installer at the end The following information is to be provided and authorised by the DevOps team: - - PatchVersion - this should be 0 for an end of milestone release, but if doing a [beta patch release](Beta-Patching-Procedure), this should refer to the patch number being produced + - PatchVersion - this should be 0 for an end of milestone release, but if doing a [beta patch release](https://bhom.xyz/documentation/DevOps/Operating%20Procedures/Beta%20patching%20procedure/), this should refer to the patch number being produced - ReleaseType - this should be set to beta for any beta installer - Version - this should be set to the end of milestone version, inclusive of v - e.g. v3.0 v3.1, etc.