Merge pull request #118 from dfe-analytical-services/85-check-that-pa…

…ges-arent-using-h1-headers-at-the-top-level Resolving issue with H1 headers which should not be used.
dfe-analytical-services · Nov 28, 2024 · 80b8d3c · 80b8d3c
2 parents 6592426 + 24db093
commit 80b8d3c
Show file tree

Hide file tree

Showing 11 changed files with 187 additions and 190 deletions.
diff --git a/RAP/rap-expectations.qmd b/RAP/rap-expectations.qmd
@@ -6,9 +6,7 @@ title: "RAP expectations"
 
 ---
 
-# RAP Expectations
-
----
+## RAP Expectations
 
 As government analysts working with statistics, we are required to ensure that our analysis is reproducible, transparent, and robust, using coding and code management best practices (source [GSG competency framework](https://analysisfunction.civilservice.gov.uk/policy-store/competency-framework-for-the-government-statistician-group-gsg/)). Reproducible Analytical Pipelines (RAP) are a cross-government requirement to help analysts adopt best practices.
 
@@ -20,8 +18,9 @@ Although RAP is often discussed in the context of statistics production, RAP pri
 
 ---
 
-## Analyst leaders 
+### Analyst leaders 
 
+---
 
 Those giving senior sign off on publications and running analytical functions, usually G6 and SCS, analyst leaders will:
 
@@ -36,8 +35,9 @@ Those giving senior sign off on publications and running analytical functions, u
 
 ---
 
-## Analyst managers 
+### Analyst managers 
 
+---
 
 Roughly equivalent to Team Leaders and G7, analyst managers will:
 
@@ -51,8 +51,9 @@ Roughly equivalent to Team Leaders and G7, analyst managers will:
 
 ---
 
-## Analysts 
+### Analysts 
 
+---
 
 Analysts working on analysis in government will:
 

diff --git a/RAP/rap-faq.qmd b/RAP/rap-faq.qmd
@@ -6,21 +6,21 @@ title: "RAP FAQs"
 
 ---
 
-# Frequently asked questions
-
----
+## Frequently asked questions
 
 If you have any questions you'd like answering or adding, let us know by emailing [statistics.development\@education.gov.uk](mailto:[email protected]).
 
 ---
 
-## What is RAP
+### What is RAP
+
+---
 
 General questions about Reproducible Analytical Pipelines and why analysts need to care about it.
 
 ---
 
-### What is RAP, is it just using R?
+#### What is RAP, is it just using R?
 
 ---
 
@@ -36,7 +36,7 @@ More details and learning resources for the recommended tools can be found in ou
 
 ---
 
-### Is this specific to DfE?
+#### Is this specific to DfE?
 
 ---
 
@@ -50,7 +50,7 @@ RAP is also a strategic objective of [Analysis Function strategy for 22-25](http
 
 ---
 
-### I'm overwhelmed by all the steps, is RAP really necessary?
+#### I'm overwhelmed by all the steps, is RAP really necessary?
 
 ---
 
@@ -60,7 +60,7 @@ Statistics publications are some of the most important pieces of statistics work
 
 ---
 
-### Will implementing RAP lead to a disconnect with the data and 'black box' processes?
+#### Will implementing RAP lead to a disconnect with the data and 'black box' processes?
 
 ---
 
@@ -70,7 +70,7 @@ We recognise there is a sizeable skill gap, and that until this is addressed the
 
 ---
 
-### Teams vary, and what my team does is different to others, if I'm happy with my approach, can I ignore some of the RAP steps?
+#### Teams vary, and what my team does is different to others, if I'm happy with my approach, can I ignore some of the RAP steps?
 
 ---
 
@@ -80,13 +80,15 @@ If you have unique or nuanced processes, RAP helps you document these and make y
 
 ---
 
-## Getting started
+### Getting started
+
+---
 
 Questions about how to get started with RAP.
 
 ---
 
-### Can I leave the R stuff to others in my team whilst I focus elsewhere?
+#### Can I leave the R stuff to others in my team whilst I focus elsewhere?
 
 ---
 
@@ -96,7 +98,7 @@ We all must ensure that analysis is reproducible, transparent, and robust using
 
 ---
 
-### Implementing RAP takes time to setup initially, how can we prioritise it?
+#### Implementing RAP takes time to setup initially, how can we prioritise it?
 
 ---
 
@@ -108,13 +110,13 @@ In the long term, implementing RAP will significantly reduce the time it takes t
 
 ---
 
-## Tools for RAP
+### Tools for RAP
 
 Questions about what tools and software to use when applying RAP principles.
 
 ---
 
-### Do I need to rewrite existing SQL code into R?
+#### Do I need to rewrite existing SQL code into R?
 
 ---
 
@@ -126,23 +128,23 @@ What we recommend, is that all of your code is within a single R project, and th
 
 ---
 
-### I'm sometimes limited by the access and tools I have (ESFA servers, EDAP, Databricks), is there anything that can be done about this?
+#### I'm sometimes limited by the access and tools I have (ESFA servers, EDAP, Databricks), is there anything that can be done about this?
 
 ---
 
 The first step is to let us (the Statistics Development Team) know so we can understand the wider landscape and escalate. There isn't really a quick fix, but the first step is raising awareness.
 
 ---
 
-### What happens if we can't reproduce our current processes using R?
+#### What happens if we can't reproduce our current processes using R?
 
 ---
 
 This is highly unlikely and is more likely to be from a lack of knowledge of what is possible in R -- if you're struggling to reproduce processes, please contact the Statistics Development Team so they're aware of your processes and can help you implement RAP principles.
 
 ---
 
-### R isn't always the quickest tool for processing data, can we use SQL instead?
+#### R isn't always the quickest tool for processing data, can we use SQL instead?
 
 ---
 
@@ -152,13 +154,15 @@ SQL scripts should be run in an automated way using R, instead of manually runni
 
 ---
 
-## Implementing RAP
+### Implementing RAP
+
+---
 
 Questions on how to implement RAP.
 
 ---
 
-### Having a single script for code doesn't seem the best way to do it, why are you suggesting this?
+#### Having a single script for code doesn't seem the best way to do it, why are you suggesting this?
 
 ---
 
@@ -173,15 +177,15 @@ This means that you should have one 'centralized' script that details all of the
 
 ---
 
-### How do I dual run for QA if our process is in code?
+#### How do I dual run for QA if our process is in code?
 
 ---
 
 You don't need to be dual running if your process is automated, it's not the best way to QA. See our guidance on QA for more details on how you can approach it or talk to us if you're unsure.
 
 ---
 
-### Should I have separate repositories or branches in Git for each release?
+#### Should I have separate repositories or branches in Git for each release?
 
 ---
 
@@ -191,7 +195,7 @@ In short, a single repository should be used for all releases of your publicatio
 
 ---
 
-### We should have plain text documentation to accompany the process, code and comments don't feel like enough?
+#### We should have plain text documentation to accompany the process, code and comments don't feel like enough?
 
 ---
 
@@ -201,13 +205,13 @@ The README in your repository is the place for traditional 'desk notes' and text
 
 ---
 
-## Learning about RAP
+### Learning about RAP
 
 Questions learning more about RAP and developing skills.
 
 ---
 
-### Can I look at what other people are doing?
+#### Can I look at what other people are doing?
 
 ---
 
@@ -219,7 +223,7 @@ We'd also encourage analysts to make more use of the RAP Community channel in th
 
 ---
 
-### I don't have the skills to implement RAP, how do I get them?
+#### I don't have the skills to implement RAP, how do I get them?
 
 ---
 

diff --git a/RAP/rap-support.qmd b/RAP/rap-support.qmd
@@ -6,22 +6,24 @@ title: "RAP support"
 
 ---
 
-# Support on offer
-
----
+## Support on offer
 
 Learning resources and materials for [SQL](../learning-development/sql.html), [R](../learning-development/r.html), and [Git](../learning-development/git.html)
 
 ---
 
-## Email support
+### Email support
+
+---
 
  * [[email protected]](mailto:[email protected])  
  * 9-5, aim to reply between 1-2 days.
 
 ---
 
-## Technical workshops
+### Technical workshops
+
+---
 
  *	In person workshops covering specific technical skills in practice
  *	3 hours long, with people working in small groups
@@ -38,9 +40,7 @@ Keep an eye out on Teams for this programme being advertised and contact [statis
 
 ---
 
-# Partnership programme
-
----
+## Partnership programme
 
 The Statistics Development Team invites teams to take part in our partnership programme. The programme can help individuals with:
 

diff --git a/statistics-production/.gitignore b/statistics-production/.gitignore
@@ -0,0 +1 @@
+ud.qmd
diff --git a/statistics-production/pub.qmd b/statistics-production/pub.qmd
@@ -9,9 +9,7 @@ title: "Routes for publishing"
 
 ---
 
-# Routes for publishing
-
----
+## Routes for publishing
 
 [Explore education statistics](https://explore-education-statistics.service.gov.uk/){target="_blank" rel="noopener noreferrer"} (EES) is the Department's statistics dissemination platform, designed to make DfE’s published statistics and data easier to find, access, use and understand. 
 
@@ -39,16 +37,15 @@ If you are unsure which route to use for publication please contact the [HoP Off
 
 ---
 
-# EES
-
----
+## EES
 
 All national, official and ad-hoc statistics should be published on EES. This section covers how to start publishing on EES and all the things you need to consider before publication. For more detailed guidance on how to use the platform, visit our [EES guidance page](ees.html)
 
 ---
 
-## How to publish
+### How to publish
 
+---
 
 <html>
 <head>
@@ -63,8 +60,9 @@ All national, official and ad-hoc statistics should be published on EES. This se
 
 ---
 
-## Publication checklist
+### Publication checklist
 
+---
 
 Before releasing statistics for the first time you may want to discuss the new process with key stakeholders and / or pre-release users to make them aware of the new service. You should also inform the [explore education statistics platforms team](mailto:[email protected]) and [Statistics HoP Office](mailto:[email protected]).
 
@@ -97,8 +95,9 @@ Word templates for the data guidance, pra-list, and content can be found on [sha
 
 ---
 
-## Linking to GOV.UK
+### Linking to GOV.UK
 
+---
 
 You will need to arrange a GOV.UK statistics publication page so that it links to EES. Here is how to do that:
 
@@ -134,16 +133,16 @@ You can find what the link to your EES release will be by looking at the 'Sign o
 
 ---
 
-# GOV.UK
+## GOV.UK
 
----
 
 Management information releases can be published directly on gov.uk.
 
 ---
 
-## How to publish
+### How to publish
 
+---
 
 Ahead of publication, you’ll need to [raise a ticket with the Digital communications (gov.uk) team](https://dfe.service-now.com/serviceportal?id=sc_cat_item&sys_id=1f40a44ddb50fa005ca2fddabf961922&sysparm_category=611828a6db6c2f403b929334ca9619f6&catalog_id=-1){target="_blank" rel="noopener noreferrer"} and ask them to create a new release (or add to a series if this already exists).
 
@@ -164,8 +163,9 @@ When you raise the ticket please ensure that all the documents you submit are in
 
 ---
 
-## Publication checklist
+### Publication checklist
 
+---
 
 Before you start creating your release you should have: 
 
@@ -181,9 +181,8 @@ Before you publish a release you should have:
 
 ---
 
-# Dashboards
+## Dashboards
 
----
 
 Dashboards built to meet a particular user need can be another helpful tool to help users access and understand your data, and can be hosted outside of EES or gov.uk.