-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merges rcpch/digital-growth-charts-documentation site into the dGC server repo #209
base: staging
Are you sure you want to change the base?
Conversation
(redundant link in 'About' as already linked to in nav)
- minor format/typo
-personal preference: changed title 'library' to 'package'
- made more consistent + OS agnostic
- updated formatting
Signed-off-by: anchit-chandran <[email protected]>
Signed-off-by: anchit-chandran <[email protected]>
Signed-off-by: anchit-chandran <[email protected]>
Azure Static Web Apps: Your stage site is ready! Visit it here: https://red-mud-064bedc03-209.westeurope.4.azurestaticapps.net |
Signed-off-by: anchit-chandran <[email protected]>
Signed-off-by: anchit-chandran <[email protected]>
Have just also made content updates:
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://red-mud-064bedc03-209.westeurope.4.azurestaticapps.net |
1 similar comment
Azure Static Web Apps: Your stage site is ready! Visit it here: https://red-mud-064bedc03-209.westeurope.4.azurestaticapps.net |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm happy with this approach, thanks for the consolidation!
@mbarton are you happy for me to merge this today? AFAICT there's no changes which would affect the dGC server itself, only documentation additions. Tests are all passing, and the Azure deployment GitHub Workflow for dGC Server is unchanged apart from updates of the Actions versions. With these changes, we are strongly encouraging the use of the Docker Compose setup for dGC Server development, but that is not going to affect deployment. |
Go for it |
In the process of preparing to merge this I have found some issues with the Pydantic upgrade done a few weeks back so this PR is on hold until we have that a little more sorted out |
This change needs porting across to this PR before merging: rcpch/digital-growth-charts-documentation#105 |
This is a complete merge of the
rcpch/digital-growth-charts-documentation
site into the dGC repository.The purpose of this merge is to bring the docs site 'closer' to one of the main dGC repos, meaning that it will be easier to make docs site changes while editing other code.
In local development we have optimised towards using Docker Compose to run the FastAPI and Material for MkDocs containers (both built from the same image as they are very similar)
For deployment, each service is deployed via a GitHub Action to separate Azure Web Apps (a Static Web App in the case of the Docs site)
The PR contains the entire Git history of the original docs site so there are a very large number of commits. However the bulk of the documentation has not been changed at all from the other repo, we just merged it into place here in this repo.
When merged, this PR closes the following Issues:
(as these Issues are in a different repo we may not be able to rely upon GitHub auto-closing these when merged, so please check)
IMPORTANT
documentation