Skip to content
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

Open
wants to merge 485 commits into
base: staging
Choose a base branch
from

Conversation

pacharanero
Copy link
Member

@pacharanero pacharanero commented Apr 9, 2024

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:

IMPORTANT

  • All other Issues on the docs site repo NEED TO BE TRANSFERRED TO THIS REPO and then labelled something like documentation

Copy link

github-actions bot commented Apr 9, 2024

Azure Static Web Apps: Your stage site is ready! Visit it here: https://red-mud-064bedc03-209.westeurope.4.azurestaticapps.net

@anchit-chandran
Copy link

Have just also made content updates:

  • Updates docker development documentation
  • Updates to developing the documentation site
  • Update all instances of signal / openhealthhub to discourse (except for a couple places which referred to articles that aren't present on the discourse)

Copy link

github-actions bot commented Apr 9, 2024

Azure Static Web Apps: Your stage site is ready! Visit it here: https://red-mud-064bedc03-209.westeurope.4.azurestaticapps.net

1 similar comment
Copy link

github-actions bot commented Apr 9, 2024

Azure Static Web Apps: Your stage site is ready! Visit it here: https://red-mud-064bedc03-209.westeurope.4.azurestaticapps.net

Copy link
Member

@mbarton mbarton left a 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!

@pacharanero
Copy link
Member Author

@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.

@mbarton
Copy link
Member

mbarton commented Apr 10, 2024

Go for it

@pacharanero pacharanero changed the base branch from live to staging April 19, 2024 09:47
@pacharanero
Copy link
Member Author

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

@mbarton
Copy link
Member

mbarton commented May 13, 2024

This change needs porting across to this PR before merging: rcpch/digital-growth-charts-documentation#105

@mbarton mbarton closed this May 13, 2024
@mbarton mbarton reopened this May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants