Better explanation of domain setup

jemrobinson commented 1 week 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 instructions about how to register a domain are very opaque. They also conflate the idea of "I own this domain" with "Entra is allowed to register users with this in their user name".

We should change these to something more user-friendly, e.g.

- "Domain 'mytre.example.org' is not registered
- You need to register 'mytre' with 'example.org'
- Create a new NS record for 'example.org'
- Add the following records ...

:memo: Required documentation changes

JimMadge commented 1 week ago

I'm not sure where this is. Is that part of the documentation or are these messages from the CLI?

jemrobinson commented 5 days ago

The current CLI output around setting up the SHM DNS zone is quite opaque and doesn't explain what to do if you don't already understand DNS. We should fix that CLI output so that it's more clear, but I don't think we need to change the underlying logic.

JimMadge commented 9 hours ago

@jemrobinson could you put links to those lines here?

jemrobinson commented 4 hours ago

It's this function: https://github.com/alan-turing-institute/data-safe-haven/blob/727f43d6f161494b4e132e068e3a7da9873684be/data_safe_haven/external/api/graph_api.py#L1019-L1078

alan-turing-institute / data-safe-haven