Update docs

README.md

@@ -26,30 +26,6 @@ Please ensure you have read our [principles](/docs/principles/README.md) first,
 
 The guide is best viewed in GitHub pages at [https://defra.github.io/software-development-standards](https://defra.github.io/software-development-standards/)
 
-## Updating the guide
-
-This documentation is written in markdown and is built using [MkDocs](https://www.mkdocs.org) and the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.
-
-Please follow the below installation instructions prior to working with this repository:
-
-- [mkdocs.org](https://www.mkdocs.org)
-- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
-
-## Commands
-
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-* `mkdocs gh-deploy` - Deploy the documentation to GitHub pages.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
-
 ## License
 
 THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:

docs/CONTRIBUTING.md

@@ -56,3 +56,16 @@ When your contribution has been approved, you can go ahead and merge it using th
 > **IMPORTANT** If you have multiple commits on your branch it will squash them, and ask you to confirm what the final single commit message should be. Rewrite the message so it reflects the final change you've made (feedback may have changed your original intent) and why.
 
 With that done sit back, have a 🍹, and ponder your next contribution!
+
+## GitHub pages
+
+This documentation is published to [GitHub pages](https://pages.github.com/) using [MkDocs](https://www.mkdocs.org) and the [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) theme.
+
+To view changes locally you will need the following pre-requisites:
+
+- [mkdocs.org](https://www.mkdocs.org)
+- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
+
+Once installed you can run `mkdocs serve` to start a live-reloading server to view your changes.
+
+Once your changes are merged, the CI pipeline will automatically deploy the changes to GitHub pages.

docs/README.md

@@ -8,7 +8,7 @@ These form part of the software development standards policy for Defra and apply
 
 All developers working on behalf of Defra need to be aware of their obligation to follow these standards.
 
-Any deviation must be managed as an exception under Defra's architectural goverance processes.
+Any deviation must be managed as an exception under Defra's architectural governance processes.
 
 We maintain these standards on GitHub to ensure they have the greatest visibility to all developers and are readily available in a familiar environment. To aid readability, you can refer to the [GitHub documentation on managing accessibility settings](https:/..github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings).
 

site/CONTRIBUTING/index.html

@@ -331,6 +331,15 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#github-pages" class="md-nav__link">
+    <span class="md-ellipsis">
+      GitHub pages
+    </span>
+  </a>
+
 </li>
 
     </ul>
@@ -1460,6 +1469,15 @@
     </span>
   </a>
 
+</li>
+
+        <li class="md-nav__item">
+  <a href="#github-pages" class="md-nav__link">
+    <span class="md-ellipsis">
+      GitHub pages
+    </span>
+  </a>
+
 </li>
 
     </ul>
@@ -1517,6 +1535,15 @@ <h2 id="finishing-up">Finishing up</h2>
 <p><strong>IMPORTANT</strong> If you have multiple commits on your branch it will squash them, and ask you to confirm what the final single commit message should be. Rewrite the message so it reflects the final change you've made (feedback may have changed your original intent) and why.</p>
 </blockquote>
 <p>With that done sit back, have a 🍹, and ponder your next contribution!</p>
+<h2 id="github-pages">GitHub pages</h2>
+<p>This documentation is published to <a href="https://pages.github.com/">GitHub pages</a> using <a href="https://www.mkdocs.org">MkDocs</a> and the <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a> theme.</p>
+<p>To view changes locally you will need the following pre-requisites:</p>
+<ul>
+<li><a href="https://www.mkdocs.org">mkdocs.org</a></li>
+<li><a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a></li>
+</ul>
+<p>Once installed you can run <code>mkdocs serve</code> to start a live-reloading server to view your changes.</p>
+<p>Once your changes are merged, the CI pipeline will automatically deploy the changes to GitHub pages.</p>
 
 
 

site/index.html

@@ -1735,7 +1735,7 @@ <h2 id="about">About</h2>
 <p>This is the home for standards and guidance relating to software development in <a href="https://www.gov.uk/government/organisations/department-for-environment-food-rural-affairs">Defra</a>.</p>
 <p>These form part of the software development standards policy for Defra and apply to all software development undertaken on behalf of the Defra group whether by staff, contingent workers or suppliers.</p>
 <p>All developers working on behalf of Defra need to be aware of their obligation to follow these standards.</p>
-<p>Any deviation must be managed as an exception under Defra's architectural goverance processes.</p>
+<p>Any deviation must be managed as an exception under Defra's architectural governance processes.</p>
 <p>We maintain these standards on GitHub to ensure they have the greatest visibility to all developers and are readily available in a familiar environment. To aid readability, you can refer to the <a href="https:/..github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings">GitHub documentation on managing accessibility settings</a>.</p>
 <h2 id="principles">Principles</h2>
 <p>The standards and guidance provided here a based on an agreed set of principles.</p>