(#426) Add Common Errors page #1240
Conversation
| order: 50 | ||
| xref: ccr-common-errors | ||
| title: Common Errors Encountered | ||
| description: descriptiono |
There was a problem hiding this comment.
This doesn't feel like it was completed.
There was a problem hiding this comment.
That would be accurate. I was trying to get a preview up and it didn't like that I left the description blank 😂 I'll get this fixed up.
| import Iframe from '@choco-astro/components/Iframe.astro'; | ||
| import Xref from '@components/Xref.astro'; | ||
|
|
||
| ## You've pushed a package, but got an error? |
There was a problem hiding this comment.
This doesn't feel like a question. Perhaps
| ## You've pushed a package, but got an error? | |
| ## Have you pushed a package and got an error? |
|
|
||
| ## Error 400 Bad Request | ||
|
|
||
| Can occur if the API Key is not a validly formatted GUID, or the package you've attempted to push contains a non-normalized version number. |
There was a problem hiding this comment.
| Can occur if the API Key is not a validly formatted GUID, or the package you've attempted to push contains a non-normalized version number. | |
| Can occur if the API Key is not a correctly formatted GUID, or the package you've attempted to push contains a non-normalized version number. |
| ## Error 500 Internal Server Error | ||
|
|
||
| If you receive a `500 Internal Server Error` when pushing a package, you may have a malformed package that the server was unable to process. | ||
| One such case is documented in a [GitHub issue](https://github.com/chocolatey/home/issues/303). |
There was a problem hiding this comment.
| One such case is documented in a [GitHub issue](https://github.com/chocolatey/home/issues/303). | |
| One such case is documented in this [GitHub issue](https://github.com/chocolatey/home/issues/303). |
|
@st3phhays since there is a new page getting added here, can I get you to have a look over this PR as well, just to make sure that nothing jumps out at you. Thanks! |
| --- | ||
| order: 50 | ||
| xref: ccr-common-errors | ||
| title: Common Errors Encountered |
There was a problem hiding this comment.
I noticed in other parts of our docs, we say "Common Errors and Resolutions". Would this be a better name for this page?
There was a problem hiding this comment.
I'm not sure we provide many resolutions here, but more than happy to use it for consistency, and we can always add more resolutions in the future.
3 participants
Description Of Changes
This adds a Common Errors page for CCR documentation.
Motivation and Context
Document the known HTTP error responses from CCR to help users identify reasons for push failures.
Testing
Change Types Made
Change Checklist
Related Issue
Fixes #426