Merge pull request #9 from NHSDigital/docs-nav

Front matter to all docs.
NHSDigital · May 22, 2024 · d68c2c0 · d68c2c0
2 parents f786451 + 0630d7e
commit d68c2c0
Show file tree

Hide file tree

Showing 11 changed files with 96 additions and 30 deletions.
diff --git a/docs/dev-guides.md b/docs/dev-guides.md
@@ -0,0 +1,6 @@
+---
+layout: default
+title: Developer Guides
+nav_order: 3
+has_children: true
+---
diff --git a/docs/developer-guides/Bash_and_Make.md b/docs/developer-guides/Bash_and_Make.md
@@ -1,4 +1,10 @@
-# Developer Guide: Bash and Make
+---
+layout: default
+title:  Bash and Make
+parent: Developer Guides
+---
+
+## Developer Guide: Bash and Make
 
 - [Developer Guide: Bash and Make](#developer-guide-bash-and-make)
   - [Using Make](#using-make)

diff --git a/docs/developer-guides/Scripting_Docker.md b/docs/developer-guides/Scripting_Docker.md
@@ -1,4 +1,10 @@
-# Developer Guide: Scripting Docker
+---
+layout: default
+title:  Scripting Docker
+parent: Developer Guides
+---
+
+## Developer Guide: Scripting Docker
 
 - [Developer Guide: Scripting Docker](#developer-guide-scripting-docker)
   - [Overview](#overview)

diff --git a/docs/developer-guides/Scripting_Terraform.md b/docs/developer-guides/Scripting_Terraform.md
@@ -1,17 +1,23 @@
-# Developer Guide: Scripting Terraform
+---
+layout: default
+title:  Scripting Terraform
+parent: Developer Guides
+---
+
+## Developer Guide: Scripting Terraform
 
 - [Developer Guide: Scripting Terraform](#developer-guide-scripting-terraform)
-  - [Overview](#overview)
-  - [Features](#features)
-  - [Key files](#key-files)
-  - [Usage](#usage)
-    - [Quick start](#quick-start)
-    - [Your stack implementation](#your-stack-implementation)
-  - [Conventions](#conventions)
-    - [Secrets](#secrets)
-    - [Variables](#variables)
-    - [IaC directory](#iac-directory)
-  - [FAQ](#faq)
+- [Overview](#overview)
+- [Features](#features)
+- [Key files](#key-files)
+- [Usage](#usage)
+  - [Quick start](#quick-start)
+  - [Your stack implementation](#your-stack-implementation)
+- [Conventions](#conventions)
+  - [Secrets](#secrets)
+  - [Variables](#variables)
+  - [IaC directory](#iac-directory)
+- [FAQ](#faq)
 
 ## Overview
 

diff --git a/docs/user-guides.md b/docs/user-guides.md
@@ -0,0 +1,6 @@
+---
+layout: default
+title: User Guides
+nav_order: 4
+has_children: true
+---
diff --git a/docs/user-guides/Perform_static_analysis.md b/docs/user-guides/Perform_static_analysis.md
@@ -1,11 +1,17 @@
-# Guide: Perform static analysis
+---
+layout: default
+title:  Perform static analysis
+parent: User Guides
+---
+
+## Guide: Perform static analysis
 
 - [Guide: Perform static analysis](#guide-perform-static-analysis)
-  - [Overview](#overview)
-  - [Key files](#key-files)
-  - [Setup](#setup)
-  - [Testing](#testing)
-  - [Configuration checklist](#configuration-checklist)
+- [Overview](#overview)
+- [Key files](#key-files)
+- [Setup](#setup)
+- [Testing](#testing)
+- [Configuration checklist](#configuration-checklist)
 
 ## Overview
 

diff --git a/docs/user-guides/Run_Git_hooks_on_commit.md b/docs/user-guides/Run_Git_hooks_on_commit.md
@@ -1,4 +1,10 @@
-# Guide: Run Git hooks on commit
+---
+layout: default
+title:  un Git hooks on commit
+parent: User Guides
+---
+
+## Guide: Run Git hooks on commit
 
 - [Guide: Run Git hooks on commit](#guide-run-git-hooks-on-commit)
   - [Overview](#overview)

diff --git a/docs/user-guides/Scan_dependencies.md b/docs/user-guides/Scan_dependencies.md
@@ -1,4 +1,10 @@
-# Guide: Scan dependencies
+---
+layout: default
+title:  Scan dependencies
+parent: User Guides
+---
+
+## Guide: Scan dependencies
 
 - [Guide: Scan dependencies](#guide-scan-dependencies)
   - [Overview](#overview)

diff --git a/docs/user-guides/Scan_secrets.md b/docs/user-guides/Scan_secrets.md
@@ -1,4 +1,10 @@
-# Guide: Scan secrets
+---
+layout: default
+title:  Scan secrets
+parent: User Guides
+---
+
+## Guide: Scan secrets
 
 - [Guide: Scan secrets](#guide-scan-secrets)
   - [Overview](#overview)

diff --git a/docs/user-guides/Sign_Git_commits.md b/docs/user-guides/Sign_Git_commits.md
@@ -1,4 +1,10 @@
-# Guide: Sign Git commits
+---
+layout: default
+title:  Sign Git commits
+parent: User Guides
+---
+
+## Guide: Sign Git commits
 
 - [Guide: Sign Git commits](#guide-sign-git-commits)
   - [Overview](#overview)

diff --git a/docs/user-guides/Test_GitHub_Actions_locally.md b/docs/user-guides/Test_GitHub_Actions_locally.md
@@ -1,11 +1,17 @@
-# Guide: Test GitHub Actions locally
+---
+layout: default
+title:  Test GitHub Actions locally
+parent: User Guides
+---
+
+## Guide: Test GitHub Actions locally
 
 - [Guide: Test GitHub Actions locally](#guide-test-github-actions-locally)
-  - [Overview](#overview)
-  - [Key files](#key-files)
-  - [Prerequisites](#prerequisites)
-  - [Testing](#testing)
-  - [FAQ](#faq)
+- [Overview](#overview)
+- [Key files](#key-files)
+- [Prerequisites](#prerequisites)
+- [Testing](#testing)
+- [FAQ](#faq)
 
 ## Overview