[GitHub] ocket8888 opened a new pull request #2818: WIP Doc updates

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

ocket8888 opened a new pull request #2818: WIP Doc updates
URL: https://github.com/apache/trafficcontrol/pull/2818
 
 
   #### What does this PR do?
   
   Various documentation changes.
   
   - Tables in reST source will not take up more than 215 characters per line
   - Space indentation will be replaced with tabs
   - Bold-faced terms and phrases followed by block-quoted text will be replaced with definition lists or sections as appropriate
   - Instructions on how to accomplish things with the Traffic Ops API will be replaced with their Traffic Portal equivalents
   - Undocumented API endpoints/parameters will be documented
   - Grammatical, spelling and spacing issues will be rectified
   - Sections requiring further explanation will be expanded upon
   
   One thing I'm *not* planning on is updating any documentation related to the Traffic Ops UI. I'll still adjust the formatting, though.
   
   #### Which TC components are affected by this PR?
   
   - [x] Documentation
   - [ ] Grove
   - [ ] Traffic Analytics
   - [ ] Traffic Monitor
   - [ ] Traffic Ops
   - [ ] Traffic Ops ORT
   - [ ] Traffic Portal
   - [ ] Traffic Router
   - [ ] Traffic Stats
   - [ ] Traffic Vault
   - [ ] Other _________
   
   #### What is the best way to verify this PR?
   
   
   #### Check all that apply
   
   - [ ] This PR includes tests
   - [x] This PR includes documentation updates
   - [ ] This PR includes an update to CHANGELOG.md
   - [ ] This PR includes all required license headers
   - [ ] This PR includes a database migration (ensure that migration sequence is correct)
   - [ ] This PR fixes a serious security flaw. Read more: [www.apache.org/security](http://www.apache.org/security/)
   
   <!--
       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 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