diff --git a/.nojekyll b/.nojekyll index e7bca43..fba49a4 100644 --- a/.nojekyll +++ b/.nojekyll @@ -1 +1 @@ -d0765dd8 \ No newline at end of file +e677a966 \ No newline at end of file diff --git a/CONTRIBUTE.html b/CONTRIBUTE.html new file mode 100644 index 0000000..b0d9fa0 --- /dev/null +++ b/CONTRIBUTE.html @@ -0,0 +1,778 @@ + + + + + + + + + +Producing Quality Analysis + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + +
+ +
+ + +
+ + + +
+ + + + +
+

How to contribute

+

Hi there! Thank you for considering contributing to the NHSBSA Producing Quality Analysis Playbook. The Playbook is meant to serve the D&A community, so contributions from community members themselves are super important in making this a reality!

+
+

Creating an issue

+

If you think of something worth including, improving, or want to contribute, please raise an issue on GitHub.

+
+
+

Submitting a pull request

+

Please submit new contributions via a pull request:

+
    +
  1. Fork or clone the repository
    2. +
  2. If you want to run the page on your machine, configure and install the dependencies. See the README for details.
    3. +
  3. Create a new branch: (e.g. git checkout -b my-branch-name)
    4. +
  4. Make your change
    5. +
  5. Push to your fork and submit a pull request
    6. +
+

Your pull request will then be reviewed. You may receive some feedback and suggested changes before it can be approved and your pull request merged.

+
+

To increase the likelihood of your pull request being accepted:

+
    +
  • If you are making visual changes, include a screenshot of what the affected element looks like, both before and after.
    • +
  • Keep your change as focussed as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
    • +
  • Write good commit messages.
    • +
+
+
+
+

Getting started with development

+
+

Environments

+
+

Github Codespaces

+

The easiest way is just to open the repo in Github Codespaces - you can then make your changes, run the website to check it, and commit those back all within a VSCode environment.

+
+
+

Working locally

+

If you don’t want to use Github codespaces (or can’t because it’s blocked, or you’ve run out of credits), then you can make changes to the repo locally on your machine.

+
+
+
+

Installing dependencies

+

See the README for guidance on installing the dependencies and getting started with development.

+
+
+

Adding or editing content

+
+

To add a new page to within the existing structure

+
    +
  1. Navigate to the relevant subfolder within guidance (e.g. guidance/03-responsibilities/pages)
    2. +
  2. Add a qmd file with the following header fields: --- title: "This is the title of your page" description: "This is a brief description of your page" image-alt: "This text will show if your image can't be displayed" image: <name of a .jpg file stored in the same subfolder to use for the card> ---
    3. +
  3. Add the content below the header using standard markdown syntax.
    4. +
  4. A link to the page will be added as a card on the landing page. If you want to show an image on the card, add a jpeg file to the same subfolder as the content and include the name in the header fields as above.
    5. +
  5. Once you are happy with your changes submit a pull request!
    6. +
+
+
+

To add a new page within a new section

+
    +
  1. Create the a subfolder within guidance and name it appropriately (e.g. 04-business-critical-models). Note that the sections will be ordered in the dropdown on the website according to the numbers in front of the subfolders (i.e. first 01- then 02- and so on)
    2. +
  2. Add an index.qmd file to the subfolder (you can use one of the existing files as an example!)
    3. +
  3. Follow the steps above to add the new page within the section you’ve just created.
    4. +
  4. Once you are happy with your changes submit a pull request!
    5. +
+
+
+
+
+

Resources

+ +
+
+

Acknowledgements

+

Thank you to the NHS England RAP Community of Practice from which this guide took heavy inspiration!

+ + +
+
+ +
+ +
+ + + + + \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..53fbb52 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# NHSBSA Producing Quality Analysis Playbook + +This repository contains the framework for writing and deploying the NHSBSA Producing Quality Analysis Playbook. +The Playbook is used to give detailed guidance on producing quality analysis. + +The live version of The Playbook can be found [here](https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/). + +## Getting started + +The Playbook is created using [Quarto](https://quarto.org/docs/get-started/). +You can run the document by: +1. Opening the repository in Rstudio or VS Code + - For Rstudio usage, you simply require the latest version of Rstudio. + - For VS Code, you must install the Quarto extension and install the Quarto CLI. When running Quarto for the first time, you will be prompted with instructions on how to install this. **Please note this is not currently possible with the Azure Virtual Desktop (AVD)**. +1. Opening [index.qmd](/index.qmd) in the repository root +1. Click 'Compile' or 'Preview' respectively. + - Note: for Rstudio usage, you must also load the `quality-analysis-playbook.Rproj` project to be able to compile the document. + +## Folder Structure + +The playbook is structured into a series of sections and sub-sections. The home page first greets the users with the tabs to navigate to the four main sections. Then, once the user has clicked on a section, they are then provided with additional tabs to navigate to a page about each sub-section. The following folder structure highlights how this is setup up from a coding perspective. Each section and sub-section is populated by a `.qmd` file and supporting `.jpeg` file to provide the image for each tab. + +``` +NHSBSA Producing Quality Analysis Playbook +├───guidance ............................# Folder containing all of the playbook content separated by pages +| ├───_metadata.yml ...................# Additional settings applied to the quarto document +├───static ..............................# A folder containing the the BSA visual settings for the quarto document +├───_quarto.yml .........................# A file that controls the page layout and settings for the quarto document +├───about.qmd ...........................# An additional .qmd that populates the 'About' button within the document +├───quality-analysis-playbook.Rproj .................# The R Project file +├───index.qmd ...........................# The primary .qmd file, used to compile the entire document. +├───README.md ...........................# The README file +├───styles.css ..........................# A file containing some additional settings for the quarto document +``` + +## Contributing to The Playbook +We welcome contributions from community members. +Please see our [contributing guide](./CONTRIBUTE.md) for information on how you can get involved! diff --git a/guidance/02-analytical-cycle/index.html b/guidance/02-analytical-cycle/index.html index 8e2e951..f2bb514 100644 --- a/guidance/02-analytical-cycle/index.html +++ b/guidance/02-analytical-cycle/index.html @@ -330,7 +330,7 @@

Analytical Cycle

-
+

@@ -352,7 +352,7 @@

-
+

@@ -374,7 +374,7 @@

-
+

@@ -396,7 +396,7 @@

-
+

@@ -418,7 +418,7 @@

-
+

@@ -440,7 +440,7 @@

-
+

diff --git a/guidance/03-responsibilities/index.html b/guidance/03-responsibilities/index.html index cb8384e..eb80b4b 100644 --- a/guidance/03-responsibilities/index.html +++ b/guidance/03-responsibilities/index.html @@ -329,7 +329,7 @@

Responsibilities

-
+

@@ -351,7 +351,7 @@

-
+

@@ -373,7 +373,7 @@

-
+

diff --git a/index.html b/index.html index 996965a..fdd4e42 100644 --- a/index.html +++ b/index.html @@ -5283,7 +5283,7 @@

NHSBSA Producing Quality Analysis Playbook
-
+

@@ -5305,7 +5305,7 @@

-
+

@@ -5325,7 +5325,7 @@
-
+

diff --git a/search.json b/search.json index 0e4e849..9329ef3 100644 --- a/search.json +++ b/search.json @@ -84,6 +84,48 @@ "NHSBSA Producing Quality Analysis Playbook" ] }, + { + "objectID": "CONTRIBUTE.html", + "href": "CONTRIBUTE.html", + "title": "How to contribute", + "section": "", + "text": "Hi there! Thank you for considering contributing to the NHSBSA Producing Quality Analysis Playbook. The Playbook is meant to serve the D&A community, so contributions from community members themselves are super important in making this a reality!\n\n\nIf you think of something worth including, improving, or want to contribute, please raise an issue on GitHub.\n\n\n\nPlease submit new contributions via a pull request:\n\nFork or clone the repository\nIf you want to run the page on your machine, configure and install the dependencies. See the README for details.\nCreate a new branch: (e.g. git checkout -b my-branch-name)\nMake your change\nPush to your fork and submit a pull request\n\nYour pull request will then be reviewed. You may receive some feedback and suggested changes before it can be approved and your pull request merged.\n\n\n\nIf you are making visual changes, include a screenshot of what the affected element looks like, both before and after. \nKeep your change as focussed as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.\nWrite good commit messages.\n\n\n\n\n\n\n\n\n\nThe easiest way is just to open the repo in Github Codespaces - you can then make your changes, run the website to check it, and commit those back all within a VSCode environment.\n\n\n\nIf you don’t want to use Github codespaces (or can’t because it’s blocked, or you’ve run out of credits), then you can make changes to the repo locally on your machine.\n\n\n\n\nSee the README for guidance on installing the dependencies and getting started with development.\n\n\n\n\n\n\nNavigate to the relevant subfolder within guidance (e.g. guidance/03-responsibilities/pages)\nAdd a qmd file with the following header fields: --- title: \"This is the title of your page\" description: \"This is a brief description of your page\" image-alt: \"This text will show if your image can't be displayed\" image: <name of a .jpg file stored in the same subfolder to use for the card> ---\nAdd the content below the header using standard markdown syntax.\nA link to the page will be added as a card on the landing page. If you want to show an image on the card, add a jpeg file to the same subfolder as the content and include the name in the header fields as above.\nOnce you are happy with your changes submit a pull request!\n\n\n\n\n\nCreate the a subfolder within guidance and name it appropriately (e.g. 04-business-critical-models). Note that the sections will be ordered in the dropdown on the website according to the numbers in front of the subfolders (i.e. first 01- then 02- and so on)\nAdd an index.qmd file to the subfolder (you can use one of the existing files as an example!)\nFollow the steps above to add the new page within the section you’ve just created.\nOnce you are happy with your changes submit a pull request!\n\n\n\n\n\n\n\nContributing to Projects\nUsing Pull Requests\nGitHub Help\n\n\n\n\nThank you to the NHS England RAP Community of Practice from which this guide took heavy inspiration!" + }, + { + "objectID": "CONTRIBUTE.html#creating-an-issue", + "href": "CONTRIBUTE.html#creating-an-issue", + "title": "How to contribute", + "section": "", + "text": "If you think of something worth including, improving, or want to contribute, please raise an issue on GitHub." + }, + { + "objectID": "CONTRIBUTE.html#submitting-a-pull-request", + "href": "CONTRIBUTE.html#submitting-a-pull-request", + "title": "How to contribute", + "section": "", + "text": "Please submit new contributions via a pull request:\n\nFork or clone the repository\nIf you want to run the page on your machine, configure and install the dependencies. See the README for details.\nCreate a new branch: (e.g. git checkout -b my-branch-name)\nMake your change\nPush to your fork and submit a pull request\n\nYour pull request will then be reviewed. You may receive some feedback and suggested changes before it can be approved and your pull request merged.\n\n\n\nIf you are making visual changes, include a screenshot of what the affected element looks like, both before and after. \nKeep your change as focussed as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.\nWrite good commit messages." + }, + { + "objectID": "CONTRIBUTE.html#getting-started-with-development", + "href": "CONTRIBUTE.html#getting-started-with-development", + "title": "How to contribute", + "section": "", + "text": "The easiest way is just to open the repo in Github Codespaces - you can then make your changes, run the website to check it, and commit those back all within a VSCode environment.\n\n\n\nIf you don’t want to use Github codespaces (or can’t because it’s blocked, or you’ve run out of credits), then you can make changes to the repo locally on your machine.\n\n\n\n\nSee the README for guidance on installing the dependencies and getting started with development.\n\n\n\n\n\n\nNavigate to the relevant subfolder within guidance (e.g. guidance/03-responsibilities/pages)\nAdd a qmd file with the following header fields: --- title: \"This is the title of your page\" description: \"This is a brief description of your page\" image-alt: \"This text will show if your image can't be displayed\" image: <name of a .jpg file stored in the same subfolder to use for the card> ---\nAdd the content below the header using standard markdown syntax.\nA link to the page will be added as a card on the landing page. If you want to show an image on the card, add a jpeg file to the same subfolder as the content and include the name in the header fields as above.\nOnce you are happy with your changes submit a pull request!\n\n\n\n\n\nCreate the a subfolder within guidance and name it appropriately (e.g. 04-business-critical-models). Note that the sections will be ordered in the dropdown on the website according to the numbers in front of the subfolders (i.e. first 01- then 02- and so on)\nAdd an index.qmd file to the subfolder (you can use one of the existing files as an example!)\nFollow the steps above to add the new page within the section you’ve just created.\nOnce you are happy with your changes submit a pull request!" + }, + { + "objectID": "CONTRIBUTE.html#resources", + "href": "CONTRIBUTE.html#resources", + "title": "How to contribute", + "section": "", + "text": "Contributing to Projects\nUsing Pull Requests\nGitHub Help" + }, + { + "objectID": "CONTRIBUTE.html#acknowledgements", + "href": "CONTRIBUTE.html#acknowledgements", + "title": "How to contribute", + "section": "", + "text": "Thank you to the NHS England RAP Community of Practice from which this guide took heavy inspiration!" + }, { "objectID": "about.html", "href": "about.html", diff --git a/sitemap.xml b/sitemap.xml index 9122ddf..28c32d4 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,66 +2,70 @@ https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/13-types-of-analytical-model.html - 2025-01-20T07:36:43.017Z + 2025-01-22T11:29:02.388Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/02-analytical-cycle/index.html - 2025-01-20T07:36:42.868Z + 2025-01-22T11:29:02.239Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/02-analytical-cycle/pages/05-conducting-the-analysis.html - 2025-01-20T07:36:42.869Z + 2025-01-22T11:29:02.239Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/02-analytical-cycle/pages/03-customer-engagement.html - 2025-01-20T07:36:42.869Z + 2025-01-22T11:29:02.239Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/02-analytical-cycle/pages/04-analysis-design.html - 2025-01-20T07:36:42.869Z + 2025-01-22T11:29:02.239Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/03-responsibilities/index.html - 2025-01-20T07:36:42.967Z + 2025-01-22T11:29:02.338Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/03-responsibilities/pages/09-commissioner-responsibilities.html - 2025-01-20T07:36:42.967Z + 2025-01-22T11:29:02.338Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/index.html - 2025-01-20T07:36:43.017Z + 2025-01-22T11:29:02.388Z + + + https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/CONTRIBUTE.html + 2025-01-22T11:29:02.230Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/about.html - 2025-01-20T07:36:42.861Z + 2025-01-22T11:29:02.231Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/03-responsibilities/pages/11-critical-friend.html - 2025-01-20T07:36:42.967Z + 2025-01-22T11:29:02.338Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/03-responsibilities/pages/10-analyst-responsibilities.html - 2025-01-20T07:36:42.967Z + 2025-01-22T11:29:02.338Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/01-principles/index.html - 2025-01-20T07:36:42.861Z + 2025-01-22T11:29:02.231Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/02-analytical-cycle/pages/08-review.html - 2025-01-20T07:36:42.869Z + 2025-01-22T11:29:02.239Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/02-analytical-cycle/pages/07-approval-and-distribution.html - 2025-01-20T07:36:42.869Z + 2025-01-22T11:29:02.239Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/02-analytical-cycle/pages/06-delivery-and-approval.html - 2025-01-20T07:36:42.869Z + 2025-01-22T11:29:02.239Z https://nhsbsa-data-analytics.github.io/nhsbsa-quality-analysis-playbook/guidance/12-RIGOUR.html - 2025-01-20T07:36:43.017Z + 2025-01-22T11:29:02.388Z