[GitHub] ocket8888 opened a new pull request #3133: Added documentation guidelines

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

ocket8888 opened a new pull request #3133: Added documentation guidelines
URL: https://github.com/apache/trafficcontrol/pull/3133
 
 
   ## What does this PR do?
   Adds documentation guidelines as per the mailing list discussion. Also fixed a label that was in conflict with said guidelines, provided cursor hints for abbreviations and removed a warning about building the docs with Python 3.7+ (related bug is now fixed).
   
   ## 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?
   Build the documentation and read the guidelines to be sure they make sense and provide tangible quality of life benefits.
   
   ## 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/)
   
   
   
   

----------------------------------------------------------------
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