[GitHub] [trafficcontrol] ocket8888 commented on a diff in pull request #6777: Documentation fixes

[GitBox <gi...@apache.org>]

ocket8888 commented on code in PR #6777:
URL: https://github.com/apache/trafficcontrol/pull/6777#discussion_r857970393


##########
docs/source/admin/traffic_server.rst:
##########
@@ -145,7 +145,7 @@ When processing configuration files, if ``traffic_ops_ort`` encounters any of th
 	| ``__SERVER_TCP_PORT__`` | If the :term:`cache server` on which ``t3c`` is being run has a    |
 	|                         | TCP port configured to something besides ``80``, this will be      |
 	|                         | replaced with that TCP port value. *If it* **is** *set to*         |
-	|                         | *``80``, this string will simply be removed,* **NOT** *replaced*   |
+	|                         | ``80``*, this string will simply be removed,* **NOT** *replaced*  |

Review Comment:
   The <kbd>|</kbd>s here need to line up for the table to render properly.



##########
docs/source/admin/traffic_ops.rst:
##########
@@ -682,7 +682,7 @@ You must then take the output file :file:`trafficops.csr` and submit a request t
 	sudo cp trafficops.crt /etc/pki/tls/certs
 	sudo chown trafops:trafops /etc/pki/tls/certs/trafficops.crt
 
-If necessary, install the :abbr:`CA (Certificate Authority) certificate's ``.pem`` and ``.crt`` files in ``/etc/pki/tls/certs``.
+If necessary, install the :abbr:`CA (Certificate Authority) certificate's` ``.pem`` and ``.crt`` files in ``/etc/pki/tls/certs``.

Review Comment:
   The grave accent (<kbd>\`</kbd>) here should go after the `)`.
   
   The syntax for the `:abbr:` text role is
   
   ```rst
   :abbr:`ABBREVIATION (An Expansion of the Abbreviation that Tells You What it Means)`
   ```



##########
docs/source/overview/delivery_services.rst:
##########
@@ -295,7 +295,7 @@ Geo Limit Redirect URL
 If `Geo Limit`_ is being used with this Delivery Service, this is optionally a URL to which clients will be redirected when Traffic Router determines that they are not in a geographic zone that permits their access to the Delivery Service content. This changes the response from Traffic Router from ``503 Service Unavailable`` to ``302 Found`` with a provided location that will be this URL. There is no restriction on the provided URL; it may even be the path to a resource served by this Delivery Service. In fact, this field need not even be a full URL, it can be a relative path. Both of these cases are handled specially by Traffic Router.
 
 - If the provided URL is a resource served by the Delivery Service (e.g. if the client requests ``http://cdn.dsXMLID.somedomain.example.com/index.html`` but are denied access by `Geo Limit`_ and the Geo Limit Redirect URL is something like ``http://cdn.dsXMLID.somedomain.example.com/help.php``), Traffic Router will find an appropriate :term:`Edge-tier cache server` and redirect the client, ignoring Geo Limit restrictions *for this request only*.
-- If the provided "URL" is actually a relative path, it will be considered *relative to the requested Delivery Service :abbr:`FQDN (Fully Qualified Domain Name)`*. This means that e.g. if the client requests ``http://cdn.dsXMLID.somedomain.example.com/index.html`` but are denied access by `Geo Limit`_ and the Geo Limit Redirect URL is something like ``/help.php``, Traffic Router will find an appropriate :term:`Edge-tier cache server` and redirect the client to it as though they had requested ``http://cdn.dsXMLID.somedomain.example.com/help.php``, ignoring `Geo Limit`_ restrictions *for this request only*.
+- If the provided "URL" is actually a relative path, it will be considered *relative to the requested Delivery Service :abbr:`FQDN (Fully Qualified Domain Name)`. This means that e.g. if the client requests ``http://cdn.dsXMLID.somedomain.example.com/index.html`` but are denied access by `Geo Limit`_ and the Geo Limit Redirect URL is something like ``/help.php``, Traffic Router will find an appropriate :term:`Edge-tier cache server` and redirect the client to it as though they had requested ``http://cdn.dsXMLID.somedomain.example.com/help.php``, ignoring `Geo Limit`_ restrictions *for this request only*.

Review Comment:
   This entire paragraph wasn't meant to be italic - in fact there's now an unmatched <kbd>\*</kbd> at the end of the sentence. Rather than removed entirely, that <kbd>\*</kbd> should have been moved up to right after the word "Service".



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org