Skip to content

OBPIH-6197 Update documentation for official 0.9.x release #4771

Merged
jmiranda merged 55 commits intodevelopfrom
OBPIH-6197
Jan 24, 2025
Merged

OBPIH-6197 Update documentation for official 0.9.x release #4771
jmiranda merged 55 commits intodevelopfrom
OBPIH-6197

Conversation

@jmiranda
Copy link
Member

@jmiranda jmiranda commented Jul 29, 2024

@jmiranda jmiranda added the status: work in progress For issues or pull requests that are in progress but not yet completed label Jul 29, 2024
@github-actions github-actions bot added the domain: frontend Changes or discussions relating to the frontend UI label Jul 30, 2024
# Known Issues

* GitHub > MySQL 8 issues
* https://pihemr.atlassian.net/browse/OBS-1609
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These links won't be available for people outside PIH Jira

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah these links were more of a placeholder to remind me to pull out information from the ticket. but i'm just going to comment them out for now.

@jmiranda jmiranda removed the domain: frontend Changes or discussions relating to the frontend UI label Jul 31, 2024

Use the latest Configuration Guide to configure your server(s).

### Migrate Database
Copy link
Member

@ewaterman ewaterman Aug 1, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what about any data that was inserted since the backup was taken? Not much point to making it rolling deployable if everything done during the deployment is lost. Maybe I'm misunderstanding though

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we talked about this over slack. I was assuming this "parallel" option meant rolling deploy / no downtime deploy. Really it just means installing a new instance in parallel then migrating over when you're ready.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think what's throwing things off for me is the "Switch Over" step is glossing over quite a lot. I think what you're suggesting is taking two backups: One at the start of the process that we can upload to the new 0.9.x instance whenever we're ready to test the instance, and then a second backup while actually switching over to the new instance while the old instance is down to capture any new data that was added since then.

So we'd want the "Disable Production Environment" step to be before we do the second backup (not sure if you're still writing all this out).

Copy link
Member Author

@jmiranda jmiranda Aug 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to the point about "parallel" vs "in-place" migration, i am using those terms because those were the most common. however i still don't like "parallel" as it causes confusion. my first attempt at this was "clean slate" vs "in place", which i don't like because "clean slate" carries a conotation that is not true (i.e. we're starting fresh, including the database). but now i'm also seeing that "side-by-side" is also used to describe "parallel" migrations, so i might use that breakdown instead.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

regarding the "switch over" part, i'll just say that in general there's a lot missing so i might need some help structuring the missing buckets and maybe even writing some of these sections because my brain is mush after working on this for so long.

@github-actions github-actions bot added the domain: documentation Changes or discussions relating to documentation label Aug 16, 2024
@jmiranda jmiranda removed status: work in progress For issues or pull requests that are in progress but not yet completed domain: frontend Changes or discussions relating to the frontend UI labels Jan 24, 2025
@github-actions github-actions bot added the domain: frontend Changes or discussions relating to the frontend UI label Jan 24, 2025
@codecov
Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 7.78%. Comparing base (d8d1353) to head (2e1471f).
Report is 177 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff              @@
##             develop   #4771      +/-   ##
============================================
+ Coverage       7.74%   7.78%   +0.03%     
- Complexity       859     867       +8     
============================================
  Files            613     613              
  Lines          42621   42621              
  Branches       10350   10350              
============================================
+ Hits            3303    3320      +17     
+ Misses         38825   38806      -19     
- Partials         493     495       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jmiranda jmiranda changed the title OBPIH-6197 Update installation guide and other admin documentation OBPIH-6197 Update documentation for official 0.9.x release Jan 24, 2025
@jmiranda jmiranda merged commit 1b89764 into develop Jan 24, 2025
9 checks passed
@jmiranda jmiranda deleted the OBPIH-6197 branch January 24, 2025 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain: documentation Changes or discussions relating to documentation domain: frontend Changes or discussions relating to the frontend UI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants