refactor(content-health-monitor): add instructions on how to setup the env var #262
Conversation
toph-allen
left a comment
toph-allen
left a comment
There was a problem hiding this comment.
Generally looks good! Just a few minor nitpicks or suggestions, but looks good to merge!
Another super-minor nit: Some of the lines end in periods, one ends in a colon, and some have no punctuation at the end, and you could harmonize them slightly. This is mostly just a pet peeve of mine, not something I think is critical! 😅
| # f'<img src="images/add-variable.png" alt="Adding environment variable" style="max-width: 80%; margin: 10px 0; border: 1px solid #ddd;"><br>' | ||
| f"{one_tab}• Click <b>Add Variable</b> to save it<br><br>" | ||
|
|
||
| f"<b>Step 3:</b> Click <b>Refresh Report</b> in the top right to continue.<br>" |
There was a problem hiding this comment.
Maybe you could say something like "to run a health check for the content using the new variable" to make it more explicit what action will take place, i.e. rendering the report is the health check? Not a requirement tho.
There was a problem hiding this comment.
I think being explicit makes sense. Note that I changed the wording slightly from your suggestion.
Co-authored-by: Toph Allen <toph.allen@gmail.com>
cgraham-rs
force-pushed
the
cgraham/chm-document-guid
branch
from
4225864 to
bc0a17c
Compare
This PR adds more detailed instructions and images on how to setup the required env var.
Fixes: https://github.com/posit-dev/connect/issues/32797
Currently deployed on our private team Connect server here: https://dogfood.team.pct.posit.it/connect/#/apps/1d97c1ff-e56c-4074-906f-cb3557685b75/7281