Conversation
genwhittTTD
left a comment
genwhittTTD
left a comment
There was a problem hiding this comment.
Some copy edits plus please move the section to above the diagram and make it an h3. Thx much.
|
|
||
| | Port Number | Direction | Protocol | Description | | ||
| | ----------- | --------- | -------- | ------ | | ||
| | 80 | Inbound | HTTP | Serves all UID2 APIs, including the healthcheck endpoint `/ops/healthcheck`.<br/>When everything is up and running, the endpoint returns HTTP 200 with a response body of `OK`. For details, see [Running the Health Check](#running-the-health-check). | |
There was a problem hiding this comment.
healthcheck > health check
We use two words in UID2 docs (other than the actual endpoint name of course).
|
|
||
|  | ||
|
|
||
| #### Network Security Group Policy |
There was a problem hiding this comment.
@cYKatherine a key concern is the placement of this new content. In the existing doc there is a heading, https://unifiedid.com/docs/guides/operator-guide-azure-enclave#set-up-the-vpc-network, Set Up the VPC Network, and there is a diagram followed by steps. This new section has been added between the diagram and the steps, which is not correct.
In the AWS doc, which was mentioned in the thread (https://unifiedid.com/docs/guides/operator-guide-aws-marketplace#vpc-chart), it's right before the VPC chart, and at the same heading level. Therefore, for consistency, I think you should move this whole new section to above the "Set Up the VPC Network" heading (line 174 in the existing doc) and made it an h3 (three hashtags) rather than what you have which is an h4. That will be more parallel with the AWS doc.
Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
Co-authored-by: Gen Whitt <107279666+genwhittTTD@users.noreply.github.com>
genwhittTTD
left a comment
genwhittTTD
left a comment
There was a problem hiding this comment.
Hi @cYKatherine . No edits but looking at the output, sorry but I think this is still in the wrong place. It's a separate section which is good... but it's reference information, and it's in the middle of a set of procedure sections.
Looking at the current file, I think that it should be with the intro sections that give people the information they need before they actually get started. I think it should go after this section: https://unifiedid.com/docs/guides/operator-guide-azure-enclave#deployment-environments. And be an h2.
I was trying to make it parallel with AWS but, looking at it, AWS has it in the Prerequisites section which isn't really correct because (I think) it isn't a specific prerequisite, it's reference data, though it's important. But let's not mess with that for now.
If you don't think my suggestion is right, my other suggestion is to put it nearer the end and link to it. But I think the above is best. LMK what you think.
All else is good.
3 participants
No description provided.