From f78d50c6e5714ddea000be621216c76fb8f77a33 Mon Sep 17 00:00:00 2001 From: Andrew Gerrand Date: Mon, 5 Mar 2012 14:31:27 +1100 Subject: [PATCH] doc: clean up docs page, refer to wiki, change install doc paths R=golang-dev, minux.ma, r CC=golang-dev https://golang.org/cl/5728051 --- doc/articles/wiki/index.html | 6 +- doc/articles/wiki/wiki.html | 6 +- doc/contribute.html | 2 +- doc/docs.html | 168 ++++++++++++----------------------- doc/gccgo_contribute.html | 6 +- doc/gccgo_install.html | 6 +- doc/install-source.html | 6 +- doc/install.html | 10 +-- 8 files changed, 77 insertions(+), 133 deletions(-) diff --git a/doc/articles/wiki/index.html b/doc/articles/wiki/index.html index e0e41cd609..99ff3a7c9d 100644 --- a/doc/articles/wiki/index.html +++ b/doc/articles/wiki/index.html @@ -32,7 +32,7 @@ We will use $ to represent the command prompt.

-Install Go (see the Installation Instructions). +Install Go (see the Installation Instructions).

@@ -177,7 +177,7 @@ func loadPage(title string) (*Page, error) { Callers of this function can now check the second parameter; if it is nil then it has successfully loaded a Page. If not, it will be an error that can be handled by the caller (see the -language specification for details). +language specification for details).

@@ -842,7 +842,7 @@ func saveHandler(w http.ResponseWriter, r *http.Request) { Catching the error condition in each handler introduces a lot of repeated code. What if we could wrap each of the handlers in a function that does this validation and error checking? Go's -function +function literals provide a powerful means of abstracting functionality that can help us here.

diff --git a/doc/articles/wiki/wiki.html b/doc/articles/wiki/wiki.html index 284d6d701f..10e1e4fe49 100644 --- a/doc/articles/wiki/wiki.html +++ b/doc/articles/wiki/wiki.html @@ -32,7 +32,7 @@ We will use $ to represent the command prompt.

-Install Go (see the Installation Instructions). +Install Go (see the Installation Instructions).

@@ -160,7 +160,7 @@ function to return *Page and error. Callers of this function can now check the second parameter; if it is nil then it has successfully loaded a Page. If not, it will be an error that can be handled by the caller (see the -language specification for details). +language specification for details).

@@ -655,7 +655,7 @@ Let's put a call to getTitle in each of the handlers: Catching the error condition in each handler introduces a lot of repeated code. What if we could wrap each of the handlers in a function that does this validation and error checking? Go's -function +function literals provide a powerful means of abstracting functionality that can help us here.

diff --git a/doc/contribute.html b/doc/contribute.html index 5af9af48e5..73233c5880 100644 --- a/doc/contribute.html +++ b/doc/contribute.html @@ -7,7 +7,7 @@

This document explains how to contribute changes to the Go project. It assumes you have installed Go using the -installation instructions and +installation instructions and have written and tested your code. (Note that the gccgo frontend lives elsewhere; see Contributing to gccgo.) diff --git a/doc/docs.html b/doc/docs.html index 449e233ad1..a820e35cb7 100644 --- a/doc/docs.html +++ b/doc/docs.html @@ -20,6 +20,15 @@ interpreted language.

+

Installing Go

+ +

Getting Started

+

+Instructions for downloading and installing the Go compilers, tools, and +libraries. +

+ +

Learning Go

A Tour of Go

@@ -32,6 +41,12 @@ learned. You can take the tour online or install it locally.

+

How to write Go code

+

+How to use the go command to fetch, build, and install +packages, commands, and run tests. +

+

Effective Go

A document that gives tips for writing clear, idiomatic Go code. @@ -39,11 +54,6 @@ A must read for any new Go programmer. It augments the tour and the language specification, both of which should be read first.

-

How to write Go code

-

-How to write a new package and how to test code. -

-

Getting Started with Go on App Engine

How to develop and deploy a simple Go project with @@ -55,15 +65,15 @@ How to develop and deploy a simple Go project with Answers to common questions about Go.

-

Other introductory articles

- - +

Go Language Community Wiki

+

A wiki full of useful information maintained by the Go community.

Go Articles

+

The Go Blog

+

The official blog of the Go project, featuring news and in-depth articles by +the Go team and guests.

+

Codewalks

Guided tours of Go programs. @@ -72,6 +82,7 @@ Guided tours of Go programs.

  • First-Class Functions in Go
  • Generating arbitrary text: a Markov chain algorithm
  • Share Memory by Communicating
    • +
  • Writing Web Applications - building a simple web application.

    • Language

    @@ -104,9 +115,15 @@ Guided tours of Go programs.
  • Profiling Go Programs
    • -

    Videos and Talks

    +

    Talks

    -

    Writing Web Apps in Go

    +

    +The talks marked with a red asterisk (*) were written +before Go 1 and contain some examples that are no longer correct, but they are +still of value. +

    + +

    Writing Web Apps in Go*

    A talk by Rob Pike and Andrew Gerrand presented at Google I/O 2011. It walks through the construction and deployment of a simple web application @@ -114,7 +131,7 @@ and unveils the presentation slides.

    -

    Real World Go

    +

    Real World Go*

    A talk by Andrew Gerrand presented at Google I/O Bootcamp 2011. It gives a broad overview of Go's type system and concurrency model @@ -122,7 +139,14 @@ and provides four examples of Go programs that solve real problems. See the presentation slides.

    -

    Go Programming

    +

    Building Integrated Apps on Google's Cloud Platform

    +

    +A talk by Andrew Gerrand presented at Google Developer Day Japan 2011. +It discusses the development of a web application that runs on Google +App Engine and renders images that it stores on Google Cloud Storage. +

    + +

    Go Programming*

    A presentation delivered by Rob Pike and Russ Cox at Google I/O 2010. It illustrates how programming in Go differs from other languages through a set of @@ -130,7 +154,7 @@ examples demonstrating features particular to Go. These include concurrency, embedded types, methods on any type, and program construction using interfaces.

    -

    Practical Go Programming

    +

    Practical Go Programming*

    This talk presents the development of a complete web application in Go. It looks at design, storage, concurrency, and scaling issues in detail, using @@ -138,118 +162,38 @@ the simple example of an URL shortening service. See the presentation slides.

    -

    The Go Tech Talk

    -

    -An hour-long talk delivered by Rob Pike at Google in October 2009. -The language's first public introduction. (See the slides in PDF format.) The language has changed since it was made, -but it's still a good introduction. -

    - -

    The Expressiveness Of Go

    -

    -A discussion of the qualities that make Go an expressive and comprehensible -language. The talk was presented by Rob Pike at JAOO 2010. -The recording of the event was lost due to a hardware error. -

    - -

    Another Go at Language Design

    -

    -A tour, with some background, of the major features of Go, intended for -an audience new to the language. The talk was presented at OSCON 2010. -See the presentation slides. -

    -

    -This talk was also delivered at Sydney University in September 2010. A video -of the lecture is available -here. -

    - -

    Go Emerging Languages Conference Talk

    +

    More

    -Rob Pike's Emerging Languages Conference presentation delivered in July 2010. See the presentation slides. Abstract: +See the GoTalks +page at the Go Wiki for +more Go talks.

    -

    -Go’s approach to concurrency differs from that of many languages, even those -(such as Erlang) that make concurrency central, yet it has deep roots. The path -from Hoare’s 1978 paper to Go provides insight into how and why Go works as it -does. -

    -

    The Go frontend for GCC

    -

    -A description of the Go language frontend for gcc. -Ian Lance Taylor's paper delivered at the GCC Summit 2010. -

    +

    Non-English Documentation

    -

    The Go Promo Video

    -A short promotional video featuring Russ Cox demonstrating Go's fast compiler. +See the NonEnglish page +at the Go Wiki for localized +documentation.

    -

    The Go Community

    +

    The Go Community

    Go Nuts Mailing List

    The golang-nuts mailing list is for general Go discussion.

    -

    Go Packages Dashboard

    -

    A list of the most popular goinstall'd -Go libraries.

    - -

    Go Project Dashboard

    +

    Go Project Dashboard

    A list of external Go projects including programs and libraries.

    +

    Go Language Community Wiki

    +

    A wiki full of useful information maintained by the Go community.

    +

    Go IRC Channel

    #go-nuts on irc.freenode.net is the official Go IRC channel.

    +

    The Go Programming Language at Google+

    +

    The Go project's Google+ page.

    +

    @go_nuts at Twitter

    The Go project's official Twitter account.

    - -

    Non-English Documentation

    - -

    Belarusian — Беларуская

    - - - -

    Chinese — 中文

    - - - -

    Czech — ČeÅ¡tina

    - - - -

    French — Français

    - - - -

    German — Deutsch

    - - - -

    Japanese — 日本語

    - - -

    Korean — 한국어

    - diff --git a/doc/gccgo_contribute.html b/doc/gccgo_contribute.html index e3f6bf470a..8ca13e4ef8 100644 --- a/doc/gccgo_contribute.html +++ b/doc/gccgo_contribute.html @@ -7,15 +7,15 @@

    These are some notes on contributing to the gccgo frontend for GCC. For information on contributing to parts of Go other than gccgo, -see Contributing to the Go project. For +see Contributing to the Go project. For information on building gccgo for yourself, -see Setting up and using gccgo. +see Setting up and using gccgo.

    Legal Prerequisites

    -You must follow the Go copyright +You must follow the Go copyright rules for all changes to the gccgo frontend and the associated libgo library. Code that is part of GCC rather than gccgo must follow the general GCC diff --git a/doc/gccgo_install.html b/doc/gccgo_install.html index d5fff7bf9e..ae359437a6 100644 --- a/doc/gccgo_install.html +++ b/doc/gccgo_install.html @@ -1,6 +1,6 @@

    @@ -15,7 +15,7 @@ License.

    Note that gccgo is not the 6g compiler; see -the Installing Go instructions for that +the Installing Go instructions for that compiler.

    @@ -34,7 +34,7 @@ repository: svn://gcc.gnu.org/svn/gcc/branches/gccgo. Note that although gcc.gnu.org is the most convenient way to get the source code for the compiler, that is not where the master sources live. If you want to contribute changes to the gccgo -compiler, see Contributing to +compiler, see Contributing to gccgo.

    diff --git a/doc/install-source.html b/doc/install-source.html index 21cda8a65b..5a17844b29 100644 --- a/doc/install-source.html +++ b/doc/install-source.html @@ -1,6 +1,6 @@

    Introduction

    @@ -15,7 +15,7 @@ build them on your own machine, and run them.

    Most users don't need to do this, and will instead install from precompiled binary packages as described in -Getting Started, +Getting Started, a much simpler process. If you want to help develop what goes into those precompiled packages, though, read on. @@ -29,7 +29,7 @@ This document focuses on the gc Go compiler and tools (6g, 8g etc.). For information on how to work on gccgo, a more traditional compiler using the GCC back end, see -Setting up and using gccgo. +Setting up and using gccgo.

    diff --git a/doc/install.html b/doc/install.html index 217b52a0e6..4f2bb1c994 100644 --- a/doc/install.html +++ b/doc/install.html @@ -1,6 +1,6 @@

    Introduction

    @@ -19,9 +19,9 @@ compiler.

    For information about installing the gc compiler from source, see -Installing Go from source. +Installing Go from source. For information about installing gccgo, see -Setting up and using gccgo. +Setting up and using gccgo.

    Obtaining the Go tools

    @@ -43,8 +43,8 @@ x86 processor architectures.

    If a binary distribution is not available for your OS/arch combination you may want to try -installing from source or -installing gccgo instead of gc. +installing from source or +installing gccgo instead of gc.

    Installing the Go tools

    -- 2.50.0