Merge branch 'prerelease' into live

rcpch · Oct 17, 2023 · 5525667 · 5525667
2 parents b558b5c + e6eea3e
commit 5525667
Show file tree

Hide file tree

Showing 44 changed files with 488 additions and 525 deletions.
diff --git a/docs/about/about.md b/docs/about/about.md
@@ -1,7 +1,7 @@
 ---
 title: About the dGC
 reviewers: Dr Marcus Baw, Dr Anchit Chandran
-published: true
+audience: all
 ---
 
 # About the UK RCPCH Growth Chart API Project

diff --git a/docs/about/acknowledgements.md b/docs/about/acknowledgements.md
@@ -1,6 +1,7 @@
 ---
 title: Acknowledgements
 reviewers: Dr Marcus Baw, Dr Anchit Chandran
+audience: all
 ---
 
 # Acknowledgements

diff --git a/docs/about/awards-press-blogs.md b/docs/about/awards-press-blogs.md
@@ -1,6 +1,7 @@
 ---
 title: Awards, Press, Blogs
 reviewers: Dr Marcus Baw
+audience: all
 ---
 
 # Awards, Press, Blogs, and other Mentions of the dGC Project
@@ -17,7 +18,7 @@ docs/_assets/_snippets/htn-award.md
 
 ## Blogs
 
-["Royal Colleges 3.0" - Best Practice As Code](https://marcus-baw.medium.com/royal-colleges-3-0-best-practice-as-code-7065bce821a7)  
+["Royal Colleges 3.0" - Best Practice As Code](https://marcus-baw.medium.com/royal-colleges-3-0-best-practice-as-code-7065bce821a7)
 Marcus Baw's discussion of what it means for Royal Colleges to be developing in-house open-source software, and how this might be the future of how Royal Colleges interact with the wider clinical world – distributing “Best Practice As Code”.
 
 [August 2020 - RCPCH announces forthcoming digital growth charts for parents and families](https://www.rcpch.ac.uk/news-events/news/rcpch-announces-forthcoming-digital-growth-charts-parents-families)
@@ -34,6 +35,6 @@ Marcus Baw's discussion of what it means for Royal Colleges to be developing in-
 
 ## Videos
 
-[Understanding the RCPCH Digital Growth Charts Project - 35 minute YouTube video](https://www.youtube.com/watch?v=TRKd38d7_1I)  
+[Understanding the RCPCH Digital Growth Charts Project - 35 minute YouTube video](https://www.youtube.com/watch?v=TRKd38d7_1I)
 
-<iframe width="100%" height="500px" src="https://www.youtube-nocookie.com/embed/TRKd38d7_1I" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+<iframe width="100%" height="500px" src="https://www.youtube-nocookie.com/embed/TRKd38d7_1I" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
diff --git a/docs/about/contact.md b/docs/about/contact.md
@@ -1,6 +1,7 @@
 ---
 title: Contact the RCPCH team
 reviewers: Dr Marcus Baw, Dr Anchit Chandran
+audience: all
 ---
 
 # Contact

diff --git a/docs/about/team.md b/docs/about/team.md
@@ -1,6 +1,7 @@
 ---
 title: dGC Team
 reviewers: Dr Marcus Baw, Prof Tim Cole, Dr Anchit Chandran
+audience: clinicians, health-staff
 ---
 
 # Digital Growth Charts Team Members
@@ -26,15 +27,16 @@ RCPCH internal project staff provided invaluable support from project concept, t
 - **Jo Ball**, Design and Brand Manager, Content and Brand Team, RCPCH.
 - **Richard Burley**, Chief Digital Officer, RCPCH.
 - **Alex Brown**, Head of Commercial and Corporate Partnerships, RCPCH.
-- **Joanne Hatton**, Enterprise Systems Manager, RCPCH, London.
+- **Susan Hansford**, , Digital Product Manager, RCPCH.
+- **Joanne Hatton**, Enterprise Systems Manager, RCPCH.
 - **Jonathan Miall**, Director of Membership and Development, (now ret'd from RCPCH).
 - **Rachel McKeown**, Policy Lead & Project Manager, RCPCH (now left RCPCH).
 - **Kirsten Olson**, Website Content Manager, Content and Brand Team, RCPCH.
 - **Vicki Osmond**, Health Policy Assistant, RCPCH.
-- **Andrew Palmer**, Head of Information Systems, RCPCH, London (now left RCPCH).
+- **Andrew Palmer**, Head of Information Systems, RCPCH (now left RCPCH).
 - **Adele Picken**, Data Protection Officer, RCPCH
-- **Olly Rice**, Infrastructure and Operations Manager, RCPCH, London.
-- **Magdalena Umerska**, Digital Product Manager, RCPCH.
+- **Olly Rice**, Infrastructure and Operations Manager, RCPCH.
+- **Magdalena Umerska**, Digital Product Manager, RCPCH (now left RCPCH).
 
 ## Development Team
 
@@ -45,4 +47,5 @@ The development team was drawn from RCPCH internal staff, RCPCH members with sof
 - **Dr Anchit Chandran**, Doctor and Software Developer, London.
 - **Dr Simon Chapman**, Consultant in Paediatric Endocrinology, King's College Hospital, London.
 - **Prof Tim Cole**, Professor of Medical Statistics, Population, Policy & Practice Department, UCL GOS Institute of Child Health, London.
+- **Danny Cowen**, Medical Student, Imperial College London.
 - **Dr Charles van Lennep**, Paediatrician in Training, London.
diff --git a/docs/clinician/chart-information-health-staff.md b/docs/clinician/chart-information-health-staff.md
@@ -1,6 +1,7 @@
 ---
 title: Information for Health Staff
 reviewers: Dr Marcus Baw, Dr Anchit Chandran
+audience: clinicians, health-staff
 ---
 
 # Chart information for Health staff

diff --git a/docs/clinician/date-age-calculations.md b/docs/clinician/date-age-calculations.md
@@ -1,6 +1,7 @@
 ---
 title: Date and Age Calculations
 reviewers: Dr Marcus Baw, Dr Anchit Chandran
+audience: clinicians, health-staff, statisticians
 ---
 
 # Date and Age Calculations

diff --git a/docs/clinician/faqs-for-clinicians.md b/docs/clinician/faqs-for-clinicians.md
@@ -1,6 +1,7 @@
 ---
 title: FAQs for Clinicians
 reviewers: Dr Marcus Baw, Dr Anchit Chandran
+audience: clinicians, health-staff
 ---
 
 # Frequently Asked Questions for Clinicians
@@ -33,7 +34,7 @@ The process of integrating the API into an existing EPR product is technically s
 
 **A**: Yes, you can use the demo site at <https://growth.rcpch.ac.uk/> to evaluate the service.
 
-## Q: If we have a calculated centile from the API, then why do we need the traditional 'curved-lines' growth charts at all?  
+## Q: If we have a calculated centile from the API, then why do we need the traditional 'curved-lines' growth charts at all?
 
 **A**: Good question. Maybe, this style of chart will no longer be needed in the future. Perhaps they will be replaced by SDS charts, which would allow us to view height, weight, head circumference, and BMI all on one chart too!
 

diff --git a/docs/clinician/growth-references.md b/docs/clinician/growth-references.md
@@ -1,6 +1,7 @@
 ---
 title: Reference Data
 reviewers: Dr Marcus Baw, Dr Simon Chapman, Dr Anchit Chandran
+audience: clinicians, health-staff
 ---
 
 # Growth Chart References

diff --git a/docs/clinician/how-the-api-works.md b/docs/clinician/how-the-api-works.md
@@ -1,6 +1,7 @@
 ---
 title: How the API Works
 reviewers: Dr Marcus Baw, Dr Anchit Chandran
+audience: clinicians, health-staff, statisticians
 ---
 # How the API Works
 

diff --git a/docs/developer/api-docker.md b/docs/developer/api-docker.md
@@ -1,6 +1,7 @@
 ---
 title: Docker development
 reviewers: Dr Marcus Baw, Dr Sean Cusack, Dr Anchit Chandran
+audience: developers
 ---
 
 # Developing locally in a Docker container

diff --git a/docs/developer/api-python.md b/docs/developer/api-python.md
@@ -1,6 +1,7 @@
 ---
 title: Python development
 reviewers: Dr Marcus Baw, Dr Anchit Chandran
+audience: developers
 ---
 
 # Running locally with Python
@@ -179,7 +180,7 @@ activate.bat
 You should then see the name of your virtual environment prepend your prompts e.g.
 
 ```console
-(env) C:\Users\...\digital-growth-charts-server\env\Scripts> 
+(env) C:\Users\...\digital-growth-charts-server\env\Scripts>
 ```
 
 Now, go back to the root directory
@@ -222,4 +223,4 @@ There may be other messages at the end of the output for other processes which r
 If you need to vary any of the parameters passed, you can either:
 
 1. Modify the start-up script
-2. Manually pass the commands to the shell, using the commands in the start-up script as a guide
+2. Manually pass the commands to the shell, using the commands in the start-up script as a guide
diff --git a/docs/developer/api-testing.md b/docs/developer/api-testing.md
@@ -1,6 +1,7 @@
 ---
 title: Testing the API
 reviewers: Dr Marcus Baw, Dr Anchit Chandran
+audience: developers
 ---
 
 # Testing the API

diff --git a/docs/developer/contributing.md b/docs/developer/contributing.md
@@ -1,6 +1,7 @@
 ---
 title: Contributing
 reviewers: Dr Marcus Baw, Dr Anchit Chandran
+audience: developers
 ---
 
 ## Contributing
@@ -10,15 +11,15 @@ We're a friendly bunch, and happy to chat. You can get in touch with the primary
 ### How to contribute
 
 - Fork the repository to your own GitHub account.
-  
+
 - Set up your development environment (ideally using our instructions [here](api-python.md) for maximum compatibility with our own development environments).
-  
+
 - Ideally, you should discuss the proposed change with our team, because we can only accept pull requests with an accepted need for a new feature or fix.
-  
+
 - We can discuss with you our recommendations for implementation of the new feature, for maximum potential 'mergeability' of your PR.
-  
+
 - Once you are ready to show us your work, create a pull request on our repo, detailing what the change is and details about the fix or feature. PRs that affect the calculations or any other 'mission critical' part of the code will need suitable tests which we can run.
-  
+
 - We will endeavour to review and merge in a reasonable time frame, but will usually not merge straight into `master`, rather we will merge into an upcoming release branch.
 
 ### Coding style
@@ -27,7 +28,7 @@ We are not Python experts, but encourage use of Python best practices where poss
 
 Some helpful sources of information on Python style are:
 
-- <https://www.python.org/dev/peps/pep-0008>  
+- <https://www.python.org/dev/peps/pep-0008>
 - <https://google.github.io/styleguide/pyguide.html>
 
 ## Intellectual Property (IP) of contributions

diff --git a/docs/developer/faqs-for-developers.md b/docs/developer/faqs-for-developers.md
@@ -1,6 +1,7 @@
 ---
 title: FAQs for Developers
 reviewers: Dr Marcus Baw, Dr Anchit Chandran
+audience: developers
 ---
 
 # FAQs for Developers

diff --git a/docs/developer/rcpchgrowth-cli.md b/docs/developer/rcpchgrowth-cli.md
@@ -1,6 +1,7 @@
 ---
 title: RCPCHGrowth CLI
 reviewers: Dr Marcus Baw, Dr Simon Chapman
+audience: developers
 ---
 
 # Developing the RCPCH CLI tools

diff --git a/docs/developer/rcpchgrowth.md b/docs/developer/rcpchgrowth.md
@@ -1,6 +1,7 @@
 ---
 title: RCPCHGrowth library
 reviewers: Dr Simon Chapman, Dr Anchit Chandran
+audience: developers
 ---
 
 ## Overview

diff --git a/docs/developer/react-client.md b/docs/developer/react-client.md
@@ -1,7 +1,7 @@
 ---
 title: React Client
 reviewers: Dr Simon Chapman, Dr Marcus Baw
-
+audience: developers
 ---
 
 ## Developer documentation