-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #53 from NHSDigital/release/v1.8.0
Release v1.8.0
- Loading branch information
Showing
92 changed files
with
1,589 additions
and
509 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,13 @@ | ||
--- | ||
title: RAP Community of Practice | ||
|
||
tags: | ||
- RAP CoP website | ||
hide: | ||
- navigation | ||
--- | ||
|
||
# RAP Community of Practice | ||
# | ||
|
||
> **This material is maintained by the [NHS England RAP Community of Practice](mailto:[email protected])**. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,113 +1,121 @@ | ||
# Page Template | ||
|
||
## Some introductory subtitle | ||
|
||
!!! tip "TLDR" | ||
- **very brief** summary of the main findings | ||
- any key links i.e. to forms or other things people need fill in | ||
- try to keep it to just three | ||
|
||
??? question "Why should we care?" | ||
- Brief summary of why this is important | ||
- any key links of background | ||
- We can have a bigger section on this below | ||
|
||
??? success "Pre-requisites" | ||
* Some information on what someone might need to be familiar with before they can use this page | ||
|
||
|Pre-requisite | Importance | Note | | ||
|--------------|------------|------| | ||
|[Some link to some other guide we have](https://nhsdigital.github.io/rap-community-of-practice/)|Necessary/Helpful|Any comment we have on this| | ||
|some other guide|Helpful|another note| | ||
|
||
!!! info inline end | ||
XKCD comics can also be great at grabbing attention: | ||
|
||
![An amusing comic about marketing](https://imgs.xkcd.com/comics/immune_system.png "An amusing comic about marketing") | ||
|
||
**Don't forget to update the `mkdocs.yml` file to add this page, so it appears in the nav bar!** | ||
|
||
Here we need some bit explaining the background of the thing the page is talking about | ||
|
||
- keep it brief | ||
- make it clear what it is and what the benefit is | ||
- don't go into details of the methods, but perhaps highlight some of the key approaches described below | ||
|
||
## First subtitle of the main content | ||
|
||
Talk about the issue break it down into steps. | ||
|
||
We might even include a little diagram: | ||
|
||
```mermaid | ||
graph LR | ||
A[Have an idea] --> B{Make a page}; | ||
B -->|Pull Request| C[Colleagues Review]; | ||
C --> D[Feedback]; | ||
D --> B; | ||
B ----->|Approved| E[Publish!]; | ||
``` | ||
|
||
Consider linking to other pages and try and extract the general concept from language specific implementations, i.e. we could have a pager about "functions", and then link to specific pages on how to do functions in Python and R. | ||
|
||
Also, have a look on the following pages to see if they have guidance we could link to, or adapt | ||
- [Quality Assurance of Code for Analytics](https://best-practice-and-impact.github.io/qa-of-code-guidance/intro.html) | ||
- [Turing Way](https://the-turing-way.netlify.app/welcome.html) | ||
- [Central RAP Guidance from GSS](https://analysisfunction.civilservice.gov.uk/support/reproducible-analytical-pipelines/) | ||
|
||
## General subsection template | ||
|
||
Write some content here | ||
|
||
### General subsubsection template | ||
|
||
This might be on some specific aspect of the subsection | ||
|
||
#### General subsubsubsection template | ||
|
||
We might need to get even more specific, but probably wont use this as much! | ||
|
||
## Further subtitles | ||
|
||
You can include code snippets `inline` or in blocks: | ||
|
||
```Python | ||
print("hello world") | ||
``` | ||
|
||
You might also want to hide large code snippets: | ||
|
||
??? example "Some big code snippet" | ||
```Python | ||
print("HA, I lied, it's only a small code snippet") | ||
``` | ||
|
||
!!! note | ||
Admonition blocks can be helpful to bring out key points | ||
|
||
See [mkdocs guidance]() | ||
|
||
## Further subsections | ||
|
||
Continue to work through the subject, but we don't have to make the pages long - a short page can be just as useful! | ||
|
||
You can include pictures, however referencing them requires a few steps back in the directory tree (see below): | ||
|
||
![image-alt-text](images/add_file.PNG "Some random picture") | ||
|
||
You can also have tabs: | ||
|
||
=== "Tab 1" | ||
We can put whatever we want in here | ||
```Python | ||
def somefunc(a): | ||
return None | ||
``` | ||
|
||
=== "Tab 2" | ||
And in here something completely different, such as a diagram | ||
![alt text](images/branch_info.JPG "Some random picture") | ||
|
||
## Further Reading | ||
|
||
- Provide any useful links people might need to further their learning | ||
--- | ||
title: Add your title here | ||
|
||
# Uncomment and add your tags here | ||
# tags: | ||
# - | ||
--- | ||
|
||
# | ||
|
||
## Some introductory subtitle | ||
|
||
!!! tip "TLDR" | ||
- **very brief** summary of the main findings | ||
- any key links i.e. to forms or other things people need fill in | ||
- try to keep it to just three | ||
|
||
??? question "Why should we care?" | ||
- Brief summary of why this is important | ||
- any key links of background | ||
- We can have a bigger section on this below | ||
|
||
??? success "Pre-requisites" | ||
* Some information on what someone might need to be familiar with before they can use this page | ||
|
||
|Pre-requisite | Importance | Note | | ||
|--------------|------------|------| | ||
|[Some link to some other guide we have](https://nhsdigital.github.io/rap-community-of-practice/)|Necessary/Helpful|Any comment we have on this| | ||
|some other guide|Helpful|another note| | ||
|
||
!!! info inline end | ||
XKCD comics can also be great at grabbing attention: | ||
|
||
![An amusing comic about marketing](https://imgs.xkcd.com/comics/immune_system.png "An amusing comic about marketing") | ||
|
||
**Don't forget to update the `mkdocs.yml` file to add this page, so it appears in the nav bar!** | ||
|
||
Here we need some bit explaining the background of the thing the page is talking about | ||
|
||
- keep it brief | ||
- make it clear what it is and what the benefit is | ||
- don't go into details of the methods, but perhaps highlight some of the key approaches described below | ||
|
||
## First subtitle of the main content | ||
|
||
Talk about the issue break it down into steps. | ||
|
||
We might even include a little diagram: | ||
|
||
```mermaid | ||
graph LR | ||
A[Have an idea] --> B{Make a page}; | ||
B -->|Pull Request| C[Colleagues Review]; | ||
C --> D[Feedback]; | ||
D --> B; | ||
B ----->|Approved| E[Publish!]; | ||
``` | ||
|
||
Consider linking to other pages and try and extract the general concept from language specific implementations, i.e. we could have a pager about "functions", and then link to specific pages on how to do functions in Python and R. | ||
|
||
Also, have a look on the following pages to see if they have guidance we could link to, or adapt | ||
- [Quality Assurance of Code for Analytics](https://best-practice-and-impact.github.io/qa-of-code-guidance/intro.html) | ||
- [Turing Way](https://the-turing-way.netlify.app/welcome.html) | ||
- [Central RAP Guidance from GSS](https://analysisfunction.civilservice.gov.uk/support/reproducible-analytical-pipelines/) | ||
|
||
## General subsection template | ||
|
||
Write some content here | ||
|
||
### General subsubsection template | ||
|
||
This might be on some specific aspect of the subsection | ||
|
||
#### General subsubsubsection template | ||
|
||
We might need to get even more specific, but probably wont use this as much! | ||
|
||
## Further subtitles | ||
|
||
You can include code snippets `inline` or in blocks: | ||
|
||
```Python | ||
print("hello world") | ||
``` | ||
|
||
You might also want to hide large code snippets: | ||
|
||
??? example "Some big code snippet" | ||
```Python | ||
print("HA, I lied, it's only a small code snippet") | ||
``` | ||
|
||
!!! note | ||
Admonition blocks can be helpful to bring out key points | ||
|
||
See [mkdocs guidance]() | ||
|
||
## Further subsections | ||
|
||
Continue to work through the subject, but we don't have to make the pages long - a short page can be just as useful! | ||
|
||
You can include pictures, however referencing them requires a few steps back in the directory tree (see below): | ||
|
||
![image-alt-text](images/add_file.PNG "Some random picture") | ||
|
||
You can also have tabs: | ||
|
||
=== "Tab 1" | ||
We can put whatever we want in here | ||
```Python | ||
def somefunc(a): | ||
return None | ||
``` | ||
|
||
=== "Tab 2" | ||
And in here something completely different, such as a diagram | ||
![alt text](images/branch_info.JPG "Some random picture") | ||
|
||
## Further Reading | ||
|
||
- Provide any useful links people might need to further their learning |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.