Updating BYOIP how to documentation to avoid possible confusion generated from how image was formatted#128621
Conversation
Image example is potentially misleading causing incorrect certificate formatting. While surrounding text is correct the misleading image can cause end users to generate an incorrect ROA with added line breaks.
Removing orphaned image.
|
@DWBatmanPS : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
1 similar comment
|
@DWBatmanPS : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
|
Learn Build status updates of commit ef0f7a4: ✅ Validation status: passed
For more details, please refer to the build report. |
PRMerger Results
|
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates BYOIP “how-to” documentation to reduce confusion caused by certificate formatting in an image by switching to copyable text examples.
Changes:
- Replaced a screenshot of an example certificate with a fenced text code block (in two places).
- Adjusted surrounding guidance to emphasize correct copy/paste formatting.
Comments suppressed due to low confidence (1)
includes/ip-services-custom-ip-prefix-certificate-creation.md:1
- The example certificate is rendered as a single line with the
BEGIN CERTIFICATEheader immediately followed by the base64 payload and footer, which is not valid PEM formatting and could cause users to paste an invalid value into Whois/RDAP. Update the example to show a realistic multi-line PEM (header on its own line, base64 split across lines, footer on its own line), or explicitly state that the base64 body is truncated/illustrative (e.g., with...) to avoid implying that a single-line PEM is acceptable.
---
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -40,7 +40,9 @@ The following steps show the steps required to prepare sample customer range (1. | |||
|
|
|||
| After the public comments are filled out, the Whois/RDAP record should look like the following example. When copying, ensure there aren't spaces, or carriage returns and include all dashes: | |||
|
|
|||
| @@ -92,7 +94,9 @@ The following steps show the steps required to prepare sample customer range (1. | |||
|
|
|||
| After the public comments are filled out, the Whois/RDAP record should look like the following example. Ensure there aren't spaces or carriage returns and include all dashes: | |||
|
|
|||
|
Can you review the proposed changes? Important: When the changes are ready for publication, adding a #label:"aq-pr-triaged" |
prmerger-automator
Bot
added
the
aq-pr-triaged
Looks good to me @mbender-ms |
|
#sign-off |
This pull request updates the documentation in
includes/ip-services-custom-ip-prefix-certificate-creation.mdto improve clarity around how example certificates should be presented. The main change is replacing a screenshot image of an example certificate with a text-based code block, making it easier for users to copy and inspect the certificate data formatting accurately.This PR was generated due to an external customer request as part of a support case with Azure.
Documentation improvements:
certificate-example.png) with a text-based code block containing a sample certificate in two locations, ensuring users can easily copy the certificate without formatting errors. [1] [2]