You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2022/04/25 02:56:55 UTC
[GitHub] [trafficcontrol] villajo opened a new pull request, #6777: Documentation fixes
villajo opened a new pull request, #6777:
URL: https://github.com/apache/trafficcontrol/pull/6777
<!--
Thank you for contributing! Please be sure to read our contribution guidelines: https://github.com/apache/trafficcontrol/blob/master/CONTRIBUTING.md
If this closes or relates to an existing issue, please reference it using one of the following:
Closes: N/A
Related: N/A
If this PR fixes a security vulnerability, DO NOT submit! Instead, contact
the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://apache.org/security regarding vulnerability disclosure.
-->
This commit fixes multiple documentation formatting issues in the Traffic Control documentation.
<!-- **^ Add meaningful description above** --><hr/>
## Which Traffic Control components are affected by this PR?
<!-- Please delete all components from this list that are NOT affected by this PR.
Feel free to add the name of a tool or script that is affected but not on the list.
-->
- Documentation
## What is the best way to verify this PR?
<!-- Please include here ALL the steps necessary to test your PR.
If your PR has tests (and most should), provide the steps needed to run the tests.
If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
N/A -- Will edit once I have more guidance.
## PR submission checklist
This is documentation. I do not believe that it fits the criteria of having a checklist at this time. (Though I could be wrong)
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
--
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
[GitHub] [trafficcontrol] villajo commented on pull request #6777: Documentation fixes
Posted by GitBox <gi...@apache.org>.
villajo commented on PR #6777:
URL: https://github.com/apache/trafficcontrol/pull/6777#issuecomment-1109199116
Please review changes. Thank you!
--
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
[GitHub] [trafficcontrol] ocket8888 merged pull request #6777: Documentation fixes
Posted by GitBox <gi...@apache.org>.
ocket8888 merged PR #6777:
URL: https://github.com/apache/trafficcontrol/pull/6777
--
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
[GitHub] [trafficcontrol] villajo commented on a diff in pull request #6777: Documentation fixes
Posted by GitBox <gi...@apache.org>.
villajo commented on code in PR #6777:
URL: https://github.com/apache/trafficcontrol/pull/6777#discussion_r858145047
##########
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:
This should be fixed. I tested as well.
--
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
[GitHub] [trafficcontrol] villajo commented on a diff in pull request #6777: Documentation fixes
Posted by GitBox <gi...@apache.org>.
villajo commented on code in PR #6777:
URL: https://github.com/apache/trafficcontrol/pull/6777#discussion_r858140458
##########
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:
I believe this should be fixed now. Thank you for the explanation.
--
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
[GitHub] [trafficcontrol] villajo commented on a diff in pull request #6777: Documentation fixes
Posted by GitBox <gi...@apache.org>.
villajo commented on code in PR #6777:
URL: https://github.com/apache/trafficcontrol/pull/6777#discussion_r858146412
##########
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:
Should be fixed now. Tested.
--
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
[GitHub] [trafficcontrol] villajo commented on a diff in pull request #6777: Documentation fixes
Posted by GitBox <gi...@apache.org>.
villajo commented on code in PR #6777:
URL: https://github.com/apache/trafficcontrol/pull/6777#discussion_r858140029
##########
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:
Fixed.
--
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
[GitHub] [trafficcontrol] ocket8888 commented on a diff in pull request #6777: Documentation fixes
Posted by 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