Suggest cases where a non-initialized DB may cause errors #356
Conversation
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified Files
|
dogversioning
force-pushed
the
mg/warn_init
branch
from
cb5f20c to
c55bc47
Compare
| if any(init_error in exit_message for init_error in config.db.init_errors()): | ||
| rich.print( | ||
| "Have you initialized your database?\n" | ||
| "https://docs.smarthealthit.org/cumulus/etl/setup/initialization.html" |
There was a problem hiding this comment.
In our docs about our docs: https://github.com/smart-on-fhir/cumulus/blob/main/CONTRIBUTING.md
We suggest (well I suggest since I think I wrote that) that cross-repo doc links should only link to the top level, to reduce chances of having broken links when one repo reorganizes things.
I buy that in general, but I know it’s helpful here… is it bad to point at the top level and say “look at the ETL docs for initializing” or something without directly pointing at it? Or do you want to ignore the guidance and deal with the risk of link rot?
There was a problem hiding this comment.
I think in this case I do want to take the risk in part because we've already seen instances of people not navigating the docs well. I do think that the changes in the structure make it a little easier to find this information, so you could talk me out of this, but I kind of just want to hit people over the head with the specific information we're asking them to read.
In cases where an error :might: be related to a database not being initialized by the etl, we'll point out the documentation. Addresses #354
Checklist
docs/needs to be updatedgenerate-mdcorestudy fields that not in US Core, update our list of those incore-study-details.mdmanifest.toml