Conversation
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
github-actions
bot
added
area/hub
|
/review |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Documentation Review
Found a few opportunities to tighten the language and remove hedging words per the style guide. These are minor style improvements - the content is clear and helpful.
✨ Positive notes:
- Helpful addition of deletion latency information
- Good consolidation of the bulk deletion note into the introduction
- Clear explanation of automatic retry behavior
| > [!NOTE] | ||
| > | ||
| > If you would like to delete in bulk, you can use the [deletion API endpoint](/reference/api/registry/latest/#tag/delete). | ||
| > Deletion operations may take some time to complete. In rare cases, you may |
There was a problem hiding this comment.
Hedging language detected
The phrase "In rare cases, you may" uses hedging language. Per STYLE.md, avoid hedge words. Consider:
Deletion operations may take some time to complete. Timeout errors may occur during the deletion process. The system automatically retries the deletion in the background, and the items will be removed without requiring any action from you.
This is more direct while conveying the same information.
|
|
||
| > **Note** | ||
| > | ||
| > Manifest deletion operations may experience latency. In some cases, you may encounter a `500 Internal Server Error` during deletion. The system automatically retries the deletion in the background, so the manifest will eventually be removed. You do not need to manually retry the request. |
There was a problem hiding this comment.
Hedging language detected
The phrase "In some cases, you may" uses hedging language. Per STYLE.md, avoid hedge words. Consider:
Manifest deletion operations may experience latency and could return a
500 Internal Server Errorduring deletion. The system automatically retries the deletion in the background, so the manifest will eventually be removed. You do not need to manually retry the request.
This is more direct and concise.
|
|
||
| > **Note** | ||
| > | ||
| > Manifest deletion operations may take some time to complete. In some cases, you may receive a `500 Internal Server Error` response. If this occurs, the system will automatically retry the deletion in the background. The manifest will be removed without requiring manual intervention or additional requests from your side. |
There was a problem hiding this comment.
Hedging language and verbosity
The phrase "In some cases, you may" uses hedging language, and "without requiring manual intervention or additional requests from your side" is unnecessarily verbose. Per STYLE.md, be concise and avoid hedge words. Consider:
Manifest deletion operations may take some time and could return a
500 Internal Server Error. The system automatically retries the deletion in the background. Manual intervention is not required.
This is more concise and direct.
2 participants
Description
Delete operation may time-out. Hub automatically retries without user interaction in both the UI and API.
Added notes to make the user aware.
Related issues or tickets
ENGDOCS-3173
Reviews