[tor-commits] [manual/develop] Add onion errors, acat suggestions, fix grammar

[gus at torproject.org]

commit cd3417ceeb532a63dd8116789923c4ac8ae81141
Author: gus <gus at torproject.org>
Date:   Fri May 29 00:36:52 2020 -0400

    Add onion errors, acat suggestions, fix grammar
---
 content/onion-services/contents.lr | 51 +++++++++++++++++++++++++++-----------
 1 file changed, 37 insertions(+), 14 deletions(-)

diff --git a/content/onion-services/contents.lr b/content/onion-services/contents.lr
index 109f876..472b192 100644
--- a/content/onion-services/contents.lr
+++ b/content/onion-services/contents.lr
@@ -10,40 +10,63 @@ key: 9
 ---
 body:
 
-Onion services (formerly known as “hidden services”) are services (like websites) that are only accessible through the Tor network.
+Onion services (formerly known as "hidden services") are services (like websites) that are only accessible through the Tor network.
 
 Onion services offer several advantages over ordinary services on the non-private web:
 
-* An onion services’s location and IP address are hidden, making it difficult for adversaries to censor it or identify its operators.
+* Onion services’ location and IP address are hidden, making it difficult for adversaries to censor them or identify their operators.
 * All traffic between Tor users and onion services is end-to-end encrypted, so you do not need to worry about [connecting over HTTPS](/secure-connections).
 * The address of an onion service is automatically generated, so the operators do not need to purchase a domain name; the .onion URL also helps Tor ensure that it is connecting to the right location and that the connection is not being tampered with.
 
 ### HOW TO ACCESS AN ONION SERVICE
 
-Just like any other website, you will need to know the address of an onion service in order to connect to it. An onion address is a string of 16 (and in V3 format, 56) mostly random letters and numbers, followed by “.onion”.
-It's also possible to learn about an onionsite if the website administrator has advertised the onion version by enabling Onion-Location.
-Onion-Location is a new HTTP header that websites can use to advertise their onion counterpart.
-If the website that you're visiting has an onionsite available, a purple suggestion pill will prompt at the URL bar saying ".onion available".
+Just like any other website, you will need to know the address of an onion service in order to connect to it. An onion address is a string of 16 (and in V3 format, 56) mostly random letters and numbers, followed by ".onion".
+
+When accessing a website that uses an onion service, Tor Browser will show in the URL bar an icon of an onion displaying the state of your connection: secure and using an onion service. You can learn more about the onionsite that you are visiting by looking at the Circuit Display.
+
+Another way to learn about an onionsite is if the website administrator has implemented a feature called Onion-Location.
+Onion-Location is a non-standard HTTP header that websites can use to advertise their onion counterpart.
+If the website that you are visiting has an onionsite available, a purple suggestion pill will prompt at the URL bar in Tor Browser displaying ".onion available".
 When you click on ".onion available", the website will be reloaded and redirected to its onion counterpart.
+
+<img class="col-md-6" src="../../static/images/onion-location.png" alt="Onion-Location">
+
 To prioritize an onionsite version of a website, you can enable automatic Onion-Location redirects.
-Click on hamburger menu (≡), go to Preferences (or Options in Windows), click on Privacy & Security, and in Onion Services section check the option "Always".
-Or if you're already running Tor Browser, you can click directly here: [Privacy & Security](about:preferences#privacy).
-When accessing a website that uses an onion service, Tor Browser will show at the URL bar an icon of a little black onion displaying the state of your connection: secure and using an onion service. And if you're accessing a website using https and onion service, it will show an icon of a black onion and the organization's name. You can learn more about the onionsite you are visiting by looking at the Circuit Display.
+Click on hamburger menu (≡), go to Preferences (or Options on Windows), click on Privacy & Security, and in the Onion Services section look for the entry "Prioritize .onion sites when known." and check the option "Always".
+Or, if you're already running Tor Browser, you can copy and paste this string in a new tab: `about:preferences#privacy` and change this setting.
 
-## Onion service authentication
+## ONION SERVICE AUTHENTICATION
 
 An authenticated onion service is a service like an onionsite that requires the client to provide an authentication token before accessing the service.
 As a Tor user, you may authenticate yourself directly in the Tor Browser.
 In order to access this service, you will need access credentials from the onion service operator.
-When accessing an authenticated onion service, Tor Browser will show at the URL bar an icon of a little gray key, accompanied by a tooltip.
+When accessing an authenticated onion service, Tor Browser will show in the URL bar an icon of a little gray key, accompanied by a tooltip.
 Enter your valid private key into the input field.
 
 <img class="col-md-6" src="../../static/images/client-auth.png" alt="Client Authorization">
 
+### ONION SERVICES ERRORS
+
+If you can't connect to an onionsite, Tor Browser will provide a specific error message informing why the website is unavailable. 
+Errors can happen in different layers: client errors, network errors or service errors.
+Some of these errors can be fixed by following the Troubleshooting section.
+The table below shows all the possible errors and which action you should take to solve the issue.
+
+| **Code** | **Error Title** | **Short Description** |
+|----------|-----------------|-----------------------|
+| XF0 | Onionsite Not Found | The most likely cause is that the onionsite is offline or disabled. Contact the onionsite administrator. |
+| XF1 | Onionsite Cannot Be Reached | The onionsite is unreachable due to an internal error. |
+| XF2 | Onionsite Has Disconnected | The most likely cause is that the onionsite is offline or disabled. Contact the onionsite administrator. |
+| XF3 | Unable to Connect to Onionsite | The onionsite is busy or the Tor network is overloaded. Try again later. |
+| XF4 | Onionsite Requires Authentication | Access to the onionsite requires a key but none was provided. |
+| XF5 | Onionsite Authentication Failed | The provided key is incorrect or has been revoked. Contact the onionsite administrator. |
+| XF6 | Invalid Onionsite Address | The provided onionsite address is invalid. Please check that you entered it correctly. |
+| XF7 | Onionsite Circuit Creation Timed Out | Failed to connect to the onionsite, possibly due to a poor network connection. |
+
 ### TROUBLESHOOTING
 
-If you cannot reach the onion service you require, make sure that you have entered the onion address correctly: even a small mistake will stop Tor Browser from being able to reach the site.
+If you cannot reach the onion service you requested, make sure that you have entered the onion address correctly: even a small mistake will stop Tor Browser from being able to reach the site.
 
-If you are still unable to connect to the onion service, please try again later. There may be a temporary connection issue, or the site operators may have allowed it to go offline without warning.
+If you are still unable to connect to the onion service after verifying the address, please try again later. There may be a temporary connection issue, or the site operators may have allowed it to go offline without warning.
 
-You can also ensure that you're able to access other onion services by connecting to [DuckDuckGo's Onion Service](http://3g2upl4pq6kufc4m.onion/).
+You can also test if you are able to access other onion services by connecting to [DuckDuckGo's Onion Service](http://3g2upl4pq6kufc4m.onion/).