-
-
Notifications
You must be signed in to change notification settings - Fork 142
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update troubleshooting guide, add .editorconfig (#60)
- Loading branch information
Showing
3 changed files
with
36 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
root = true | ||
|
||
[*] | ||
end_of_line = lf | ||
indent_style = space | ||
insert_final_newline = true | ||
trim_trailing_whitespace = true | ||
|
||
[*.rs] | ||
indent_size = 4 | ||
|
||
[*.html] | ||
indent_size = 2 | ||
|
||
[*.yml] | ||
indent_size = 2 | ||
|
||
[Makefile] | ||
indent_style = tab |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,26 @@ | ||
# Toubleshooting Guide | ||
# Troubleshooting Guide | ||
|
||
This document describes common edge-cases and workarounds for checking links to various sites. | ||
Please add your own findings and send us a pull request if you can. | ||
This document describes common edge-cases and workarounds for checking links to various sites. \ | ||
Please add your own findings and send us a pull request if you can. | ||
|
||
## Unexpected Status Codes | ||
|
||
Some websites don't respond with a `200` (OK) status code. | ||
Instead they might send `204` (No Content), `206` (Partial Content), or | ||
Some websites don't respond with a `200` (OK) status code. \ | ||
Instead they might send `204` (No Content), `206` (Partial Content), or | ||
[something else entirely](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/418). | ||
|
||
If you run into such issues you can work around that by providing a custom | ||
If you run into such issues you can work around that by providing a custom \ | ||
list of accepted status codes, such as `--accept 200,204,206`. | ||
|
||
## Website Expects Custom Headers | ||
|
||
Some sites expect one or more custom headers to return a valid response. | ||
For example, crates.io expects a `Accept: text/html` header or else it | ||
will [return a 404](https://github.com/rust-lang/crates.io/issues/788). | ||
Some sites expect one or more custom headers to return a valid response. \ | ||
For example, crates.io expects a `Accept: text/html` header or else it \ | ||
will [return a 404](https://github.com/rust-lang/crates.io/issues/788). | ||
|
||
To fix that you can pass additional headers like so: `--headers "accept=text/html"`. | ||
You can use that argument multiple times to add more headers. | ||
To fix that you can pass additional headers like so: `--headers "accept=text/html"`. \ | ||
You can use that argument multiple times to add more headers. \ | ||
Or, you can accept all content/MIME types: `--headers "accept=*/*"`. | ||
|
||
See more info about the Accept header | ||
[over at MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept). |