Add explanation of SHM config command - Githubissues

alan-turing-institute / data-safe-haven

https://data-safe-haven.readthedocs.io

BSD 3-Clause "New" or "Revised" License

61 stars 15 forks source link

Add explanation of SHM config command #2268

Open JimMadge opened 2 weeks ago

JimMadge commented 2 weeks ago

:white_check_mark: Checklist

[x] I have searched open and closed issues for duplicates
[x] This is a request for a change to documentation
[x] This isn't a feature request or bug report
[x] This isn't an open-ended question (open a discussion if it is).

:ledger: Where is the problem?

The SHM deployment guide doesn't explain that you can see the configuration of a previously deployed SHM.

This could be very useful if users need to update/redeploy/validate an existing SHM.

:memo: Required documentation changes

Add a hint box explaining dsh config show-shm can be used to see the configuration of your selected context's SHM.