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/07/06 21:00:45 UTC
[GitHub] [trafficcontrol] ocket8888 commented on a diff in pull request #6941: Readme improvements

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


##########
README.md:
##########
@@ -17,24 +17,58 @@
     under the License.
 -->
 
-![Build Status](https://github.com/apache/trafficcontrol/workflows/CDN-in-a-Box%20CI/badge.svg)
-![Weasel License Checks](https://github.com/apache/trafficcontrol/workflows/Weasel%20License%20checks/badge.svg)
-![Traffic Ops Integration Tests](https://github.com/apache/trafficcontrol/workflows/Traffic%20Ops%20Go%20client/API%20integration%20tests/badge.svg)
-![Go Unit Tests](https://github.com/apache/trafficcontrol/workflows/Go%20Unit%20Tests/badge.svg)
-![Go Formatting](https://github.com/apache/trafficcontrol/workflows/Go%20Format/badge.svg)
-![TP Integration Tests](https://github.com/apache/trafficcontrol/workflows/TP%20Integration%20Tests/badge.svg)
-![TM Integration Tests](https://github.com/apache/trafficcontrol/workflows/TM%20Integration%20Tests/badge.svg)
+# Apache Traffic Control
+
+![](https://traffic-control-cdn.readthedocs.io/en/latest/_static/ATC-SVG-FULL-WHITE.svg)
+
+Apache Traffic Control allows you to build a large scale content delivery network using open source. Built around Apache Traffic Server as the caching software, Traffic Control implements all the core functions of a modern CDN.
+
+[![Slack](https://img.shields.io/badge/slack-join_%23traffic--control-white.svg?logo=slack&style=social)](https://s.apache.org/tc-slack-request)
+[![Twitter Follow](https://img.shields.io/twitter/follow/trafficctrlcdn?style=social&label=Follow%20@trafficctrlcdn)](https://twitter.com/intent/follow?screen_name=trafficctrlcdn)
+[![Youtube Subscribe](https://img.shields.io/youtube/channel/subscribers/UC2zEj6sERinzx8w8uvyRBYg?style=social&label=Apache%20Traffic%20Control)](https://www.youtube.com/channel/UC2zEj6sERinzx8w8uvyRBYg)
+
+[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/apache/trafficcontrol)](https://github.com/apache/trafficcontrol/releases)
+
+###### Build Status

Review Comment:
   Headings should not skip levels



##########
README.md:
##########
@@ -17,24 +17,58 @@
     under the License.
 -->
 
-![Build Status](https://github.com/apache/trafficcontrol/workflows/CDN-in-a-Box%20CI/badge.svg)
-![Weasel License Checks](https://github.com/apache/trafficcontrol/workflows/Weasel%20License%20checks/badge.svg)
-![Traffic Ops Integration Tests](https://github.com/apache/trafficcontrol/workflows/Traffic%20Ops%20Go%20client/API%20integration%20tests/badge.svg)
-![Go Unit Tests](https://github.com/apache/trafficcontrol/workflows/Go%20Unit%20Tests/badge.svg)
-![Go Formatting](https://github.com/apache/trafficcontrol/workflows/Go%20Format/badge.svg)
-![TP Integration Tests](https://github.com/apache/trafficcontrol/workflows/TP%20Integration%20Tests/badge.svg)
-![TM Integration Tests](https://github.com/apache/trafficcontrol/workflows/TM%20Integration%20Tests/badge.svg)
+# Apache Traffic Control
+
+![](https://traffic-control-cdn.readthedocs.io/en/latest/_static/ATC-SVG-FULL-WHITE.svg)
+
+Apache Traffic Control allows you to build a large scale content delivery network using open source. Built around Apache Traffic Server as the caching software, Traffic Control implements all the core functions of a modern CDN.
+
+[![Slack](https://img.shields.io/badge/slack-join_%23traffic--control-white.svg?logo=slack&style=social)](https://s.apache.org/tc-slack-request)
+[![Twitter Follow](https://img.shields.io/twitter/follow/trafficctrlcdn?style=social&label=Follow%20@trafficctrlcdn)](https://twitter.com/intent/follow?screen_name=trafficctrlcdn)
+[![Youtube Subscribe](https://img.shields.io/youtube/channel/subscribers/UC2zEj6sERinzx8w8uvyRBYg?style=social&label=Apache%20Traffic%20Control)](https://www.youtube.com/channel/UC2zEj6sERinzx8w8uvyRBYg)
+
+[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/apache/trafficcontrol)](https://github.com/apache/trafficcontrol/releases)
+
+###### Build Status
+
+[![Build Status](https://github.com/apache/trafficcontrol/workflows/CDN-in-a-Box%20CI/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/ciab.yaml) 
 [![Documentation Status](https://readthedocs.org/projects/traffic-control-cdn/badge/?version=latest)](http://traffic-control-cdn.readthedocs.io/en/latest/?badge=latest)
 
-# Apache Traffic Control
-Apache Traffic Control is an Open Source implementation of a Content Delivery Network.
+###### Code Status
+
+[![Weasel License Checks](https://github.com/apache/trafficcontrol/workflows/Weasel%20License%20checks/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/weasel.yml) 
+[![Go Formatting](https://github.com/apache/trafficcontrol/workflows/Go%20Format/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/go.fmt.yml) 
+[![Go Vet](https://github.com/apache/trafficcontrol/workflows/Go%20Vet/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/go.vet.yml)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
+[![CodeQL - C++](https://github.com/apache/trafficcontrol/workflows/CodeQL%20-%20C++/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/codeql.cpp.yml)
+[![CodeQL - Go](https://github.com/apache/trafficcontrol/workflows/CodeQL%20-%20Go/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/codeql.go.yml)
+[![CodeQL - Java](https://github.com/apache/trafficcontrol/workflows/CodeQL%20-%20Java/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/codeql.java.yml)
+[![CodeQL - Javascript](https://github.com/apache/trafficcontrol/workflows/CodeQL%20-%20Javascript/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/codeql.javascript.yml)
+[![CodeQL - Python](https://github.com/apache/trafficcontrol/workflows/CodeQL%20-%20Python/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/codeql.python.yml)
+
+###### Test Status
+
+[![Go Unit Tests](https://github.com/apache/trafficcontrol/workflows/Go%20Unit%20Tests/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/go.unit.tests.yaml)
+[![Traffic Ops Integration Tests](https://github.com/apache/trafficcontrol/workflows/Traffic%20Ops%20Go%20client/API%20integration%20tests/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/traffic-ops.yml) 
+[![TP Integration Tests](https://github.com/apache/trafficcontrol/workflows/TP%20Integration%20Tests/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/tp.integration.tests.yml) 
+[![TM Integration Tests](https://github.com/apache/trafficcontrol/workflows/TM%20Integration%20Tests/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/tm.integration.tests.yml) 
+[![TR Ultimate Test Harness](https://github.com/apache/trafficcontrol/workflows/TR%20Ultimate%20Test%20Harness/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/tr-ultimate-test-harness.yml) 
+[![Traffic Control Cache Config integration tests](https://github.com/apache/trafficcontrol/workflows/Traffic%20Control%20Cache%20Config%20integration%20tests/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/cache-config-tests.yml)
+[![Traffic Control Health Client integration tests](https://github.com/apache/trafficcontrol/workflows/Traffic%20Control%20Health%20Client%20integration%20tests/badge.svg)](https://github.com/apache/trafficcontrol/actions/workflows/health-client-tests.yml)
 
 ## Documentation
 * [Intro](http://traffic-control-cdn.readthedocs.io/en/latest/index.html)
 * [CDN Basics](http://traffic-control-cdn.readthedocs.io/en/latest/basics/index.html)
 * [Traffic Control Overview](http://traffic-control-cdn.readthedocs.io/en/latest/overview/index.html)
 * [Administrator's Guide](http://traffic-control-cdn.readthedocs.io/en/latest/admin/index.html)
 * [Developer's Guide](http://traffic-control-cdn.readthedocs.io/en/latest/development/index.html)
+* [Traffic Ops API](https://traffic-control-cdn.readthedocs.io/en/latest/api/index.html)
+
+## Modules

Review Comment:
   I'm not sure "Modules" is the right title for this section. Especially because this project uses Go so much, where people may expect a very specific meaning for that word.
   
   I would go with "Components".



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