XZ Redesign layout (#111)

* Changed front page to new look - * Changed other pages to remove side bar where required * added Scarlett-k-nhs to acknowledgements --------- Co-authored-by: Sam Hollings <52575338+SamHollings@users.noreply.github.com>
NHSDigital · May 11, 2023 · 9d6e399 · 9d6e399
1 parent ed1f275
commit 9d6e399
Show file tree

Hide file tree

Showing 14 changed files with 467 additions and 81 deletions.
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/about.md b/docs/about.md
@@ -1,5 +1,26 @@
+---
+hide:
+  - navigation
+---
+
 # RAP Community of Practice
 
+> **This material is maintained by the [NHS Digital Data Science team](mailto:datascience@nhs.net)**.
+
+> You can see some examples of our work [here](https://github.com/NHSDigital/data-analytics-services), including [underlying code to NHS Digital publications](https://github.com/NHSDigital/data-analytics-services#rap-publication-repositories) which have been published as a direct outcome of the service our team provides.
+
+These resources are intended for those interested in adopting [Reproducible Analytical Pipelines (RAP)](https://analysisfunction.civilservice.gov.uk/support/reproducible-analytical-pipelines/).
+
+RAP is becoming the standard for creating analytical outputs in government; combining a number of ways of working that help to improve the reliability, transparency, and speed of statistics publications. Learn more on our [Why RAP is important][17] page.
+
+## RAP in the NHS
+
+The [Goldacre Review](https://www.gov.uk/government/publications/better-broader-safer-using-health-data-for-research-and-analysis), tasked with finding ways to deliver better, broader, and safer use of NHS data for analysis and research, identified RAP as the essential element to ensure high-quality analysis.
+
+The Data Science team at NHS Digital have been championing RAP practices and providing support for analytical teams across our organisation. We have published these resources in the spirit of openness and transparency, and in the hope that other teams in other organisations may find them useful. You can find out more about our incredible contributors on our [Acknowledgements](acknowledgements.md) page.
+
+Learn more about our [RAP service][19].
+
 ## Aims
 
 This community of practice aims to support teams in adopting RAP practices through:
@@ -45,7 +66,10 @@ This collection of resources is [© Crown copyright](http://www.nationalarchives
 [8]: ./training_resources/git/intro-to-git.md
 [11]: ./introduction_to_RAP/why_RAP_is_important.md#aims-of-rap
 [12]: ./introduction_to_RAP/levels_of_RAP.md
-[13]: ./our_RAP_service/README.md#support
+[13]: ./our_RAP_service#support
 [14]: ./implementing_RAP/code-review.md
 [15]: ./implementing_RAP/tools.md
 [16]: ./training_resources/pyspark/README.md
+[17]: ./introduction_to_RAP/why_RAP_is_important.md
+[18]: ./implementing_RAP/how-to-publish-your-code-in-the-open.md
+[19]: ./our_RAP_service
diff --git a/docs/acknowledgements.md b/docs/acknowledgements.md
@@ -1,14 +1,21 @@
+---
+hide:
+  - navigation
+  - toc
+---
+
 # Acknowledgements
+
 It's taken a lot of work to make the NHS Digital RAP Community of Practice and further the cause of RAP within NHS Digital more generally.
 
 Many people have pitched in, doing what they could, often **going the extra mile** and ultimately with the **goal of helping our fellow analysts**.
 The **NHS Digital Data Science Skilled Team** has been the core of this work, but in particular the **Data Science RAP Squad** lead the charge, piece by piece moving mountains and making a lasting difference.
 
-**Many thanks and congratulations** to the following for their incredible hard work. 
+**Many thanks and congratulations** to the following for their incredible hard work.
 
-| [Helen Richardson](https://github.com/helrich)|[Jonny Laidler](https://github.com/JonathanLaidler) |[Harriet Sands](https://github.com/harrietrs)  |  [Maakhe Ndhlela](https://github.com/maakhe)|
-|:----------------------------------|:-----|:----|:---|
-| __[Connor Quinn](https://github.com/connor1q)__|__[Alistair Jones](https://github.com/alistair-jones)__ |__[Daniel Goldwater](https://github.com/DanGoldwater1)__ | __[Joseph Wilson](https://github.com/josephwilson8-nhs)__|
-| __[Philip Hoang Le](https://github.com/philip-le)__ |__[Sam Hollings](https://github.com/SamHollings)__ |__[Abbie Prescott](https://github.com/abbieprescott)__ |__[Xiyao Zhuang](https://github.com/xiyaozhuang)__ |
+| [Helen Richardson](https://github.com/helrich)      | [Jonny Laidler](https://github.com/JonathanLaidler)     | [Harriet Sands](https://github.com/harrietrs)            | [Maakhe Ndhlela](https://github.com/maakhe)               |  [Scarlett Kynoch](https://github.com/scarlett-k-nhs)|
+| :-------------------------------------------------- | :------------------------------------------------------ | :------------------------------------------------------- | :-------------------------------------------------------- | :-------------------------------------------------------- |
+| **[Connor Quinn](https://github.com/connor1q)**     | **[Alistair Jones](https://github.com/alistair-jones)** | **[Daniel Goldwater](https://github.com/DanGoldwater1)** | **[Joseph Wilson](https://github.com/josephwilson8-nhs)** |    |
+| **[Philip Hoang Le](https://github.com/philip-le)** | **[Sam Hollings](https://github.com/SamHollings)**      | **[Abbie Prescott](https://github.com/abbieprescott)**   | **[Xiyao Zhuang](https://github.com/xiyaozhuang)**        |    |
 
 **You guys really put the "champion" in RAP Champion!!!**
diff --git a/docs/glossary.md b/docs/glossary.md
@@ -1,3 +1,8 @@
+---
+hide:
+  - navigation
+---
+
 ## RAP
 
 RAP stands for Reproducible Analytical Pipelines. The term comes from UK public sector data scientists - you can [read the ONS description here](https://datasciencecampus.ons.gov.uk/capability/data-science-campus-faculty/reproducible-analytical-pipeline-journey/#:~:text=Reproducible%20Analytical%20Pipelines%20are%20programs,impressive%20efficiencies%20in%20your%20teams.). We also have a page on [why RAP is important](introduction_to_RAP/why_RAP_is_important.md)

diff --git a/docs/images/logo/nhs-blue-on-white.jpg b/docs/images/logo/nhs-blue-on-white.jpg
diff --git a/docs/images/logo/nhs-white-on-blue.jpg b/docs/images/logo/nhs-white-on-blue.jpg
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,8 @@
+---
+hide:
+  - navigation
+  - toc
+  - footer
+
+template: home.html
+---
diff --git a/docs/our_RAP_service/README.md → docs/our_RAP_service/index.md b/docs/our_RAP_service/README.md → docs/our_RAP_service/index.md
@@ -1,7 +1,7 @@
 # Our RAP Service
 
 Following the recommendations in the [Overcoming Barriers to RAP](https://osr.statisticsauthority.gov.uk/publication/reproducible-analytical-pipelines-overcoming-barriers-to-adoption/)
- report, we have set up a central RAP team to coordinate efforts and set standards across NHS Digital.
+report, we have set up a central RAP team to coordinate efforts and set standards across NHS Digital.
 
 This team tends to be made up of about 5 data scientists and we flex the resource up and down according to demand.
 

diff --git a/docs/our_RAP_service/typical-engagement-flow.md b/docs/our_RAP_service/typical-engagement-flow.md
@@ -36,12 +36,12 @@ Nevertheless, the text below lays out the type of activities that occur in acros
 - Identify training needs of the publication team through conversations
 - Dedicated training. The content is tailored to the specific team but a typical sequence might look like:
 
-    - [Concept of a thin slice and how to choose the thin slice][5]
-    - Access to off-the-shelf interactive training for self-led training
-    - [PySpark style guide][6]
-    - [Version control][7]
-    - [Writing good functions][8]
-    - [Unit tests][9]
+  - [Concept of a thin slice and how to choose the thin slice][5]
+  - Access to off-the-shelf interactive training for self-led training
+  - [PySpark style guide][6]
+  - [Version control][7]
+  - [Writing good functions][8]
+  - [Unit tests][9]
 
 - Buddy pairs work to replicate the thin slide outputs
 - Set up automated code testing once the numbers are correct
@@ -66,7 +66,7 @@ Nevertheless, the text below lays out the type of activities that occur in acros
 
 [1]: ./support-models.md
 [2]: ../implementing_RAP/rap-readiness.md
-[3]: ../README.md
+[3]: ../index.md
 [4]: ../introduction_to_RAP/levels_of_RAP.md
 [5]: ./thin-slice-strategy.md
 [6]: ../training_resources/pyspark/pyspark-style-guide.md

diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -29,7 +29,7 @@
 }
 
 .md-logo-nhs {
-  height: 80px;
+  height: auto;
 }
 
 .md-header__button.md-logo-nhs :is(img, svg) {

diff --git a/docs/support.md b/docs/support.md
@@ -1,3 +1,8 @@
+---
+hide:
+  - navigation
+---
+
 # Support
 
 If your team is embarking upon a RAP journey, you should understand [why RAP are important][1] and think about which [levels of RAP][2] that you want to aim for.

diff --git a/docs/useful_links.md b/docs/useful_links.md
@@ -1,3 +1,8 @@
+---
+hide:
+  - navigation
+---
+
 # Useful links
 
 ## Strategic
@@ -13,7 +18,7 @@
 - The [ONS best practice team have a useful website - often called the Quack book] covering many of the same topics we cover here. Their [best-practice checklist] is particularly useful.
 - The Turing Institute's [The Turing Way handbook to reproducible, ethical and collaborative data science]
 - We have taken inspiration from the [NHS Digital software engineering COP].
-- [**NHS PyCom Coding Club Github**][Coding Club]: Lots of great guides and lessons here from the NHS Python Community
+- [**NHS PyCom Coding Club Github**][coding club]: Lots of great guides and lessons here from the NHS Python Community
 
 ## Examples, Challenges, Benefits
 
@@ -28,45 +33,45 @@
 
 - There are several communities to discuss Python, R and Git in the Health and
   Public sectors:
-  - **Government Data Science community** ([website][GDS community website] |
-      [slack][GDS community slack] #rap_collaboration | [GitHub][GDS community GitHub])
-    - **Government Analysis Function RAP Champion network** ([website][Analysis Function website])
-  - **NHS Python Community (NHS-pycom)** ([website][NHS-pycom website] | [slack][NHS-pycom slack] | [GitHub][NHS-pycom GitHub] | [Coding Club])
-  - **NHS R Community** ([website][NHS-R website] | [slack][NHS-R slack] |[GitHub][NHS-R GitHub])
-  - **AnalystX** ([website][AnalystX website] | [Future NHS - AnalystX] | [GitHub][AnalystX GitHub])
+  - **Government Data Science community** ([website][gds community website] |
+    [slack][gds community slack] #rap_collaboration | [GitHub][gds community github])
+    - **Government Analysis Function RAP Champion network** ([website][analysis function website])
+  - **NHS Python Community (NHS-pycom)** ([website][nhs-pycom website] | [slack][nhs-pycom slack] | [GitHub][nhs-pycom github] | [Coding Club])
+  - **NHS R Community** ([website][nhs-r website] | [slack][nhs-r slack] |[GitHub][nhs-r github])
+  - **AnalystX** ([website][analystx website] | [Future NHS - AnalystX] | [GitHub][analystx github])
 - We have an **NHS Digital RAP Teams group** (internal to NHS Digital - contact us @ [data.science@nhs.net])
   - [NHS Digital Github]
   - Our very own [NHS Digital RAP Community of Practice]
 
-[RAP strategy]: https://analysisfunction.civilservice.gov.uk/policy-store/reproducible-analytical-pipelines-strategy/
-[RAP Strategy Implementation Plan 2023]: https://www.ons.gov.uk/aboutus/whatwedo/programmesandprojects/analysisfunctionrapstrategy2023implementationplan
-[Goldacre Review]: https://www.gov.uk/government/publications/better-broader-safer-using-health-data-for-research-and-analysis
+[rap strategy]: https://analysisfunction.civilservice.gov.uk/policy-store/reproducible-analytical-pipelines-strategy/
+[rap strategy implementation plan 2023]: https://www.ons.gov.uk/aboutus/whatwedo/programmesandprojects/analysisfunctionrapstrategy2023implementationplan
+[goldacre review]: https://www.gov.uk/government/publications/better-broader-safer-using-health-data-for-research-and-analysis
 [helpful summary]: https://www.bennett.ox.ac.uk/blog/2022/07/bennett-insights-an-overview-of-uk-data-policy-developments/
-[AQUA book of analytical standards]: https://www.gov.uk/government/publications/the-aqua-book-guidance-on-producing-quality-analysis-for-government
-[ONS best practice team have a useful website - often called the Quack book]: https://best-practice-and-impact.github.io/qa-of-code-guidance/intro.html
+[aqua book of analytical standards]: https://www.gov.uk/government/publications/the-aqua-book-guidance-on-producing-quality-analysis-for-government
+[ons best practice team have a useful website - often called the quack book]: https://best-practice-and-impact.github.io/qa-of-code-guidance/intro.html
 [best-practice checklist]: https://best-practice-and-impact.github.io/qa-of-code-guidance/checklist_higher.html
-[The Turing Way handbook to reproducible, ethical and collaborative data science]: https://the-turing-way.netlify.app/welcome.html
-[NHS Digital software engineering COP]: https://github.com/NHSDigital/software-engineering-quality-framework/blob/master/insights/review.md
-[Coding Club]: https://github.com/nhs-pycom/coding-club
-[This blog post]: https://dataingovernment.blog.gov.uk/2017/03/27/reproducible-analytical-pipeline/
-[benefits that come from RAP]: https://gss.civilservice.gov.uk/reproducible-analytical-pipelines/benefits-to-government-from-reproducible-analytical-pipelines/
-[report on overcoming barriers to RAP adoption]: https://osr.statisticsauthority.gov.uk/publication/reproducible-analytical-pipelines-overcoming-barriers-to-adoption/
-[A Beginner's Guide to Conducting Reproducible Research]: https://doi.org/10.1002/bes2.1801
-[Introduction to RAP course]: https://gss.civilservice.gov.uk/training/introduction-to-reproducible-analytical-pipelines-rap/
-[research on the rollout of RAP across different departments]: https://best-practice-and-impact.github.io/CARS-3/index.html
-[GDS community website]: https://www.gov.uk/service-manual/communities/data-science-community
-[GDS community slack]: https://govdatascience.slack.com/
-[GDS community GitHub]: https://github.com/ukgovdatascience
-[Analysis Function website]: https://analysisfunction.civilservice.gov.uk/support/reproducible-analytical-pipelines/reproducible-analytical-pipeline-rap-champions/
-[NHS-pycom website]: https://nhs-pycom.net/
-[NHS-pycom slack]: https://nhs-pycom.slack.com
-[NHS-pycom GitHub]: https://github.com/nhs-pycom
-[NHS-R website]: https://nhsrcommunity.com/
-[NHS-R slack]: https://nhsrcommunity.slack.com
-[NHS-R GitHub]: https://github.com/nhs-r-community
-[AnalystX website]: https://analystx.uk/
-[Future NHS - AnalystX]: https://future.nhs.uk/connect.ti/DataAnalytics/grouphome
-[AnalystX GitHub]: https://github.com/nhs-analystx
+[the turing way handbook to reproducible, ethical and collaborative data science]: https://the-turing-way.netlify.app/welcome.html
+[nhs digital software engineering cop]: https://github.com/NHSDigital/software-engineering-quality-framework/blob/master/insights/review.md
+[coding club]: https://github.com/nhs-pycom/coding-club
+[this blog post]: https://dataingovernment.blog.gov.uk/2017/03/27/reproducible-analytical-pipeline/
+[benefits that come from rap]: https://gss.civilservice.gov.uk/reproducible-analytical-pipelines/benefits-to-government-from-reproducible-analytical-pipelines/
+[report on overcoming barriers to rap adoption]: https://osr.statisticsauthority.gov.uk/publication/reproducible-analytical-pipelines-overcoming-barriers-to-adoption/
+[a beginner's guide to conducting reproducible research]: https://doi.org/10.1002/bes2.1801
+[introduction to rap course]: https://gss.civilservice.gov.uk/training/introduction-to-reproducible-analytical-pipelines-rap/
+[research on the rollout of rap across different departments]: https://best-practice-and-impact.github.io/CARS-3/index.html
+[gds community website]: https://www.gov.uk/service-manual/communities/data-science-community
+[gds community slack]: https://govdatascience.slack.com/
+[gds community github]: https://github.com/ukgovdatascience
+[analysis function website]: https://analysisfunction.civilservice.gov.uk/support/reproducible-analytical-pipelines/reproducible-analytical-pipeline-rap-champions/
+[nhs-pycom website]: https://nhs-pycom.net/
+[nhs-pycom slack]: https://nhs-pycom.slack.com
+[nhs-pycom github]: https://github.com/nhs-pycom
+[nhs-r website]: https://nhsrcommunity.com/
+[nhs-r slack]: https://nhsrcommunity.slack.com
+[nhs-r github]: https://github.com/nhs-r-community
+[analystx website]: https://analystx.uk/
+[future nhs - analystx]: https://future.nhs.uk/connect.ti/DataAnalytics/grouphome
+[analystx github]: https://github.com/nhs-analystx
 [data.science@nhs.net]: mailto:data.science@nhs.net
-[NHS Digital Github]: https://github.com/NHSDigital
-[NHS Digital RAP Community of Practice]: https://github.com/NHSDigital/rap-community-of-practice
+[nhs digital github]: https://github.com/NHSDigital
+[nhs digital rap community of practice]: https://github.com/NHSDigital/rap-community-of-practice
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,16 +11,14 @@ plugins:
       include_source: True
       theme: dark
 nav:
-  - Home: README.md
+  - Home: index.md
   - About: about.md
-  - Support: support.md
-  - Acknowledgements: acknowledgements.md
   - Introduction to RAP:
       - Why RAP is important: introduction_to_RAP/why_RAP_is_important.md
       - Levels of RAP: introduction_to_RAP/levels_of_RAP.md
       - What is open source?: introduction_to_RAP/what-is-open-source.md
   - Our RAP service:
-      - The RAP team: our_RAP_service/README.md
+      - our_RAP_service/index.md
       - Building team capability: our_RAP_service/building_team_capability.md
       - Support models: our_RAP_service/support-models.md
       - Thin slice strategy: our_RAP_service/thin-slice-strategy.md
@@ -72,8 +70,10 @@ nav:
       - R:
           - External resources: training_resources/R/README.md
           - Git with RStudio: training_resources/R/git_with_RStudio.md
+  - Support: support.md
   - Glossary: glossary.md
   - Useful links: useful_links.md
+  - Acknowledgements: acknowledgements.md
 theme:
   name: material
   custom_dir: overrides
@@ -82,12 +82,14 @@ theme:
     primary: indigo
   font:
     text: Arial
-  logo: images/NHS-Digital-logo_LEFT-WHITE-235x183.png
-  favicon: images/NHS Digital logo_WEB_LEFT.svg
+  logo: images/logo/nhs-blue-on-white.jpg
+  favicon: images/favicon/favicon.ico
   features:
     - search.share
     - content.code.annotate
     - content.tabs.link
+    - navigation.tabs
+    - navigation.indexes
   icon:
     admonition:
       <type>: material/alert
@@ -112,7 +114,7 @@ markdown_extensions:
           class: mermaid
           format: !!python/name:pymdownx.superfences.fence_code_format
   - pymdownx.tabbed:
-      alternate_style: true 
+      alternate_style: true
   - pymdownx.arithmatex:
       generic: true
   - admonition
@@ -133,3 +135,5 @@ extra_javascript:
   - javascripts/mathjax.js
   - https://polyfill.io/v3/polyfill.min.js?features=es6
   - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+watch:
+  - overrides