Merge pull request #491 from ministryofjustice/daniel-manual-spaniel

Reviewed & updated these pages
ministryofjustice · Oct 20, 2023 · 5b24bed · 5b24bed
2 parents 15d4b8d + 3ddd9db
commit 5b24bed
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 43 deletions.
diff --git a/source/documentation/team-guide/best-practices/zenhub.html.md.erb b/source/documentation/team-guide/best-practices/zenhub.html.md.erb
@@ -1,7 +1,7 @@
 ---
 owner_slack: "#nvvs-devops"
 title: ZenHub
-last_reviewed_on: 2023-06-20
+last_reviewed_on: 2023-10-19
 review_in: 3 months
 ---
 
@@ -11,48 +11,48 @@ We use [ZenHub](https://www.zenhub.com/boards) which is integrates natively to G
 
 The lifecycle of a issue is as follows. A user realises a need in the system. This can be a Story, Bug or Task. Issues in progress should be updated at the end of each day.
 
-Once a issue is in our backlog it will first go to [Backlog Refinement](../../../documentation/general-information/our-ceremonies.html#backlog-refinement), where it will become 'Ready for Development' then prioritised in [Backlog Grooming](../../../documentation/general-information/our-ceremonies.html#backlog-grooming). 
+Once a issue is in our backlog it will first go to [Backlog Refinement](../../../documentation/general-information/our-ceremonies.html#backlog-refinement), where it will become 'Ready for Development' then prioritised in [Backlog Grooming](../../../documentation/general-information/our-ceremonies.html#backlog-grooming).
 
-The issue will then either be pulled into a Sprint during a [Sprint Planning](../../../documentation/general-information/our-ceremonies.html#sprint-planning) session or it can remain indefinitely in 'Ready for Development' until the backlog is cleared out. 
+The issue will then either be pulled into a Sprint during a [Sprint Planning](../../../documentation/general-information/our-ceremonies.html#sprint-planning) session or it can remain indefinitely in 'Ready for Development' until the backlog is cleared out.
 
-If a issue is Ready For Development, this does not necessarily mean the issue will be ever be done. Issues are pulled into Sprint based on their value and alignment to the current Roadmap. 
+If a issue is Ready For Development, this does not necessarily mean the issue will be ever be done. Issues are pulled into Sprint based on their value and alignment to the current Roadmap.
 
 
 ## Story 📚
 
-A requirement or request which is written from the perspective of a end user. Most of our work can be added as a story. We use a [Story Template](https://github.com/ministryofjustice/nvvs-devops/issues/new/choose) which is applied to [our repositories](https://github.com/ministryofjustice/nvvs-devops#core-repositories) 
+A requirement or request which is written from the perspective of a end user. Most of our work can be added as a story. We use a [Story Template](https://github.com/ministryofjustice/nvvs-devops/issues/new/choose) which is applied to [our repositories](https://github.com/ministryofjustice/nvvs-devops#core-repositories)
 
-> **User Story:** 
+> **User Story:**
+>
+> As a… *[who is the user?]*
+> I need/want/expect to… *[what does the user want to do?]*
+> So that… *[why does the user want to do this?]*
 >
-> As a… *[who is the user?]*  
-> I need/want/expect to… *[what does the user want to do?]*  
-> So that… *[why does the user want to do this?]*  
-> 
 > **Value / Purpose:**
-> 
+>
 > *[Describe the value and purpose of the ticket]*
-> 
+>
 > **Useful Contacts:**
-> 
+>
 > *[Please add any useful contacts, these may include: Stakeholders, SME’s or 3rd Parties]*
-> 
+>
 > **Additional Information:**
-> 
+>
 > *[Please add any useful links or additional information that would be beneficial to anyone working on this ticket]*
-> 
+>
 > **Definition of Done (DoD):**
-> 
+>
 > *[Please clearly and concisely detail the DoD]*
-> 
+>
 > Checklist for definition of done and acceptance criteria, example below (optional).
-> 
-> **Example**  
-> 
-> ✅ Documentation has been written / updated  
-> ✅ README.md has been updated  
-> ✅ User docs have been updated  
-> ✅ Another team member has reviewed  
-> ✅ Tests are green  
+>
+> **Example**
+>
+> ✅ Documentation has been written / updated
+> ✅ README.md has been updated
+> ✅ User docs have been updated
+> ✅ Another team member has reviewed
+> ✅ Tests are green
 
 ## Bug 🐛
 

diff --git a/source/documentation/team-guide/developing-on-a-branch.html.md.erb b/source/documentation/team-guide/developing-on-a-branch.html.md.erb
@@ -1,16 +1,16 @@
 ---
 owner_slack: "#nvvs-devops"
 title: Developing on a branch
-last_reviewed_on: 2023-06-20
-review_in: 3 months
+last_reviewed_on: 2023-10-19
+review_in: 12 months
 ---
 
 # Developing on a branch
 
 
-Provided the repository is not already pulled locally: 
+Provided the repository is not already pulled locally:
 
-`git clone [email protected]:ministryofjustice/\<your-repo-name>.git` 
+`git clone [email protected]:ministryofjustice/\<your-repo-name>.git`
 
 `cd \<your-repo-name>`
 
@@ -20,7 +20,7 @@ Confirm you are on the main branch:
 
 Update the repository with any changes to the main branch (if the repository already exists locally):
 
-`git pull` 
+`git pull`
 
 Create and checkout a new branch:
 
@@ -37,4 +37,3 @@ Stage all altered files:
 Commit the newly stages files:
 
 `git commit -m ":gitmoji: <your meaningful commit message> `
-
diff --git a/source/documentation/team-guide/our-best-practices.html.md.erb b/source/documentation/team-guide/our-best-practices.html.md.erb
@@ -1,7 +1,7 @@
 ---
 owner_slack: "#nvvs-devops"
 title: Our Best Practices
-last_reviewed_on: 2023-06-20
+last_reviewed_on: 2023-10-19
 review_in: 3 months
 ---
 

diff --git a/source/documentation/team-guide/team-tools.html.md.erb b/source/documentation/team-guide/team-tools.html.md.erb
@@ -1,19 +1,26 @@
 ---
 owner_slack: "#nvvs-devops"
 title: Team Tools
-last_reviewed_on: 2023-06-20
+last_reviewed_on: 2023-10-19
 review_in: 3 months
 ---
 # Team Tools
 
 The intended readership of this page is new joiners to the team, the page illustrates tools which the team use frequently.
 
+### MacOS
+
+Engineers will be provided with MacBooks, this means Unix tools are native and ready to use (no need for things like WSL see bleow).
+Some additional software and commandline tools are subsequently required, they can be quickly installed following these instructions.
+
+Follow instructions on this repository linuxify(https://github.com/ministryofjustice/linuxify)
+
+
 ### Windows Subsystem for Linux (WSL) 🐧
 
-Download the WSL(https://www.microsoft.com/store/productId/9P9TQF7MRM4R) and Ubuntu subsytem from the windows app store 
+This is only relevent for laptops with Windows.
 
-To successfully start the Windows Subsystem for Linux (WSL) here and update the package (if you don't starting Ubuntu will fail)
-https://aka.ms/wsl2kernel as detailed [here](https://docs.microsoft.com/en-gb/windows/wsl/install-win10#step-4---download-the-linux-kernel-update-package)
+Follow the instructions on this repository provision-ubuntu2004-on-wsl2(https://github.com/ministryofjustice/provision-ubuntu2004-on-wsl2)
 
 #### Ubuntu
 - In Start search for 'Ubuntu' and start the Ubuntu system.
@@ -34,9 +41,9 @@ To access Settings open Windows Terminal and click the V arrow on the Taskbar:
 - (optional) Change your colour scheme. Save your eyes! 👀
 
 
-### VSCode 
+### VSCode
 
-The team uses [VSCode](https://code.visualstudio.com/) on a daily basis. 
+The team uses [VSCode](https://code.visualstudio.com/) on a daily basis.
 
 Some of our preferred extensions are listed below, to install these extensions on VSCode (_Ctrl + Shift + P; "Install Extensions"_):
 
@@ -54,9 +61,8 @@ Some of our preferred extensions are listed below, to install these extensions o
 
 - [Tabnine](https://marketplace.visualstudio.com/items?itemName=TabNine.tabnine-vscode) (👩‍💻🤖 JavaScript, Python, Java, Typescript & all other languages - AI Code completion plugin. Tabnine makes developers more productive by auto-completing their code.)
 
-- (optional) Change your colour scheme. Save your eyes! 👀 
-[Dracula](https://marketplace.visualstudio.com/items?itemName=dracula-theme.theme-dracula) 🧛 is a good one. 
+- (optional) Change your colour scheme. Save your eyes! 👀
+[Dracula](https://marketplace.visualstudio.com/items?itemName=dracula-theme.theme-dracula) 🧛 is a good one.
 
 If you've installed any Extensions prior to installing Remote WSL, re-install them on the WSL Ubuntu. To do this an 'Install' button should appear on these extensions when viewed on the Extensions (under WSL:
 Ubuntu) submenu on the left hand side of VS Code.
-
diff --git a/source/documentation/team-guide/useful-scripts.html.md.erb b/source/documentation/team-guide/useful-scripts.html.md.erb
@@ -1,7 +1,7 @@
 ---
 owner_slack: "#nvvs-devops"
 title: Useful Scripts
-last_reviewed_on: 2023-06-20
+last_reviewed_on: 2023-10-19
 review_in: 3 months
 ---