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 15:27:17 UTC
[GitHub] [trafficcontrol] ericholguin opened a new pull request, #6941: Readme improvements
ericholguin opened a new pull request, #6941:
URL: https://github.com/apache/trafficcontrol/pull/6941
<!--
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: #ISSUE
Related: #ISSUE
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.
-->
Minor improvements matching what is displayed in the project site, made accessible here:
- Added project image
- Links to ATC socials (Slack, Twitter, Youtube videos)
- Release badge
- Additional GHA badges with links to their respecting result history
- Links to TO API and TC modules
<!-- **^ 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.
-->
None
## 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. -->
Verify Readme looks good and links work properly
## PR submission checklist
- [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://apache.org/security) for details)
<!--
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] ocket8888 commented on a diff in pull request #6941: Readme improvements
Posted by GitBox <gi...@apache.org>.
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.
-->
-
-
-
-
-
-
-
+# Apache Traffic Control
+
+
+
+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.
+
+[](https://s.apache.org/tc-slack-request)
+[](https://twitter.com/intent/follow?screen_name=trafficctrlcdn)
+[](https://www.youtube.com/channel/UC2zEj6sERinzx8w8uvyRBYg)
+
+[](https://github.com/apache/trafficcontrol/releases)
+
+###### Build Status
Review Comment:
Headings should not skip levels
##########
README.md:
##########
@@ -17,24 +17,58 @@
under the License.
-->
-
-
-
-
-
-
-
+# Apache Traffic Control
+
+
+
+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.
+
+[](https://s.apache.org/tc-slack-request)
+[](https://twitter.com/intent/follow?screen_name=trafficctrlcdn)
+[](https://www.youtube.com/channel/UC2zEj6sERinzx8w8uvyRBYg)
+
+[](https://github.com/apache/trafficcontrol/releases)
+
+###### Build Status
+
+[](https://github.com/apache/trafficcontrol/actions/workflows/ciab.yaml)
[](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
+
+[](https://github.com/apache/trafficcontrol/actions/workflows/weasel.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/go.fmt.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/go.vet.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/codeql.cpp.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/codeql.go.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/codeql.java.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/codeql.javascript.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/codeql.python.yml)
+
+###### Test Status
+
+[](https://github.com/apache/trafficcontrol/actions/workflows/go.unit.tests.yaml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/traffic-ops.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/tp.integration.tests.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/tm.integration.tests.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/tr-ultimate-test-harness.yml)
+[](https://github.com/apache/trafficcontrol/actions/workflows/cache-config-tests.yml)
+[](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
[GitHub] [trafficcontrol] ocket8888 merged pull request #6941: Readme improvements
Posted by GitBox <gi...@apache.org>.
ocket8888 merged PR #6941:
URL: https://github.com/apache/trafficcontrol/pull/6941
--
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] zrhoffman commented on a diff in pull request #6941: Readme improvements
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on code in PR #6941:
URL: https://github.com/apache/trafficcontrol/pull/6941#discussion_r915275139
##########
README.md:
##########
@@ -17,24 +17,58 @@
under the License.
-->
-
-
-
-
-
-
-
+# Apache Traffic Control
+
+
Review Comment:
This is a lot of empty space. The website has [a version of the logo](https://trafficcontrol.apache.org/resources/Traffic-Control-Logo-FINAL-Black-Text.png) ([source](https://github.com/apache/trafficcontrol-website/blob/asf-site/resources/Traffic-Control-Logo-FINAL-Black-Text.png)) that includes the name of the project, too. Should that be used?
--
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] ericholguin commented on a diff in pull request #6941: Readme improvements
Posted by GitBox <gi...@apache.org>.
ericholguin commented on code in PR #6941:
URL: https://github.com/apache/trafficcontrol/pull/6941#discussion_r915278273
##########
README.md:
##########
@@ -17,24 +17,58 @@
under the License.
-->
-
-
-
-
-
-
-
+# Apache Traffic Control
+
+
Review Comment:
Ohh, oops the logo I used only works with the GitHub Dark theme. Will update this
--
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