[SSL] Recommend update/renew instead of delete-and-reupload for custom certificates#31645
[SSL] Recommend update/renew instead of delete-and-reupload for custom certificates#31645ngayerie wants to merge 1 commit into
Conversation
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
ask-bonk
Bot
added
documentation
![ask-bonk[bot]](https://avatars.githubusercontent.com/in/2454580?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary
This is a good documentation improvement. The PR correctly identifies that customers default to delete-and-reupload for custom certificate renewals, which causes downtime and wastes quota slots. Elevating the update/renew path in both the how-to page and the troubleshooting errors is the right fix.
What needs attention before merge
Broken links from heading anchor change
Renaming the heading in changes its auto-generated anchor from to .
You correctly updated the links in Error 1212 and Error 1220, but four other existing links to the old anchor will break once this merges:
| File | Line | Link text / current anchor |
|---|---|---|
| 67 | ||
| 20 | ||
| 18 | ||
| 131 |
Please update these four links to use .
Minor observation (non-blocking)
In (~line 201), the still instructs users to "delete and re-add the certificate" to update the Private Key Restriction setting. This is technically accurate but may feel at odds with the new guidance. Consider adding a brief caution or framing it as an exception.
Once the broken links are fixed, this is good to merge. Nice work.
There was a problem hiding this comment.
Summary
This is a good documentation improvement. The PR correctly identifies that customers default to delete-and-reupload for custom certificate renewals, which causes downtime and wastes quota slots. Elevating the update/renew path in both the how-to page and the troubleshooting errors is the right fix.
What needs attention before merge
Broken links from heading anchor change
Renaming the ## Update an existing custom certificate heading in uploading.mdx changes its auto-generated anchor from #update-an-existing-custom-certificate to #update-or-renew-an-existing-custom-certificate.
You correctly updated the links in Error 1212 and Error 1220, but four other existing links to the old anchor will break once this merges:
| File | Line | Link text / current anchor |
|---|---|---|
src/content/docs/ssl/edge-certificates/custom-certificates/troubleshooting.mdx |
67 | [update your custom certificate](/.../#update-an-existing-custom-certificate) |
src/content/docs/ssl/edge-certificates/custom-certificates/index.mdx |
20 | [Update the certificate](/.../#update-an-existing-custom-certificate) |
src/content/docs/ssl/edge-certificates/custom-certificates/renewing.mdx |
18 | [update](/.../#update-an-existing-custom-certificate) |
src/content/docs/ssl/reference/certificate-rotation.mdx |
131 | [Manage custom certificates](/.../#update-an-existing-custom-certificate) |
Please update these four links to use #update-or-renew-an-existing-custom-certificate.
Minor observation (non-blocking)
In uploading.mdx (~line 201), the :::note still instructs users to "delete and re-add the certificate" to update the Private Key Restriction setting. This is technically accurate but may feel at odds with the new guidance. Consider adding a brief caution or framing it as an exception.
Once the broken links are fixed, this is good to merge. Nice work.
|
I've reviewed PR #31645 and posted a review requesting changes. Here's what I found: Summary of changes Issue flagged — broken internal links
I suggested updating all four to Minor observation Labels applied
(The PR already had Note: A duplicate empty review comment briefly appeared due to shell escaping on my first command attempt. The complete review is posted correctly and actionable. |
…ificates Customers often delete and re-upload custom certificates when renewing, which causes downtime and unnecessarily consumes quota slots. The PATCH (update) path is the recommended renewal approach but was buried in docs. - Rename 'Update an existing custom certificate' to 'Update or renew an existing custom certificate' and frame it as the recommended renewal path - Error 1212 (quota): point users to update path first, warn about downtime when deleting active certificates - Error 1220 (duplicate): point users to update path instead of delete Resolves DEE-3624
ngayerie
force-pushed
the
ngayerie/DEE-3624
branch
from
8cbca18 to
074da75
Compare
Review
Code ReviewThis code review is in beta and may not always be helpful — use your judgment. ✅ No code review issues found. Style Guide ReviewWarnings (2)
CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
ngayerie
changed the title
3 participants
Summary
Customers often delete and re-upload custom certificates when renewing, which causes downtime and unnecessarily consumes quota slots. The PATCH (update) path is the recommended renewal approach but was buried in the docs — error 1212 told customers to "delete some existing certificates" without acknowledging the downtime risk.
Source: SSL/TLS Clarity Report, theme 19
Changes (3 updates across 2 files)
ssl/edge-certificates/custom-certificates/uploading.mdx## Update an existing custom certificate→## Update or renew an existing custom certificateand framed it as the recommended renewal pathssl/edge-certificates/custom-certificates/troubleshooting.mdxssl/edge-certificates/custom-certificates/troubleshooting.mdxStats
2 files changed, +11 insertions, -3 deletions
Resolves DEE-3624