From 8ede53fc27d329e9c89f70f76ba8aab14d7d8964 Mon Sep 17 00:00:00 2001 From: Tim Pepper Date: Wed, 24 Jan 2018 16:11:29 -0800 Subject: [PATCH] remove contributors/devel/go-code.md The go-code.md file is mostly redundant relative to contributors/devel/development.md and godep.md, the contributors/guide/coding-conventions.md document and the various now standard and easily searchable k8s external sources of information about the Go language. The redundant links are simply dropped. The moovweg/gvm link is dropped as the project appears stale with no releases in years, many open issues, no commits in a year and shows a build failure in its CI badge. The emptied go-code.md file is retained, leaving a pointer to the new location in its place. Signed-off-by: Tim Pepper --- contributors/devel/go-code.md | 29 ++--------------------------- 1 file changed, 2 insertions(+), 27 deletions(-) diff --git a/contributors/devel/go-code.md b/contributors/devel/go-code.md index 80ffa9d50..4454e400a 100644 --- a/contributors/devel/go-code.md +++ b/contributors/devel/go-code.md @@ -1,28 +1,3 @@ -# Kubernetes Go Tools and Tips - -Kubernetes is one of the largest open source Go projects. Good tooling and a solid understanding of -Go is critical to Kubernetes development. This document provides a collection of resources, tools, -and tips that our developers have found useful. - -## Recommended Reading - -- [Kubernetes Go development environment](development.md#go-development-environment) -- [The Go Spec](https://golang.org/ref/spec) - The Go Programming Language - Specification. -- [Go Tour](https://tour.golang.org/welcome/2) - Official Go tutorial. -- [Effective Go](https://golang.org/doc/effective_go.html) - A good collection of Go advice. -- [Kubernetes Code conventions](coding-conventions.md) - Style guide for Kubernetes code. -- [Three Go Landmines](https://gist.github.com/lavalamp/4bd23295a9f32706a48f) - Surprising behavior in the Go language. These have caused real bugs! - -## Recommended Tools - -- [godep](https://github.com/tools/godep) - Used for Kubernetes dependency management. See also [Kubernetes godep and dependency management](development.md#godep-and-dependency-management). -- [Go Version Manager](https://github.com/moovweb/gvm) - A handy tool for managing Go versions. -- [godepq](https://github.com/google/godepq) - A tool for analyzing go import trees. - -## Go Tips - -- [Godoc bookmarklet](https://gist.github.com/timstclair/c891fb8aeb24d663026371d91dcdb3fc) - Navigate from a github page to the corresponding godoc page. -- Consider making a separate Go tree for each project, which can make overlapping dependency management much easier. Remember to set the `$GOPATH` correctly! Consider [scripting](https://gist.github.com/timstclair/17ca792a20e0d83b06dddef7d77b1ea0) this. -- Emacs users - setup [go-mode](https://github.com/dominikh/go-mode.el). +This document's content has been rolled into https://git.k8s.io/community/contributors/guide/coding-conventions.md +This file is a placeholder to preserve links. Please remove after 3 months or the release of kubernetes 1.10, whichever comes first.