Merge pull request #107 from rcpch/mbarton/api-signup-tweaks

Free tier sign up at forum.rcpch.tech

docs/_assets/_snippets/self-host-warning.md

@@ -17,4 +17,4 @@
 
     1. Registered with the MHRA as a Medical Device (for UK deployment) and EU MDR, with Declaration of Conformity (for EU deployment).
 
-    **For this reason, we STRONGLY recommend you DO NOT SELF-HOST any of our platform, but instead use the hosted (and attractively-priced) [Digital Growth Charts API platform](https://dev.rcpch.ac.uk/). Self-hosting means your organisation is fully liable for any errors in calculation, deployment, or functioning. We will not provide any free support for self-hosting organisations.**
+    **For this reason, we STRONGLY recommend you DO NOT SELF-HOST any of our platform, but instead use the hosted (and attractively-priced) [Digital Growth Charts API platform](https://growth.rcpch.ac.uk/). Self-hosting means your organisation is fully liable for any errors in calculation, deployment, or functioning. We will not provide any free support for self-hosting organisations.**

docs/about/acknowledgements.md

@@ -29,7 +29,7 @@ audience: all
 - [Heroku](https://www.heroku.com/) (used in early alpha stages for quick hosting)
 - [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) and [MkDocs](https://www.mkdocs.org/) itself (documentation sites)
 - [Microsoft Azure](https://azure.microsoft.com/) (main cloud platform)
-- [openhealthhub.org](https://openhealthhub.org/) (free forum hosting)
+- [openhealthhub.org](https://openhealthhub.org/) (free forum hosting, used for support before https://forum.rcpch.tech)
 - [Python](https://www.python.org/) and the Python Software Foundation (main language used for the RCPCH dGC project)
 - [ReactJS](https://reactjs.org/) (frontend JavaScript framework for Chart component and demo app)
 

docs/about/contact.md

@@ -14,7 +14,7 @@ audience: all
 
     These are the basis of an open, searchable knowledge base about the dGC Platform.
 
-    [RCPCH Forum :fontawesome-brands-discourse:](https://openhealthhub.org/c/rcpch-digital-growth-charts){ .md-button .md-button--primary }
+    [RCPCH Forum :fontawesome-brands-discourse:](https://forum.rcpch.tech){ .md-button .md-button--primary }
 
 !!! info "Signal Chat"
 

docs/clinician/faqs-for-clinicians.md

@@ -48,4 +48,4 @@ Initially, we expect that clinical users will want to see the traditional growth
 
 **A**: Our clinical safety documentation is completely open and public, and is all in the [Clinical Safety](../safety/overview.md) section.
 
-Feedback is welcome: contact [growth.digital@rcpch.ac.uk](mailto:growth.digital@rcpch.ac.uk), including "*Clinical Safety:*" in the subject for ease of routing to the Clinical Safety Officer. Alternatively, you can [create an Issue in the documentation site source code on GitHub](https://github.com/rcpch/digital-growth-charts-documentation/issues), or talk to us on our [Forum](https://openhealthhub.org/c/rcpch-digital-growth-charts).
+Feedback is welcome: contact [growth.digital@rcpch.ac.uk](mailto:growth.digital@rcpch.ac.uk), including "*Clinical Safety:*" in the subject for ease of routing to the Clinical Safety Officer. Alternatively, you can [create an Issue in the documentation site source code on GitHub](https://github.com/rcpch/digital-growth-charts-documentation/issues), or talk to us on our [Forum](https://forum.rcpch.tech).

docs/developer/react-component.md

@@ -32,7 +32,7 @@ The dGC React Component is the recommended way to display Digital Growth Charts
 React is a popular UI library for Javascript. It has endured well and remains a popular choice for developers. Importantly, unlike some other Javascript frameworks which are primarily designed for Single Page Applications, React doesn't expect to have the entire webpage to itself. It can be used as a small component in any other web page, even if the main framework being used is completely different.
 
 !!! question "Tell us what you think"
-Let us know what you think of our design decisions, on this or any other area of the dGC Project, by chatting to us on our [dGC Forum :fontawesome-brands-discourse:](https://openhealthhub.org/c/rcpch-digital-growth-charts/), or our RCPCH Community [Signal chat channel :simple-signal:](https://signal.group/#CjQKIAjLf5lS9OZIAI6lsJKWP1LmeJXkUW_fzZH1ryEw3oFEEhBH-4F7WnlyYjKerjfzD6B0)
+Let us know what you think of our design decisions, on this or any other area of the dGC Project, by chatting to us on our [dGC Forum :fontawesome-brands-discourse:](https://forum.rcpch.tech), or our RCPCH Community [Signal chat channel :simple-signal:](https://signal.group/#CjQKIAjLf5lS9OZIAI6lsJKWP1LmeJXkUW_fzZH1ryEw3oFEEhBH-4F7WnlyYjKerjfzD6B0)
 
 ### What about other frameworks/UI libraries?
 

docs/integrator/getting-started.md

@@ -1,6 +1,6 @@
 ---
 title: Getting Started
-reviewers: Dr Marcus Baw, Dr Anchit Chandran
+reviewers: Dr Marcus Baw, Dr Anchit Chandran, Michael Barton
 audience: integrators, implementers, technical-architects
 ---
 # Getting Started integrating Digital Growth Charts
@@ -9,40 +9,37 @@ The RCPCH Digital Growth Charts platform centres around a REST API which provide
 
 The next few pages will take you through the process of using the API. If you are an experienced user of REST APIs, this should be straightforward. We have deliberately designed this API to be simple and clear.
 
-## Sign up for the API service
+## Sign up for a free tier API key
 
 To use the Digital Growth Charts API, you need to sign up for an account and obtain **API keys**.
 
-These API keys allow us to manage usage of the API and prevent abuse. For exploring the platform, the Free Tier gives instant access. More information on pricing is available [here](../products/pricing.md).
+These API keys allow us to manage usage of the API and prevent abuse. We have a perpetually free tier of access for testing and exploring the platform.
+It has full access to the API but the number of requests are limited.
 
-> At present this sign-up step is on an external website because we use the Microsoft Azure API management platform. In the future, this may become a more streamlined on-boarding workflow.
+1. Sign up to our support forum at [https://forum.rcpch.tech/](https://forum.rcpch.tech/)
 
-[Go to dev.rcpch.ac.uk to sign up :octicons-link-external-16:](https://dev.rcpch.ac.uk/signup){ .md-button .md-button--primary}
+!!! tip Approval required
+    Sign up to the forum is subject to our approval process, please [contact us](../about/contact.md) if you are not approved automatically
 
-**Once signed up, come back here to follow the rest of the Getting Started tutorial.**
-## Choose a Product and Create an App
+2. Navigate to your user summary page using the drop down in the top right hand menu
 
-!!! tip "Onboarding support"
-    If you have any issues with getting the Tier you need, please [contact us](../about/contact.md).
+![forum-user-summary-link](../_assets/_images/forum-user-summary-link.png)
 
-1. Navigate to the [Products](https://dev.rcpch.ac.uk/product) menu item, and choose the Tier of the API subscription that you require.
+3. Click on the API keys tab
 
-    !!! warning "**IMPORTANT: ONLY THE FREE TIER GIVES YOU INSTANT ACCESS**"
-        Other tiers require waiting for **approval**, onboarding, and payment verification. Initially, we recommend the **Free Tier** for everyone. You can create multiple Free Tier apps, however, the usage is shared.
+4. Click Generate API key
 
-2. Select a Tier from the 'Tiers' drop-down to get started.
+![forum-user-api-keys](../_assets/_images/forum-user-api-keys.png)
 
-3. Create a unique name for your application. It doesn't matter what you call it as long as it has meaning for you, and it can be changed later in the Account part of the portal.
+!!! danger "API keys are secrets!"
+    API keys identify you to the API, so they should be considered *'secrets'*. If someone else can access and use your API keys, then they **are** effectively 'you' as far as our servers are concerned. Therefore, you must keep your API keys private, especially when using keys in a real application.
 
-4. Click 'Subscribe' to create the app.
+    The most common cause of accidental API key exposure is inadvertently committing a hard-coded API key to version control, such as Git, and then pushing it to a public site such as GitHub.
 
-![create-an-app](../_assets/_images/create-an-app.png)
-
-!!! tip "Improving these docs"
-    We're always looking for feedback on our documentation, so that we maintain clear, unambiguous guides for all parts of the platform. If something isn't clear please let us know, by [talking about it on our forums](https://openhealthhub.org/c/rcpch-digital-growth-charts), or creating an [issue on GitHub](https://github.com/rcpch/digital-growth-charts-documentation/issues). Please include enough description of the problem so we can fix it. Screenshots and links are super helpful for this.
-
-    You can also directly edit the docs and submit changes back to us for inclusion: click on the :material-pencil: button in the top left of any main text pane, which will take you to the source on GitHub. You will need to make your own GitHub fork of the documentation. Make your changes there and submit a pull request back to us. See [Contributing](../developer/contributing.md) for more info.
+!!! tip Production tiers
+    To launch your integration we offer a wide range of paid access tiers that do not have the restrictions of the free tier.
+    See our [pricing](https://www.rcpch.ac.uk/resources/growth-charts/digital/about#subscriptions-and-pricing).
 
 -----
 
-## Next: [Getting API keys](../integrator/api-keys.md)
+## Next: [Making API calls](../integrator/making-api-calls.md)

docs/integrator/support.md

@@ -48,11 +48,11 @@ To obtain the information you need for the best use of the RCPCH dGC platform de
 
 ### Discourse Forum
 
-Our primary support method is through the forum at [openhealthhub.org](https://openhealthhub.org/c/rcpch-digital-growth-charts). You can search for previous answers to your question, connect with the developers and team behind the API, and find a community of other integrators, with whom you can share tips and ideas.
+Our primary support method is through the forum at [forum.rcpch.tech](https://forum.rcpch.tech). You can search for previous answers to your question, connect with the developers and team behind the API, and find a community of other integrators, with whom you can share tips and ideas.
 
-[Go to the forums :fontawesome-brands-discourse:](https://openhealthhub.org/c/rcpch-digital-growth-charts){ .md-button .md-button--primary }
+[Go to the forums :fontawesome-brands-discourse:](https://forum.rcpch.tech){ .md-button .md-button--primary }
 
-[![open-health-hub-screenshot](../_assets/_images/ohh-screenshot.png)](https://openhealthhub.org/c/rcpch-digital-growth-charts)
+[![forum-screenshot](../_assets/_images/forum-screenshot.png)](https://forum.rcpch.tech/)
 
 ### Signal Chat
 

docs/legal/data-protection.md

@@ -36,7 +36,7 @@ In view of the stateless nature of the server, the RCPCH doesn't handle any Pati
 
 ## For the Digital Growth Charts API Service provided by the RCPCH
 
-[The API developer portal](https://dev.rcpch.ac.uk/) collects the essential minimum details from Consumers/Integrators/Customers, so we can provide them a safe, reliable API service. Use of the service requires some data to be collected. This data is retained only for the duration of the customer's use of the API service, after which is it deleted.
+[The API developer portal](https://forum.rcpch.tech/) collects the essential minimum details from Consumers/Integrators/Customers, so we can provide them a safe, reliable API service. Use of the service requires some data to be collected. This data is retained only for the duration of the customer's use of the API service, after which is it deleted.
 
 | Data elements                                | Reason for collection                                    |
 | -------------------------------------------- | -------------------------------------------------------- |

docs/legal/licensing-copyright.md

@@ -21,7 +21,7 @@ As responsible clinicians, the Project Board and Project Team all agreed the gro
 
     **Security**: allowing outsiders to see the source code does not introduce any security vulnerability. Security does not come from obscurity - hiding your code, as in the closed-source model. It comes from high standards of security practice, using the best industry practices, robust cryptography, and modern tools and approaches, described in Factor III of the ["12-Factor" application development philosophy](https://12factor.net/).
 
-    Other myths exist which imply some weakness about open-source projects. We are happy to discuss them if required in the [dGC Forum](https://openhealthhub.org/c/rcpch-digital-growth-charts).
+    Other myths exist which imply some weakness about open-source projects. We are happy to discuss them if required in the [dGC Forum](https://forum.rcpch.tech/).
 
 ## Copyright Notices
 

docs/products/api-server.md

@@ -17,7 +17,7 @@ reviewers: Dr Marcus Baw
 
 [:octicons-mark-github-16: GitHub repository](https://github.com/{{ repository_name }})
 
-[:octicons-code-review-24: Developer Portal](https://dev.rcpch.ac.uk) (Sign up and get API keys here)
+[:octicons-code-review-24: Developer Portal](https://forum.rcpch.tech/) (Sign up and get API keys here)
 
 [:material-api: API Gateway Base URL](https://api.rcpch.ac.uk) (NB: Without a valid API key, the endpoint will always respond with 404)
 

docs/products/products-overview.md

@@ -39,10 +39,6 @@ This is the API 'calculation engine' extracted out of the API so that it can be
 
 This is a CLI which wraps the `rcpch-python` package. It makes it easy to use the growth calculation functions of the python packages in the command line.
 
-### [Documentation](/)
-
-All documentation for the project is completely in the open and is primarily here on this documentation site. At present, a small amount of further documentation remains at the Azure API Management Developer Portal at [dev.rcpch.ac.uk](https://dev.rcpch.ac.uk), however we are working to bring all documentation into this site.
-
 ### [Clinical Safety documentation](../safety/overview.md)
 
 Including our complete Clinical Safety Management File for the development/manufacture (DCB0129) of the API and associated clients, libraries and tools, and for implementers to use as an information source for their own clinical safety cases.

docs/products/python-library.md

@@ -37,7 +37,7 @@ We have taken the slightly unusual step of licensing the python package under th
 
 ## Feedback
 
-We'd be interested to hear from people who are using the RCPCHGrowth Python package, so we can learn more about the use-cases and how we might continue to improve the package. Please do [create issues on our GitHub repo](https://github.com/rcpch/rcpchgrowth-python/issues), or discuss the package in the [dGC Forums](https://openhealthhub.org/c/rcpch-digital-growth-charts)
+We'd be interested to hear from people who are using the RCPCHGrowth Python package, so we can learn more about the use-cases and how we might continue to improve the package. Please do [create issues on our GitHub repo](https://github.com/rcpch/rcpchgrowth-python/issues), or discuss the package in the [dGC Forums](https://forum.rcpch.tech/)
 
 ## Contributing
 

docs/products/react-component.md

@@ -79,7 +79,7 @@ If you want to see how the library is implemented, we have built a full client f
 React is a popular UI library for Javascript. It has endured well and seems like a popular choice for developers. Importantly, unlike some other Javascript frameworks which are primarily designed for Single Page Applications, React doesn't expect to have the entire webpage to itself. It can be used as a small component in any other web page, even if the main framework being used is completely different.
 
 !!! question "Tell us what you think"
-    Let us know what you think of our design decisions, on this or any other area of the dGC Project, by chatting to us on our [dGC Forum](https://openhealthhub.org/c/rcpch-digital-growth-charts/) :fontawesome-brands-discourse:.
+    Let us know what you think of our design decisions, on this or any other area of the dGC Project, by chatting to us on our [dGC Forum](https://forum.rcpch.tech/) :fontawesome-brands-discourse:.
 
 ### What about other frameworks/UI libraries?
 

docs/safety/csmf/clinical-risk-mgmt-plan.md

@@ -109,7 +109,7 @@ Governance for patient safety within the Organisation is provided through the fo
 
 ### Public forum
 
-RCPCH maintains a presence on the Open Health Hub web forum ([openhealthhub.org](https://openhealthhub.org)), where users, implementers, and clinicians can feed back on the system. This is a transparent and open mechanism for safety feedback and aftermarket surveillance of the platform. Using the same system or using our contact page it is also possible to send a private message or contact via email in the event of a private communication being necessary.
+RCPCH maintains a web forum ([forum.rcpch.tech](https://forum.rcpch.tech/)), where users, implementers, and clinicians can feed back on the system. This is a transparent and open mechanism for safety feedback and aftermarket surveillance of the platform. Using the same system or using our contact page it is also possible to send a private message or contact via email in the event of a private communication being necessary.
 
 ## Healthcare IT Clinical Risk Management Deliverables
 

mkdocs.yml

@@ -195,7 +195,7 @@ extra:
     - icon: fontawesome/brands/github
       link: https://github.com/rcpch
     - icon: fontawesome/brands/discourse
-      link: https://openhealthhub.org/c/rcpch-digital-growth-charts
+      link: https://forum.rcpch.tech
     - icon: material/chat
       link: https://signal.group/#CjQKIAjLf5lS9OZIAI6lsJKWP1LmeJXkUW_fzZH1ryEw3oFEEhBH-4F7WnlyYjKerjfzD6B0