You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by ra...@apache.org on 2019/04/11 22:17:09 UTC
[trafficcontrol] branch master updated: Fix dead/incorrect links
and typos in readmes (#3481)
This is an automated email from the ASF dual-hosted git repository.
rawlin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 662b383 Fix dead/incorrect links and typos in readmes (#3481)
662b383 is described below
commit 662b3835cea9e16e96c69ee68fd3805ec44e346f
Author: Daisy Henderson <Da...@comcast.com>
AuthorDate: Thu Apr 11 16:17:04 2019 -0600
Fix dead/incorrect links and typos in readmes (#3481)
* Fix dead/incorrect links and typos in readmes
* Fix download link
* Revise format with PR review suggestions
* Update README.md
* Change links to relative URL
---
README.md | 11 +++++------
traffic_monitor/README.md | 8 +++++++-
traffic_ops/traffic_ops_golang/README.md | 10 +++++-----
traffic_portal/README.md | 2 +-
traffic_server/plugins/astats_over_http/README.md | 2 +-
5 files changed, 19 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index 2127b6c..6cb47f8 100644
--- a/README.md
+++ b/README.md
@@ -30,15 +30,14 @@ Apache Traffic Control is an Open Source implementation of a Content Delivery Ne
##### Releases
* [https://github.com/apache/trafficcontrol/releases](https://github.com/apache/trafficcontrol/releases)
-
+
##### Downloads
-* [http://trafficcontrol.apache.org/downloads/index.html](http://trafficcontrol.apache.org/downloads/index.html)
-
+* [https://www.apache.org/dyn/closer.cgi/trafficcontrol](https://www.apache.org/dyn/closer.cgi/trafficcontrol)
+
#### Questions, Comments, Bugs and More
-* [Frequently Asked Questions](http://traffic-control-cdn.readthedocs.io/en/latest/faq/index.html)
+* [Frequently Asked Questions](https://traffic-control-cdn.readthedocs.io/en/latest/faq.html)
* [Found a bug or file a feature request](https://github.com/apache/trafficcontrol/issues)
* [Subscribe to our users list](mailto:users-subscribe@trafficcontrol.apache.org)
* [Subscribe to our dev list](mailto:dev-subscribe@trafficcontrol.apache.org)
* [Search the email archives](https://lists.apache.org/list.html?dev@trafficcontrol.apache.org)
-* [Check out the wiki](https://github.com/Comcast/traffic_control/wiki) for less formal documentation, design docs and roadmap discussions
-
+* [Check out the wiki](https://cwiki.apache.org/confluence/display/TC/Traffic+Control+Home) for less formal documentation, design docs and roadmap discussions
diff --git a/traffic_monitor/README.md b/traffic_monitor/README.md
index 9f6fe7b..826b91e 100644
--- a/traffic_monitor/README.md
+++ b/traffic_monitor/README.md
@@ -16,5 +16,11 @@
specific language governing permissions and limitations
under the License.
-->
+# Traffic Monitor
-To run: `./build.sh && traffic_monitor --opsCfg ./conf/traffic_ops.cfg -config ./conf/traffic_monitor.cfg`
+To run:
+
+`./build.sh && traffic_monitor --opsCfg ./conf/traffic_ops.cfg -config ./conf/traffic_monitor.cfg`
+
+
+Documentation can be found [here.](https://traffic-control-cdn.readthedocs.io/en/latest/overview/traffic_monitor.html)
diff --git a/traffic_ops/traffic_ops_golang/README.md b/traffic_ops/traffic_ops_golang/README.md
index eaeff26..ac562cb 100644
--- a/traffic_ops/traffic_ops_golang/README.md
+++ b/traffic_ops/traffic_ops_golang/README.md
@@ -27,11 +27,11 @@ To run `traffic_ops_golang` proxy locally the following prerequisites are needed
* Because the Golang proxy is fronting Mojolicious Perl you need to have that service setup and running as well [TO Perl Setup Here](https://github.com/apache/trafficcontrol/blob/master/traffic_ops/INSTALL.md)
-vendoring and building
+Vendoring and Building
=======================================
### vendoring
-We treat `golang.org/x` as apart of the Go compiler so that means that we still vendor application dependencies for stability and reproducible builds. This is a helpful tool for managing dependencies [https://github.com/govend/govend](https://github.com/govend/govend])
+We treat `golang.org/x` as a part of the Go compiler so that means that we still vendor application dependencies for stability and reproducible builds. The [govend](https://github.com/govend/govend) tool is helpful for managing dependencies.
### building
To download the remaining `golang.org/x` dependencies you need to:
@@ -110,7 +110,7 @@ Converting an Endpoint
Perl
----
-If you don't already have an endpoint in mind, open [TrafficOpsRoutes.pm](https://github.com/apache/trafficcontrol/blob/master/traffic_ops/app/lib/TrafficOpsRoutes.pm) and browse the routes. Start with `/api/` routes. We'll be moving others, like config files, but they're a bit more complex. We specifically won't be moving GUI routes (e.g. `/asns`), they'll go away when the new [Portal](https://github.com/apache/trafficcontrol/tree/master/traffic_portal) is done.
+If you don't already have an endpoint in mind, open [TrafficOpsRoutes.pm](../app/lib/TrafficOpsRoutes.pm) and browse the routes. Start with `/api/` routes. We'll be moving others, like config files, but they're a bit more complex. We specifically won't be moving GUI routes (e.g. `/asns`), they'll go away when the new [Portal](https://github.com/apache/trafficcontrol/tree/master/traffic_portal) is done.
After you pick a route, you'll need to look at the code that generates it. For example, if we look at `$r->get("/api/$version/cdns")->over( authenticated => 1, not_ldap => 1 )->to( 'Cdn#index', namespace => $namespace );`, we see it's calling `Cdn#index`, so we look in `app/lib/API/Cdn.pm` at `sub index`.
@@ -125,11 +125,11 @@ Now we need to create the Go endpoint.
#### Getting a "Handle" on Routes
-Open [routes.go](https://github.com/apache/trafficcontrol/blob/master/traffic_ops/traffic_ops_golang/routes.go). Routes are defined in the `Routes` function, of the form `{version, method, path, handler}`. Notice the path can contain variables, of the form `/{var}/`. These variables will be made available to your handler.
+Open [routes.go](./routing/routes.go). Routes are defined in the `Routes` function, of the form `{version, method, path, handler}`. Notice the path can contain variables, of the form `/{var}/`. These variables will be made available to your handler.
#### Creating a Handler
-The first step is to create your handler. For an example, look at `monitoringHandler` in `monitoring.go`. Your handler arguments can be any data available to the router (the config and database, or what you can create from them). Passing the `db` or prepared `Stmt`s is common. The handler function must return a `RegexHandlerFunc`. In general, you want to return an inline function, `return func(w http.ResponseWriter, r *http.Request, p ParamMap) {...`.
+The first step is to create your handler. For an example, look at `monitoringHandler` in `monitoring.go`. Your handler arguments can be any data available to the router (the config and database, or what you can create from them). Passing the `db` or prepared `Stmt`s is common. The handler function must return a `RegexHandlerFunc`. In general, you want to return an inline function, `return func(w http.ResponseWriter, r *http.Request, p ParamMap) {...`.
The `ResponseWriter` and `Request` are standard Go `HandlerFunc` parameters. The `ParamMap` is a `map[string]string`, containing the variables from your route path.
diff --git a/traffic_portal/README.md b/traffic_portal/README.md
index 92d7be6..88e18b8 100644
--- a/traffic_portal/README.md
+++ b/traffic_portal/README.md
@@ -21,4 +21,4 @@
An AngularJS client served from a lightweight Node.js web server. Traffic Portal was designed to consume the Traffic Ops API.
-Installation / configuration instructions are found at https://github.com/apache/trafficcontrol/tree/master/traffic_portal/build
+Installation / configuration instructions may be found in [the `build/` directory](./build/)
diff --git a/traffic_server/plugins/astats_over_http/README.md b/traffic_server/plugins/astats_over_http/README.md
index 122f0be..078a747 100644
--- a/traffic_server/plugins/astats_over_http/README.md
+++ b/traffic_server/plugins/astats_over_http/README.md
@@ -30,6 +30,6 @@ start traffic server and visit http://[ip]:[port]/${path}
Rpm Builds
- Two spec files are provided. astats_over_http.spec requires a tar ball of this directoy
+ Two spec files are provided. astats_over_http.spec requires a tar ball of this directory
named astats_over_htt-.tar.gz is copied to the rpmbuild/SOURCES directory. The second
astats-git-build, checks out the source from the git repo and builds the rpm.