[GitHub] [trafficcontrol] ocket8888 opened a new pull request #3545: Delivery Service Overview Documentation

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

ocket8888 opened a new pull request #3545: Delivery Service Overview Documentation
URL: https://github.com/apache/trafficcontrol/pull/3545
 
 
   ## What does this PR (Pull Request) do?
   - [x] This PR closes #3432 
   
   Adds an entire page for Delivery Services to the "Overview" section. Also removes similar information from the TO administration pages that was TO UI-centric. 
   
   Also added the "Origins" section to the TP using section, since the DS docs needed to reference it.
   
   Added documentation for strings treated specially by ORT (was previously covered somewhat incompletely in the TO Using docs - removed)
   
   Adds plural terms to the glossary (you no longer should need to use backslashes to make glossary terms plural)
   
   Added a plugin to the documentation build system that provides the following:
   ```rst
   .. impl-detail:: This is an implementation detail admonition. It's like ``note``, but specifically for implementation details.
   
   :issue:`1` - this creates an inline link to ATC GitHub Issue #1 
   :pr:`1` - this creates an inline link to ATC GitHub Pull Request #1 
   ```
   
   ## Which Traffic Control components are affected by this PR?
   - Documentation
   
   ## What is the best way to verify this PR?
   Build the documentation and read it to verify that it's accurate, grammatically and syntactically correct, thorough, and well-written.
   
   Unit tests for the sphinx plugin would be nice, but the only way to verify it renders properly is to have a human look at it. I've done that, but it can't be automated.
   
   ## If this is a bug fix, what versions of Traffic Ops are affected?
   This would likely break in half if you tried to graft just it onto 3.x
   
   ## The following criteria are ALL met by this PR
   - [x] This PR includes tests OR I have explained why tests are unnecessary
   - [x] This PR includes documentation OR I have explained why documentation is unnecessary
   - [x] This PR includes an update to CHANGELOG.md OR such an update is not necessary
   - [x] This PR includes any and all required license headers
   - [x] This PR ensures that database migration sequence is correct OR this PR does not include a database migration
   - [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY**

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services