Merge pull request kubernetes#11400 from lavalamp/munger

bgrant0607 · bgrant0607 · commit 786b59427d2e · 2015-07-16T22:50:14.000-07:00
Add absolute path link checking to munger
diff --git a/cmd/mungedocs/links.go b/cmd/mungedocs/links.go
@@ -63,8 +63,8 @@ func checkLinks(filePath string, fileBytes []byte) ([]byte, error) {
 			return in
 		}
 
-		if u.Host != "" {
-			// We only care about relative links.
+		if u.Host != "" && u.Host != "github.com" {
+			// We only care about relative links and links within github.
 			return in
 		}
 
@@ -78,6 +78,14 @@ func checkLinks(filePath string, fileBytes []byte) ([]byte, error) {
 				)
 			}
 			u.Path = newPath
+			if strings.HasPrefix(u.Path, "/") {
+				u.Host = "github.com"
+				u.Scheme = "https"
+			} else {
+				// Remove host and scheme from relative paths
+				u.Host = ""
+				u.Scheme = ""
+			}
 			// Make the visible text show the absolute path if it's
 			// not nested in or beneath the current directory.
 			if strings.HasPrefix(u.Path, "..") {
@@ -95,7 +103,7 @@ func checkLinks(filePath string, fileBytes []byte) ([]byte, error) {
 		}
 		// If the current visible text is trying to be a file name, use
 		// the correct file name.
-		if (strings.Contains(visibleText, ".md") || strings.Contains(visibleText, "/")) && !strings.ContainsAny(visibleText, ` '"`+"`") {
+		if strings.HasSuffix(visibleText, ".md") && !strings.ContainsAny(visibleText, ` '"`+"`") {
 			visibleText = suggestedVisibleText
 		}
 
@@ -129,13 +137,25 @@ func cleanPath(dirPath, linkPath string) string {
 
 func checkPath(filePath, linkPath string) (newPath string, ok bool) {
 	dir := path.Dir(filePath)
-	if strings.HasPrefix(linkPath, "/") {
-		if !strings.HasPrefix(linkPath, "/GoogleCloudPlatform") {
-			// Any absolute paths that aren't relative to github.com are wrong.
-			// Try to fix.
-			linkPath = linkPath[1:]
+	absFilePrefixes := []string{
+		"/GoogleCloudPlatform/kubernetes/blob/master/",
+		"/GoogleCloudPlatform/kubernetes/tree/master/",
+	}
+	for _, prefix := range absFilePrefixes {
+		if strings.HasPrefix(linkPath, prefix) {
+			linkPath = strings.TrimPrefix(linkPath, prefix)
+			// Now linkPath is relative to the root of the repo. The below
+			// loop that adds ../ at the beginning of the path should find
+			// the right path.
+			break
 		}
 	}
+	if strings.HasPrefix(linkPath, "/") {
+		// These links might go to e.g. the github issues page, or a
+		// file at a particular revision, or another github project
+		// entirely.
+		return linkPath, true
+	}
 	linkPath = cleanPath(dir, linkPath)
 
 	// Fast exit if the link is already correct.
@@ -174,7 +194,7 @@ func checkPath(filePath, linkPath string) (newPath string, ok bool) {
 					if info.IsDir() {
 						return newPath + "/", true
 					}
-					return newPath, true
+					return cleanPath(dir, newPath), true
 				}
 				newPath = path.Join("..", newPath)
 			}
diff --git a/docs/admin/accessing-the-api.md b/docs/admin/accessing-the-api.md
@@ -89,8 +89,7 @@ variety of uses cases:
    - Scheduler and Controller-manager will use the Secure Port too.  They
      will then be able to run on different machines than the apiserver.
    - A general mechanism will be provided for [giving credentials to
-     pods](
-     https://github.com/GoogleCloudPlatform/kubernetes/issues/1907).
+     pods](https://github.com/GoogleCloudPlatform/kubernetes/issues/1907).
    - Clients, like kubectl, will all support token-based auth, and the
      Localhost will no longer be needed, and will not be the default.
      However, the localhost port may continue to be an option for
diff --git a/docs/admin/cluster-large.md b/docs/admin/cluster-large.md
@@ -23,11 +23,11 @@ certainly want the docs that go with that version.</h1>
 # Kubernetes Large Cluster
 
 ## Support
-At v1.0, Kubernetes supports clusters up to 100 nodes with 30-50 pods per node and 1-2 container per pod (as defined in the [1.0 roadmap](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/roadmap.md#reliability-and-performance)).
+At v1.0, Kubernetes supports clusters up to 100 nodes with 30-50 pods per node and 1-2 container per pod (as defined in the [1.0 roadmap](../../docs/roadmap.md#reliability-and-performance)).
 
 ## Setup
 
-Normally the number of nodes in a cluster is controlled by the the value `NUM_MINIONS` in the platform-specific `config-default.sh` file (for example, see [GCE's `config-default.sh`](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/cluster/gce/config-default.sh)).
+Normally the number of nodes in a cluster is controlled by the the value `NUM_MINIONS` in the platform-specific `config-default.sh` file (for example, see [GCE's `config-default.sh`](../../cluster/gce/config-default.sh)).
 
 Simply changing that value to something very large, however, may cause the setup script to fail for many cloud providers. A GCE deployment, for example, will run in to quota issues and fail to bring the cluster up.
 
@@ -49,7 +49,7 @@ To avoid running into cloud provider quota issues, when creating a cluster with
 * Gating the setup script so that it brings up new node VMs in smaller batches with waits in between, because some cloud providers limit the number of VMs you can create during a given period.
 
 ### Addon Resources
-To prevent memory leaks or other resource issues in [cluster addons](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/cluster/addons/) from consuming all the resources available on a node, Kubernetes sets resource limits on addon containers to limit the CPU and Memory resources they can consume (See PR [#10653](https://github.com/GoogleCloudPlatform/kubernetes/pull/10653/files) and [#10778](https://github.com/GoogleCloudPlatform/kubernetes/pull/10778/files)).
+To prevent memory leaks or other resource issues in [cluster addons](../../cluster/addons/) from consuming all the resources available on a node, Kubernetes sets resource limits on addon containers to limit the CPU and Memory resources they can consume (See PR [#10653](https://github.com/GoogleCloudPlatform/kubernetes/pull/10653/files) and [#10778](https://github.com/GoogleCloudPlatform/kubernetes/pull/10778/files)).
 
 For example:
 ```YAML
diff --git a/docs/admin/high-availability.md b/docs/admin/high-availability.md
@@ -35,7 +35,7 @@ certainly want the docs that go with that version.</h1>
 ## Introduction
 This document describes how to build a high-availability (HA) Kubernetes cluster.  This is a fairly advanced topic.
 Users who merely want to experiment with Kubernetes are encouraged to use configurations that are simpler to set up such as
-the simple [Docker based single node cluster instructions](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/getting-started-guides/docker.md),
+the simple [Docker based single node cluster instructions](../../docs/getting-started-guides/docker.md),
 or try [Google Container Engine](https://cloud.google.com/container-engine/) for hosted Kubernetes.
 
 Also, at this time high availability support for Kubernetes is not continuously tested in our end-to-end (e2e) testing.  We will
diff --git a/docs/design/event_compression.md b/docs/design/event_compression.md
@@ -35,7 +35,7 @@ Each binary that generates events (for example, ```kubelet```) should keep track
 Event compression should be best effort (not guaranteed). Meaning, in the worst case, ```n``` identical (minus timestamp) events may still result in ```n``` event entries.
 
 ## Design
-Instead of a single Timestamp, each event object [contains](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/pkg/api/types.go#L1111) the following fields:
+Instead of a single Timestamp, each event object [contains](../../pkg/api/types.go#L1111) the following fields:
  * ```FirstTimestamp util.Time``` 
    * The date/time of the first occurrence of the event.
  * ```LastTimestamp util.Time```
@@ -47,7 +47,7 @@ Instead of a single Timestamp, each event object [contains](https://github.com/G
 
 Each binary that generates events:
  * Maintains a historical record of previously generated events:
-   * Implemented with ["Least Recently Used Cache"](https://github.com/golang/groupcache/blob/master/lru/lru.go) in [```pkg/client/record/events_cache.go```](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/pkg/client/record/events_cache.go).
+   * Implemented with ["Least Recently Used Cache"](https://github.com/golang/groupcache/blob/master/lru/lru.go) in [```pkg/client/record/events_cache.go```](../../pkg/client/record/events_cache.go).
    * The key in the cache is generated from the event object minus timestamps/count/transient fields, specifically the following events fields are used to construct a unique key for an event:
      * ```event.Source.Component```
      * ```event.Source.Host```
@@ -59,7 +59,7 @@ Each binary that generates events:
      * ```event.Reason```
      * ```event.Message```
    * The LRU cache is capped at 4096 events. That means if a component (e.g. kubelet) runs for a long period of time and generates tons of unique events, the previously generated events cache will not grow unchecked in memory. Instead, after 4096 unique events are generated, the oldest events are evicted from the cache.
- * When an event is generated, the previously generated events cache is checked (see [```pkg/client/record/event.go```](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/pkg/client/record/event.go)).
+ * When an event is generated, the previously generated events cache is checked (see [```pkg/client/record/event.go```](../../pkg/client/record/event.go)).
    * If the key for the new event matches the key for a previously generated event (meaning all of the above fields match between the new event and some previously generated event), then the event is considered to be a duplicate and the existing event entry is updated in etcd:
      * The new PUT (update) event API is called to update the existing event entry in etcd with the new last seen timestamp and count.
      * The event is also updated in the previously generated events cache with an incremented count, updated last seen timestamp, name, and new resource version (all required to issue a future event update).
diff --git a/docs/devel/cli-roadmap.md b/docs/devel/cli-roadmap.md
@@ -23,9 +23,9 @@ certainly want the docs that go with that version.</h1>
 # Kubernetes CLI/Configuration Roadmap
 
 See also issues with the following labels:
-* [area/config-deployment](https://github.com/GoogleCloudPlatform/kubernetes/labels/area%2Fconfig-deployment)
-* [component/CLI](https://github.com/GoogleCloudPlatform/kubernetes/labels/component%2FCLI)
-* [component/client](https://github.com/GoogleCloudPlatform/kubernetes/labels/component%2Fclient)
+* [area/app-config-deployment](https://github.com/GoogleCloudPlatform/kubernetes/labels/area/app-config-deployment)
+* [component/CLI](https://github.com/GoogleCloudPlatform/kubernetes/labels/component/CLI)
+* [component/client](https://github.com/GoogleCloudPlatform/kubernetes/labels/component/client)
 
 1. Create services before other objects, or at least before objects that depend upon them. Namespace-relative DNS mitigates this some, but most users are still using service environment variables. [#1768](https://github.com/GoogleCloudPlatform/kubernetes/issues/1768)
 1. Finish rolling update [#1353](https://github.com/GoogleCloudPlatform/kubernetes/issues/1353)
diff --git a/docs/devel/client-libraries.md b/docs/devel/client-libraries.md
@@ -23,7 +23,7 @@ certainly want the docs that go with that version.</h1>
 ## kubernetes API client libraries
 
 ### Supported
-   * [Go](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/pkg/client)
+   * [Go](../../pkg/client/)
 
 ### User Contributed
 *Note: Libraries provided by outside parties are supported by their authors, not the core Kubernetes team*
diff --git a/docs/getting-started-guides/aws.md b/docs/getting-started-guides/aws.md
@@ -50,16 +50,16 @@ export KUBERNETES_PROVIDER=aws; wget -q -O - https://get.k8s.io | bash
 export KUBERNETES_PROVIDER=aws; curl -sS https://get.k8s.io | bash
 ```
 
-NOTE: This script calls [cluster/kube-up.sh](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/cluster/kube-up.sh)
-which in turn calls [cluster/aws/util.sh](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/cluster/aws/util.sh)
-using [cluster/aws/config-default.sh](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/cluster/aws/config-default.sh).
+NOTE: This script calls [cluster/kube-up.sh](../../cluster/kube-up.sh)
+which in turn calls [cluster/aws/util.sh](../../cluster/aws/util.sh)
+using [cluster/aws/config-default.sh](../../cluster/aws/config-default.sh).
 
 This process takes about 5 to 10 minutes. Once the cluster is up, the IP addresses of your master and node(s) will be printed,
 as well as information about the default services running in the cluster (monitoring, logging, dns). User credentials and security
 tokens are written in `~/.kube/kubeconfig`, they will be necessary to use the CLI or the HTTP Basic Auth.
 
 By default, the script will provision a new VPC and a 4 node k8s cluster in us-west-2a (Oregon) with `t2.micro` instances running on Ubuntu.
-You can override the variables defined in [config-default.sh](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/cluster/aws/config-default.sh) to change this behavior as follows:
+You can override the variables defined in [config-default.sh](../../cluster/aws/config-default.sh) to change this behavior as follows:
 
 ```bash
 export KUBE_AWS_ZONE=eu-west-1c
@@ -95,10 +95,10 @@ export PATH=<path/to/kubernetes-directory>/platforms/darwin/amd64:$PATH
 export PATH=<path/to/kubernetes-directory>/platforms/linux/amd64:$PATH
 ```
 
-An up-to-date documentation page for this tool is available here: [kubectl manual](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/kubectl.md)
+An up-to-date documentation page for this tool is available here: [kubectl manual](../../docs/user-guide/kubectl/kubectl.md)
 
 By default, `kubectl` will use the `kubeconfig` file generated during the cluster startup for authenticating against the API.
-For more information, please read [kubeconfig files](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/kubeconfig-file.md)
+For more information, please read [kubeconfig files](../../docs/user-guide/kubeconfig-file.md)
 
 ### Examples
 See [a simple nginx example](../../docs/user-guide/simple-nginx.md) to try out your new cluster.
@@ -116,7 +116,7 @@ cluster/kube-down.sh
 ```
 
 ## Further reading
-Please see the [Kubernetes docs](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/docs) for more details on administering
+Please see the [Kubernetes docs](../../docs/) for more details on administering
 and using a Kubernetes cluster.
 
 
diff --git a/docs/getting-started-guides/cloudstack.md b/docs/getting-started-guides/cloudstack.md
@@ -48,7 +48,7 @@ This [Ansible](http://ansibleworks.com) playbook deploys Kubernetes on a CloudSt
     $ sudo pip install ansible
     $ sudo pip install cs
 
-[_cs_](https://github.com/exoscale/cs) is a python module for the CloudStack API.
+[_cs_](https://github.com/exoscale/cs) is a python module for the CloudStack API.
 
 Set your CloudStack endpoint, API keys and HTTP method used.
 
diff --git a/docs/getting-started-guides/locally.md b/docs/getting-started-guides/locally.md
@@ -150,7 +150,7 @@ hack/local-up-cluster.sh
 One or more of the kubernetes daemons might've crashed. Tail the logs of each in /tmp.
 
 #### The pods fail to connect to the services by host names
-The local-up-cluster.sh script doesn't start a DNS service. Similar situation can be found [here](https://github.com/GoogleCloudPlatform/kubernetes/issues/6667). You can start a manually. Related documents can be found [here](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/cluster/addons/dns#how-do-i-configure-it)
+The local-up-cluster.sh script doesn't start a DNS service. Similar situation can be found [here](https://github.com/GoogleCloudPlatform/kubernetes/issues/6667). You can start a manually. Related documents can be found [here](../../cluster/addons/dns/#how-do-i-configure-it)
 
 
 <!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
diff --git a/docs/getting-started-guides/rackspace.md b/docs/getting-started-guides/rackspace.md
@@ -44,8 +44,8 @@ These scripts should be used to deploy development environments for Kubernetes.
 NOTE: The rackspace scripts do NOT rely on `saltstack` and instead rely on cloud-init for configuration.
 
 The current cluster design is inspired by:
-- [corekube](https://github.com/metral/corekube/)
-- [Angus Lees](https://github.com/anguslees/kube-openstack/)
+- [corekube](https://github.com/metral/corekube)
+- [Angus Lees](https://github.com/anguslees/kube-openstack)
 
 ## Prerequisites
 1. Python2.7
diff --git a/docs/getting-started-guides/scratch.md b/docs/getting-started-guides/scratch.md
@@ -174,8 +174,7 @@ A Kubernetes binary release includes all the Kubernetes binaries as well as the
 You can use a Kubernetes binary release (recommended) or build your Kubernetes binaries following the instructions in the
 [Developer Documentation](../devel/README.md).  Only using a binary release is covered in this guide.
 
-Download the [latest binary release](
-https://github.com/GoogleCloudPlatform/kubernetes/releases/latest) and unzip it.
+Download the [latest binary release](https://github.com/GoogleCloudPlatform/kubernetes/releases/latest) and unzip it.
 Then locate `./kubernetes/server/kubernetes-server-linux-amd64.tar.gz` and unzip *that*.
 Then, within the second set of unzipped files, locate `./kubernetes/server/bin`, which contains
 all the necessary binaries.
@@ -188,8 +187,7 @@ we recommend that you run these as containers, so you need an image to be built.
 You have several choices for Kubernetes images:
 - Use images hosted on Google Container Registry (GCR):
   - e.g `gcr.io/google_containers/kube-apiserver:$TAG`, where `TAG` is the latest
-    release tag, which can be found on the [latest releases page](
-    https://github.com/GoogleCloudPlatform/kubernetes/releases/latest). 
+    release tag, which can be found on the [latest releases page](https://github.com/GoogleCloudPlatform/kubernetes/releases/latest). 
   - Ensure $TAG is the same tag as the release tag you are using for kubelet and kube-proxy.
 - Build your own images.
   - Useful if you are using a private registry.
diff --git a/docs/user-guide/accessing-the-cluster.md b/docs/user-guide/accessing-the-cluster.md
@@ -126,7 +126,7 @@ with future high-availability support.
 
 There are [client libraries](../devel/client-libraries.md) for accessing the API
 from several languages.  The Kubernetes project-supported
-[Go](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/pkg/client)
+[Go](../../pkg/client/)
 client library can use the same [kubeconfig file](kubeconfig-file.md)
 as the kubectl CLI does to locate and authenticate to the apiserver.  
 
diff --git a/docs/user-guide/container-environment.md b/docs/user-guide/container-environment.md
@@ -68,7 +68,7 @@ FOO_SERVICE_HOST=<the host the service is running on>
 FOO_SERVICE_PORT=<the port the service is running on>
 ```
 
-Services have dedicated IP address, and are also surfaced to the container via DNS (If [DNS addon](https://github.com/GoogleCloudPlatform/kubernetes/tree/master/cluster/addons/dns) is enabled).  Of course DNS is still not an enumerable protocol, so we will continue to provide environment variables so that containers can do discovery.
+Services have dedicated IP address, and are also surfaced to the container via DNS (If [DNS addon](../../cluster/addons/dns/) is enabled).  Of course DNS is still not an enumerable protocol, so we will continue to provide environment variables so that containers can do discovery.
 
 ## Container Hooks
 *NB*: Container hooks are under active development, we anticipate adding additional hooks as the Kubernetes container management system evolves.*
diff --git a/docs/user-guide/downward-api/README.md b/docs/user-guide/downward-api/README.md
@@ -23,7 +23,7 @@ certainly want the docs that go with that version.</h1>
 # Downward API example
 
 Following this example, you will create a pod with a containers that consumes the pod's name and
-namespace using the [downward API](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/downward_api.md).
+namespace using the [downward API](../downward-api.md).
 
 ## Step Zero: Prerequisites
 
diff --git a/docs/user-guide/limitrange/README.md b/docs/user-guide/limitrange/README.md
@@ -47,7 +47,7 @@ This example demonstrates how limits can be applied to a Kubernetes namespace to
 min/max resource limits per pod.  In addition, this example demonstrates how you can
 apply default resource limits to pods in the absence of an end-user specified value.
 
-For a detailed description of the Kubernetes resource model, see [Resources](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/resources.md)
+For a detailed description of the Kubernetes resource model, see [Resources](../../../docs/user-guide/compute-resources.md)
 
 Step 0: Prerequisites
 -----------------------------------------
diff --git a/docs/user-guide/secrets/README.md b/docs/user-guide/secrets/README.md
@@ -23,7 +23,7 @@ certainly want the docs that go with that version.</h1>
 # Secrets example
 
 Following this example, you will create a secret and a pod that consumes that secret in a volume.
-You can learn more about secrets [Here](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/secrets.md).
+You can learn more about secrets [Here](../secrets.md).
 
 ## Step Zero: Prerequisites
 
diff --git a/docs/user-guide/services.md b/docs/user-guide/services.md
diff --git a/docs/user-guide/update-demo/README.md b/docs/user-guide/update-demo/README.md
diff --git a/examples/cassandra/README.md b/examples/cassandra/README.md
diff --git a/examples/cluster-dns/README.md b/examples/cluster-dns/README.md
diff --git a/examples/guestbook/README.md b/examples/guestbook/README.md
diff --git a/examples/hazelcast/README.md b/examples/hazelcast/README.md
diff --git a/examples/k8petstore/README.md b/examples/k8petstore/README.md
diff --git a/examples/rethinkdb/README.md b/examples/rethinkdb/README.md
