aboutsummaryrefslogtreecommitdiff
path: root/content/godoc-documenting-go-code.article
Commit message (Collapse)AuthorAge
* content: rename articles to reinforce convention of short URLsRuss Cox2020-03-17
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The Go blog started out on Blogger (http://web.archive.org/web/20100325005843/http://blog.golang.org/). Later, we moved to the current self-hosted blog server with extra Go-specific functionality like playground snippets. The old Blogger posts have very long URLs that Blogger chose for us, such as "go-programming-language-turns-two" or "two-go-talks-lexical-scanning-in-go-and", predating the convention of giving posts shorter, more share-friendly, typeable names. The conversion of the old Blogger posts also predated the convention of putting supporting files in a subdirectory. The result is that although we've established new conventions, you wouldn't know by listing the directory - the old Blogger content presents a conflicting picture. This commit renames the posts with very long names to have shorter, more share-friendly names, and it moves all supporting files to subdirectories. It also adds a README documenting the conventions. For example, blog.golang.org/go-programming-language-turns-two is now blog.golang.org/2years, matching our more recent birthday post URLs, and its supporting files are moved to the new 2years/ directory. The old URLs redirect to the new ones. Change-Id: I9f46a790c2c8fab8459aeda73d4e3d2efc86d88f Reviewed-on: https://go-review.googlesource.com/c/blog/+/223599 Run-TryBot: Russ Cox <rsc@golang.org> Reviewed-by: Andrew Bonventre <andybons@golang.org>
* content: write real summary for each articleRuss Cox2020-03-17
| | | | | | | | | | | | | | | | | | The pre-Markdown blog invented a summary by copying the first paragraph of text. Often this was nonsense or at least useless. The new Markdown-enabled present format adds an explicit Summary line. The conversion populated these with the same first paragraph that the old format would have used implicitly. This commit rewrites them all to be proper short summaries. Change-Id: If2e1e101b95558d7ecd53c613f733a7f89c680f1 Reviewed-on: https://go-review.googlesource.com/c/blog/+/223598 Run-TryBot: Russ Cox <rsc@golang.org> Reviewed-by: Andrew Bonventre <andybons@golang.org>
* content: convert to Markdown-enabled present inputsRuss Cox2020-03-17
| | | | | | | | | | | | Converted blog to Markdown-enabled present (CL 222846) using present2md (CL 222847). For golang/go#33955. Change-Id: Ib39fa1ddd9a46f9c7a62a2ca7b96e117635553e8 Reviewed-on: https://go-review.googlesource.com/c/blog/+/222848 Run-TryBot: Russ Cox <rsc@golang.org> Reviewed-by: Andrew Bonventre <andybons@golang.org>
* content: wrap long lines using new program wrap.goRuss Cox2020-03-11
| | | | | | | | | | | Wrapping long lines will make diffs easier to read for the eventual conversion to Markdown. For golang/go#33955. Change-Id: Ibcc1b5a84ccc9144b5fcdc9266f2da3e2cf3c5a3 Reviewed-on: https://go-review.googlesource.com/c/blog/+/222839 Reviewed-by: Ian Lance Taylor <iant@golang.org>
* content: update all golang.org links to httpsAgniva De Sarker2018-04-13
| | | | | | | | | | Ran sed -i 's/\[\[http:\/\/golang.org/\[\[https:\/\/golang.org/g' *.article Change-Id: I88acc5104e1a3fc5e9a1cf11b600b657202d8997 Reviewed-on: https://go-review.googlesource.com/106955 Run-TryBot: Andrew Bonventre <andybons@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Andrew Bonventre <andybons@golang.org>
* content/godoc-documenting-go-code.article: fix link to deprecated examplesAndrew Bonventre2018-02-22
| | | | | | | | Fixes golang/go#24021 Change-Id: Idfeee853653cb44c4b92dff909dec36843ad6b0e Reviewed-on: https://go-review.googlesource.com/96201 Reviewed-by: Ian Lance Taylor <iant@golang.org>
* content: fix stale links to line numbersAgniva De Sarker2018-01-08
| | | | | | | | | | | | - Changed the links from go1.3 to master. - Removed trailing spaces from several lines. Fixes golang/go#22488 Change-Id: I41748fea956f0329eca0d520134670fa28618657 Reviewed-on: https://go-review.googlesource.com/86095 Reviewed-by: Andrew Bonventre <andybons@golang.org> Reviewed-by: Kevin Burke <kev@inburke.com>
* Fix link to the Bug section of pkg/bytes godocareski2016-10-03
| | | | | | | | Correct link should point to http://golang.org/pkg/bytes/#pkg-note-BUG Change-Id: I6b493fd49f43103c507c3ff61ff1f5b9b780f171 Reviewed-on: https://go-review.googlesource.com/1953 Reviewed-by: Russ Cox <rsc@golang.org>
* content: documented godoc's "Deprecated:" convention in the godoc postAndrew Gerrand2016-01-27
| | | | | | | | Fixes golang/go#10909 Change-Id: Ie2553bc2f6983cbcaf7398366c21dc175e1f5453 Reviewed-on: https://go-review.googlesource.com/18956 Reviewed-by: Rob Pike <r@golang.org>
* content: Remove outdated comment about "package documentation"Matthew Dempsky2013-10-22
| | | | | | | | | | | godoc was changed a while back to look for command documentation in "package main" rather than "package documentation" to be consistent with library package conventions: https://code.google.com/p/go/source/detail?r=3633a89bb56d R=adg CC=golang-dev https://golang.org/cl/15450044
* go.blog: update tagsAndrew Gerrand2013-06-05
| | | | | | | | | | This makes the articles cross-reference each other better. In particular, I added the "technical" tag for in-depth technical posts. R=bradfitz, r CC=golang-dev https://golang.org/cl/9960043
* go.blog: add contentAndrew Gerrand2013-03-08
R=golang-dev, r CC=golang-dev https://golang.org/cl/7436052
Powered by cgit, Themed by Ted Yin.