aboutsummaryrefslogtreecommitdiff
path: root/_content/doc/tutorial
AgeCommit message (Collapse)Author
2025-01-06_content/doc/tutorial/fuzz: add note about combining characters in examplewillboland
Currently, the fuzzing tutorial provides a reverse function to use. This led to some confusion on if it is production ready, which it is not. Adds a note that the code does not handle combining characters correctly. Fixes golang/go#69628 Change-Id: Id0f3a5699417d9249dc7061ff126aef15872cc83 GitHub-Last-Rev: 44c70a6aab2a61639a26fce28ce406475d821641 GitHub-Pull-Request: golang/website#305 Reviewed-on: https://go-review.googlesource.com/c/website/+/639216 Auto-Submit: Ian Lance Taylor <iant@google.com> Reviewed-by: Michael Pratt <mpratt@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Ian Lance Taylor <iant@google.com>
2024-09-18_content/doc/tutorial: improve documentation on installing govulncheckZvonimir Pavlinovic
govulncheck's go.mod now requires the use of Go version that is at least one less than the current latest Go release. Remove the old restriction as that is now incorrect and confusing. Just tell people to use the latest Go version. Updates golang/go#68034 Change-Id: I97a59d4764592496918b44c10345a2fadb92aac8 Reviewed-on: https://go-review.googlesource.com/c/website/+/614235 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Ian Cottrell <iancottrell@google.com>
2024-06-04_content/doc/tutorial: fix mixup between "module" and "workspace"Michael Matloob
The word "workspace" was intended to be used. Fixes golang/go#67740 Change-Id: I942f3301eaaf8f3fc6eb8964d3ebe90503bdbc60 Reviewed-on: https://go-review.googlesource.com/c/website/+/590043 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Sam Thanawalla <samthanawalla@google.com>
2023-12-20all: fix and test for references to github.com/golang/go/issues and wikiRuss Cox
Insist on the canonical /issue/ and /wiki/ links instead. Change-Id: I7a2eedda69bc3fcd11466722a41f00c9dbaf283f Reviewed-on: https://go-review.googlesource.com/c/website/+/550323 Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
2023-12-08cmd/golangorg: check for invalid or broken links in served HTMLRuss Cox
Test that links are to /foo not https://go.dev/foo and also check that the links actually point at real pages. Manually fix problems that the test found. For golang/go#37047. Change-Id: I825eec3c2cadb9d259caff51cd893f3023ab533a Reviewed-on: https://go-review.googlesource.com/c/website/+/548059 Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> Auto-Submit: Russ Cox <rsc@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
2023-12-08_content: replace https://blog.golang.org/ links with /blog/Russ Cox
Global search and replace in HTML for href="https://blog.golang.org/ and in Markdown for ](https://blog.golang.org/ Change-Id: Ife69e89a42a631fa5c8babd07201ed0d7796eb0e Reviewed-on: https://go-review.googlesource.com/c/website/+/548062 Auto-Submit: Russ Cox <rsc@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
2023-12-08_content: rewrite links to https://go.dev/foo to /fooRuss Cox
We use /foo consistently so that people browsing on golang.google.cn are not redirected to go.dev. This CL is completely mechanical, replacing href="https://go.dev/ -> href="/ in HTML and replacing ](https://go.dev/ -> ](/ in Markdown. Change-Id: I8ac732d672075600c8e53c46787205454b196850 Reviewed-on: https://go-review.googlesource.com/c/website/+/548058 Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> Auto-Submit: Russ Cox <rsc@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
2023-08-10_content/doc/tutorial: remove mention of init functiontcdsv
the init function is removed from the code example: https://github.com/golang/website/commit/f7341273feb9c0d7d7e12a52d975e7834bf32aa1 Change-Id: Id247fed6f46ad83e47c9871519ed8001dca79c62 GitHub-Last-Rev: 012feea9ebd1e0d68424c25dd8560138fe6182e9 GitHub-Pull-Request: golang/website#230 Reviewed-on: https://go-review.googlesource.com/c/website/+/507096 Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> TryBot-Result: Gopher Robot <gobot@golang.org> Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Robert Findley <rfindley@google.com>
2023-08-03_content: update for golang.org/x/example changesRuss Cox
golang.org/x/example/stringutil.Reverse moved to golang.org/x/example/hello/reverse.String. Update references accordingly. Fixes golang/go#61722. Change-Id: Ib041697bc1c5c40d2b6ccefc7550caaedf338b2d Reviewed-on: https://go-review.googlesource.com/c/website/+/515238 Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> TryBot-Result: Gopher Robot <gobot@golang.org> Run-TryBot: Russ Cox <rsc@golang.org>
2023-07-31_content/doc/tutorial: fix vulncheck tutorial linksSuzy Mueller
Fixes golang/go#61663 Change-Id: I46a4c0f74aa8c64b7d1eee73b9533c56f8ef8233 Reviewed-on: https://go-review.googlesource.com/c/website/+/514635 TryBot-Result: Gopher Robot <gobot@golang.org> Run-TryBot: Suzy Mueller <suzmue@golang.org> Reviewed-by: Brandon Kessler <bkessler@google.com>
2023-07-13Fixes a typo on the govulncheck tutorialBrandon Kessler
Typo causes an extra code block to appear Change-Id: I0912c53e5ca5aed1a6435d61db6c16b7de239d8b Reviewed-on: https://go-review.googlesource.com/c/website/+/509375 Run-TryBot: Brandon Kessler <bkessler@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>
2023-07-10_content/doc/tutorial: Added tutorials to indexariathaker
Added the tutorials for govulncheck and VS Code Go to the table on the tutorial index page Change-Id: Ib5d64fdfb7b92ed5769a421b8c2dfde38220794b Reviewed-on: https://go-review.googlesource.com/c/website/+/508316 Reviewed-by: Brandon Kessler <bkessler@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com> Auto-Submit: Julie Qiu <julieqiu@google.com> Run-TryBot: Julie Qiu <julieqiu@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>
2023-06-29_content/doc/tutorial: Added VS Code Go tutorialariathaker
Added tutorial on vulnerability scanning in IDE with VS Code Go, with images. Change-Id: I68bbd5cd6d1bf277ac37f1fa1069eb09aef3fb04 Reviewed-on: https://go-review.googlesource.com/c/website/+/505776 Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> Run-TryBot: Hyang-Ah Hana Kim <hyangah@gmail.com> Reviewed-by: Brandon Kessler <bkessler@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>
2023-05-24_content/doc/tutorial: remove unused import "time"Iman Rabbi
`Time` was used by `math/rand.Seed` that is removed Change-Id: I1d288694c5a92fb866d629d8de3d3cdfa79bbf48 GitHub-Last-Rev: 1485d39c3c13aae5cd16ee79ddb29843330178a0 GitHub-Pull-Request: golang/website#226 Reviewed-on: https://go-review.googlesource.com/c/website/+/497835 Run-TryBot: Ian Lance Taylor <iant@google.com> Reviewed-by: Ian Lance Taylor <iant@google.com> Auto-Submit: Ian Lance Taylor <iant@google.com> Reviewed-by: Matthew Dempsky <mdempsky@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>
2023-05-24_content/doc/tutorial: remove unused import "time"Iman Rabbi
`Time` was used by `math/rand.Seed` that is removed Change-Id: I8e7feadce9712bf6e541321187a64da9209660fa GitHub-Last-Rev: f3ec60a3a42b7b53d84425366b5d37a35bea1820 GitHub-Pull-Request: golang/website#227 Reviewed-on: https://go-review.googlesource.com/c/website/+/497836 TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Ian Lance Taylor <iant@google.com> Run-TryBot: Ian Lance Taylor <iant@google.com> Auto-Submit: Ian Lance Taylor <iant@google.com> Reviewed-by: Matthew Dempsky <mdempsky@google.com>
2023-05-24_content/doc/tutorial: remove use of deprecated math/rand.SeedSean Liao
Fixes golang/go#58958 Change-Id: I5ef84f2fd350e3048649cf281e8272e62b2fc052 Reviewed-on: https://go-review.googlesource.com/c/website/+/475275 Run-TryBot: Bryan Mills <bcmills@google.com> Reviewed-by: Ian Lance Taylor <iant@google.com> Auto-Submit: Ian Lance Taylor <iant@google.com> Run-TryBot: Ian Lance Taylor <iant@google.com> Reviewed-by: Bryan Mills <bcmills@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>
2023-05-17_content/doc/tutorial: added govulncheck tutorialariathaker
A new tutorial is added which explains how to use govulncheck, using an example from golang.org/x/text. Change-Id: Ifcaab5b4d3787642a19b773cb725a5127d01e7e8 Reviewed-on: https://go-review.googlesource.com/c/website/+/488935 Run-TryBot: Julie Qiu <julieqiu@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Brandon Kessler <bkessler@google.com> Auto-Submit: Julie Qiu <julieqiu@google.com> Reviewed-by: Todd Kulesza <tkulesza@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com>
2023-02-17_content/doc/tutorial: update fuzzing tutorialariathaker
Update the fuzzing tutorial based on results from the UXR study to: -Link to further documentation -Add explanation of -fuzztime and other testing flags -Explain fuzzing output terms like "new interesting" -Improved clarity on some tutorial steps re: copy/pasting Change-Id: Ia781407130b87d3a79e2bbcc912ad7fa24028056 Reviewed-on: https://go-review.googlesource.com/c/website/+/464020 Reviewed-by: Julie Qiu <julieqiu@google.com> Run-TryBot: Julie Qiu <julieqiu@google.com> Auto-Submit: Julie Qiu <julieqiu@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Alice Merrick <amerrick@google.com>
2023-02-14_content: Breadcrumbs added to children pages.Frederick Mixell
Added to all doc children page with doclayout. Added to Why Go pages. Added to Security pages. Video of Changes: https://drive.google.com/file/d/1wX9e9K9H9wPTaLLQHh15-cWzMTMRr9DO/view?usp=sharing Change-Id: I0fbf8e925e7fa357762d8eebd2bf13d561d49d86 Reviewed-on: https://go-review.googlesource.com/c/website/+/432775 Reviewed-by: Jamal Carvalho <jamal@golang.org> Run-TryBot: Jamal Carvalho <jamal@golang.org> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
2022-09-06_content/security/fuzz: moved from _content/doc/fuzzJulie Qiu
Move all fuzzing content to the /security namespace. Redirect /doc/fuzz to /security/fuzz. Change-Id: I26d9e8b2eef5f37e3f31710d3b03673ef9e444db Reviewed-on: https://go-review.googlesource.com/c/website/+/427880 Reviewed-by: Jonathan Amsterdam <jba@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com> Reviewed-by: Tatiana Bradley <tatiana@golang.org>
2022-06-15all: fix a lot of typosFrederik Zipp
Change-Id: I0754d18f4c3c3d5dfa0c34b4bc154a35ac20b917 Reviewed-on: https://go-review.googlesource.com/c/website/+/411794 Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Ian Lance Taylor <iant@google.com> Run-TryBot: Ian Lance Taylor <iant@google.com> Auto-Submit: Ian Lance Taylor <iant@google.com>
2022-06-15highlight all changed parts of the tutorial codesethbattin
This change is a fix for what appears to be a typo. In the modules tutorial, in [section "Return greetings for multiple people"](https://golang.org/doc/tutorial/greetings-multiple-people), the step 2 code block does not indicate all the changed sections. Everything I highlighted needs to changed in order for the code to work as intended. I found the highlights to be very helpful in following and transcribing the tutorial, so I noticed when they were incorrect. Change-Id: I0e5ccdef4053b2f6a7a5688e5be9c3f6307c5486 GitHub-Last-Rev: 84a5c6e3ba06aa69d83af041b8f9edef2cea35f4 GitHub-Pull-Request: golang/website#49 Reviewed-on: https://go-review.googlesource.com/c/website/+/311329 Reviewed-by: Steve Traut <straut@google.com> Reviewed-by: Jamal Carvalho <jamal@golang.org> Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
2022-04-04_content/doc/tutorial: add missing ` of tutorial for workplaceuji
Fixes golang/go#51762 Change-Id: I62b360d470fa1cdd3b32e851e65def5ec867c18d GitHub-Last-Rev: 1a3c23a3f849e4e0bec3e24725298ee6606a6ae3 GitHub-Pull-Request: golang/website#146 Reviewed-on: https://go-review.googlesource.com/c/website/+/394414 Reviewed-by: Ian Lance Taylor <iant@google.com> Trust: Cherry Mui <cherryyz@google.com>
2022-03-31_content/doc/tutorial: fix inaccuracies in workspace tutorialBernhard Valenti
the first change is related to: https://github.com/golang/go/issues/51449 Change-Id: I857d412a5082b142bb54d7fab685d298488376f9 GitHub-Last-Rev: e19bc97f9bfe5d64213af262a8c1d744cddedca8 GitHub-Pull-Request: golang/website#136 Reviewed-on: https://go-review.googlesource.com/c/website/+/389638 Reviewed-by: Michael Matloob <matloob@google.com> Trust: Michael Matloob <matloob@google.com> Trust: Ian Lance Taylor <iant@google.com>
2022-03-23_content/doc/tutorial: fix typos in fuzz tutorialSean Liao
Fixes golang/go#51372 Fixes golang/go#51871 Change-Id: I64580e1608b75cb4e6f0d39ccc43f432e0c2dfca Reviewed-on: https://go-review.googlesource.com/c/website/+/394814 Reviewed-by: Ian Lance Taylor <iant@google.com> Trust: Dmitri Shuralyov <dmitshur@google.com>
2022-03-21_content/ref: update the modules reference for GOWORKMichael Matloob
The -workfile flag's function has been absorbed by the GOWORK environment variable. Update the workspaces reference to reflect that. Also fix an error in the workspaces tutorial. For golang/go#45713 Change-Id: Id8dc8bb8dc6458d03d7b947ec78d84263d9689e1 Reviewed-on: https://go-review.googlesource.com/c/website/+/393360 Trust: Michael Matloob <matloob@golang.org> Run-TryBot: Michael Matloob <matloob@golang.org> Reviewed-by: Bryan Mills <bcmills@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Beth Brown <ecbrown@google.com>
2022-03-16_content/doc: change generics and fuzz tutorials from betaEli Bendersky
Go 1.18 is released; these tutorials are now out of beta as well. Fixes golang/go#51688 Change-Id: I5ded6c75f3131c97e3d2104146e0dff98dd7b1b0 Reviewed-on: https://go-review.googlesource.com/c/website/+/393215 Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> Trust: Eli Bendersky <eliben@google.com>
2022-03-01_content/doc/tutorial: add a tutorial for workspacesMichael Matloob
Change-Id: I0686121523da9b22666cfbad54821527ac5b8feb Reviewed-on: https://go-review.googlesource.com/c/website/+/383854 Trust: Michael Matloob <michaelmatloob@gmail.com> Trust: Bryan Mills <bcmills@google.com> Reviewed-by: Bryan Mills <bcmills@google.com>
2022-02-18_content/doc/tutorial: fix number of rows in database-access.mdChia-Chi Hsu
"Add three rows with values" should be "Add four rows with values". Change-Id: I82103908292faf95c1b6c62ca57d6f47b0249ccb GitHub-Last-Rev: 2a0240372717014ccff4c511b71a43ba846db760 GitHub-Pull-Request: golang/website#126 Reviewed-on: https://go-review.googlesource.com/c/website/+/385594 Reviewed-by: DO NOT USE <iant@google.com> Trust: Dmitri Shuralyov <dmitshur@google.com>
2022-02-08_content/doc/tutorial: fix a typojiahua wang
Fixes golang/go#50853 Change-Id: Ia09043435f23b979a2a0d198318096e6ecf52cb5 Reviewed-on: https://go-review.googlesource.com/c/website/+/381654 Reviewed-by: DO NOT USE <iant@google.com> Trust: Cherry Mui <cherryyz@google.com>
2022-02-08_content/doc/tutorial/generics: add indentation inside functionAndrey
Change-Id: I5648e2da0b708bf35e4406f4dcb49eabe01abf92 GitHub-Last-Rev: 009bc861a38bb5b8b180d11c1cfc569d17a00059 GitHub-Pull-Request: golang/website#122 Reviewed-on: https://go-review.googlesource.com/c/website/+/381917 Reviewed-by: DO NOT USE <iant@google.com> Trust: Cherry Mui <cherryyz@google.com>
2022-02-08_content/doc: update generics tutorial to not mention constraints packageEli Bendersky
Following decision in golang/go#50792 Change-Id: I71d74b4b386aacef5319663c397479cac6feb32f Reviewed-on: https://go-review.googlesource.com/c/website/+/383694 Reviewed-by: DO NOT USE <iant@google.com> Reviewed-by: Eli Bendersky <eliben@google.com>
2022-02-01_content/doc/tutorial: add additional descriptions to fuzz.mdKatie Hockman
Change-Id: I4278ae598a503d1e036371069f07a1be19e11a93 Reviewed-on: https://go-review.googlesource.com/c/website/+/381794 Run-TryBot: Katie Hockman <katie@golang.org> Trust: DO NOT USE <katiehockman@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Julie Qiu <julieqiu@google.com>
2022-01-19_content/doc/tutorial: fix fuzz.md final stepsBeth Brown
main.go modified to import unicode/utf8 and errors packages, discard returned error. Steps added to import packages and make changes in final steps. Fixes golang/go#50628 Change-Id: I5dd5fb66256d56eb81bdbb16ba2d5a3fc1ee5dd4 Reviewed-on: https://go-review.googlesource.com/c/website/+/378477 Trust: Julie Qiu <julieqiu@google.com> Trust: DO NOT USE <katiehockman@google.com> Reviewed-by: Julie Qiu <julieqiu@google.com> Reviewed-by: DO NOT USE <katiehockman@google.com>
2022-01-14_content: remove some https://go.dev/ prefixes in linksRuss Cox
The site is served at both go.dev and golang.google.cn. In China, only golang.google.cn can serve, so we try to use relative links to avoid pointing users to the copy they can't access. Periodically we have to remove prefixes that have crept in. This commit applies today's round of that. Change-Id: Iaa169635664d0562a1cccc57c3e02b687b3493e7 Reviewed-on: https://go-review.googlesource.com/c/website/+/378597 Trust: Russ Cox <rsc@golang.org> Run-TryBot: Russ Cox <rsc@golang.org> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: DO NOT USE <katiehockman@google.com> Trust: DO NOT USE <katiehockman@google.com>
2022-01-14_content: add blog post and new fuzzing tutorialKatie Hockman
Change-Id: I533a2bb17f0d0bd09a9372e9852ff50a6e0f9e6a Reviewed-on: https://go-review.googlesource.com/c/website/+/378594 Reviewed-by: Russ Cox <rsc@golang.org> Run-TryBot: Katie Hockman <katie@golang.org> Trust: DO NOT USE <katiehockman@google.com> TryBot-Result: Gopher Robot <gobot@golang.org>
2021-12-15_content/doc/tutorial: alias go to go1.18beta1 in generics.mdDmitri Shuralyov
My memory and documentation I just looked up suggests the alias name comes first, and the value second. Thanks to Hana for spotting this. Change-Id: I981e49c5a9231c258606a8a7914ac9857923d903 Reviewed-on: https://go-review.googlesource.com/c/website/+/372055 Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org> Trust: Dmitri Shuralyov <dmitshur@google.com> TryBot-Result: Gopher Robot <gobot@golang.org> Reviewed-by: Jeremy Faller <jeremy@golang.org>
2021-12-14_content/doc: add a generics tutorialSteve Traut
This adds a tutorial introducing Go generics. This change includes: - A generics tutorial: - _content/doc/tutorial/generics.md - Updates to index topics so that they list the new content. - _content/doc/index.html - _content/doc/tutorial/index.html Change-Id: I39abe0823c7d89dcb8ac89fcc1a2ab196a289614 Reviewed-on: https://go-review.googlesource.com/c/website/+/369614 Reviewed-by: Russ Cox <rsc@golang.org> Trust: Michael Knyszek <mknyszek@google.com>
2021-12-06_content: cancel spellingRuss Cox
canceled canceling cancellation Per https://go.dev/wiki/Spelling. Change-Id: I3e719a9f07e64259e6bcf02c9d15939069176538 Reviewed-on: https://go-review.googlesource.com/c/website/+/369714 Trust: Russ Cox <rsc@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
2021-11-22_content: update links to tourRuss Cox
Now the tour is just /tour, not https://tour.golang.org. Change-Id: Iebb2f7a5218b747896250815f4f46f62755e6a88 Reviewed-on: https://go-review.googlesource.com/c/website/+/365101 Trust: Russ Cox <rsc@golang.org> Reviewed-by: Jamal Carvalho <jamal@golang.org>
2021-11-22all: make golang.org and go.dev links relativeRuss Cox
Now that there is one site, update all golang.org links to go.dev. But for any links being served from go.dev, make host-relative, so that when serving golang.google.cn, we stay on that host as much as possible. Change-Id: Id6e1303059b5522846a64202bc1a8b81dc3854cd Reviewed-on: https://go-review.googlesource.com/c/website/+/365095 Trust: Russ Cox <rsc@golang.org> Reviewed-by: Jamal Carvalho <jamal@golang.org>
2021-11-17go.dev/_content: various formatting fixesRuss Cox
Add a standard 1rem margin above and below key block elements like h1, h2, ..., ol, ul, p. Today it's very inconsistent and because you get a margin from either the block above or below, it mostly works out, except in certain cases where text gets jammed together a bit too much. Add the auto-TOC generator for use in layouts that define #nav (nothing yet, but golang.org-migrated pages will). Add "Table of Contents" to the top of the TOC. Allow pages to opt out of the TOC by setting HideTOC in their metadata. Make subtitle heading (Version of Jan 1, 2021) line up horizontally with the TOC. Preparation for the golang.org -> go.dev move. Change-Id: Ic9121e5b636155c54e487bcb735ac0bc3f958733 Reviewed-on: https://go-review.googlesource.com/c/website/+/362502 Trust: Russ Cox <rsc@golang.org> Reviewed-by: Jamal Carvalho <jamal@golang.org>
2021-09-15x/website: fix bad indentation in tutorial -> database-accessdaiwt
Change-Id: I0ba4e67c02827aa8a985b24dbc208412a0721729 GitHub-Last-Rev: 463be1cb9f689eabe45284a0e284c03b31554fa3 GitHub-Pull-Request: golang/website#84 Reviewed-on: https://go-review.googlesource.com/c/website/+/344371 Reviewed-by: Akhil Indurti <aindurti@gmail.com> Reviewed-by: Russ Cox <rsc@golang.org> Trust: Dmitri Shuralyov <dmitshur@golang.org> Website-Publish: Russ Cox <rsc@golang.org>
2021-09-08_content/doc: module naming best practicesSteve Traut
This adds new content with best practices for the module path. It also revises existing content to use the best practice. This change includes: * A new "Naming a module" section in "Managing dependencies" describing naming best practices and reserved terms for module paths. * Changing module path prefix from "example.com/*" to "example/*" where the content seems aimed specifically at new users. This is designed to reduce confusion for those who wonder if a domain name is required in the local, simple context. * Links to the "Naming a module" section so that new users can follow up from the simple case to learn about best practices. Change-Id: I07eac1f805ce506a486d3c0e7b54539554e3c30b Reviewed-on: https://go-review.googlesource.com/c/website/+/344469 Trust: Steve Traut <straut@google.com> Trust: Bryan C. Mills <bcmills@google.com> Reviewed-by: Bryan C. Mills <bcmills@google.com> Run-TryBot: Bryan C. Mills <bcmills@google.com> TryBot-Result: Go Bot <gobot@golang.org>
2021-08-19_content/doc: Add a button to launch interactive tutorialSteve Traut
This adds a button through which users can launch a version of this tutorial that they can work through in the Cloud Shell IDE. Change-Id: I8e8310b3b07d39283a2001a3d87ac850e354d848 Reviewed-on: https://go-review.googlesource.com/c/website/+/342910 Reviewed-by: Steve Francia <spf@golang.org> Trust: Steve Traut <straut@google.com>
2021-07-12_content/doc: add a Go/Gin web service tutorialSteve Traut
This adds a tutorial introducing how to build a RESTful web service using Go and the Gin web framework. This change includes: - A RESTful web service tutorial: - _content/doc/tutorial/web-service-gin.md - Updates to index topics so that they list the new content. - _content/doc/index.html - _content/doc/tutorial/index.html Change-Id: I137dcd884c4e38b4a2bebd733ec630f2d9bc3b95 Reviewed-on: https://go-review.googlesource.com/c/website/+/332349 Trust: Steve Traut <straut@google.com> Reviewed-by: Russ Cox <rsc@golang.org>
2021-07-01_content/doc: add data access tutorial and guideSteve Traut
This adds an introductory tutorial on accessing relational databases, as well as a deeper dive data access guide comprising nine topics. This change includes: - A data access tutorial: - _content/doc/tutorial/database-access.md -- An introductory data access tutorial. - A data access guide: - _content/doc/database/index.md -- An overview of data access with Go. - _content/doc/database/open-handle -- On opening a database handle. - _content/doc/database/change-data -- On executing SQL statements that don't return data - _content/doc/database/querying -- On querying for data - _content/doc/database/prepared-statements -- On using prepared statements - _content/doc/database/execute-transactions -- On executing transactions - _content/doc/database/cancel-operations -- On using Context to support cancelling in-progress database operations - _content/doc/database/manage-connections -- On customizing the connection pool and using a reserved connection - _content/doc/database/sql-injection -- On using function parameters to avoid a SQL injection risk - Updates to index topics so that they list the new content. - _content/doc/index.html - _content/doc/tutorial/index.html Change-Id: Iab94d93e5d53e1379b22098c08d517b99cfa2c27 Reviewed-on: https://go-review.googlesource.com/c/website/+/331449 Reviewed-by: Russ Cox <rsc@golang.org> Website-Publish: Russ Cox <rsc@golang.org> Run-TryBot: Russ Cox <rsc@golang.org> TryBot-Result: Go Bot <gobot@golang.org> Trust: Steve Traut <straut@google.com>
2021-06-23_content/doc: fix go mod edit for PowerShellHeschi Kreinick
"-replace=foo.com=bar.com" triggers this bug in PowerShell: https://github.com/PowerShell/PowerShell/issues/6291 The go command accepts "-replace foo.com=bar.com" just fine. Use that instead. Fixes #44924. Change-Id: I854ea86282db425a2707c641b0500208b4869870 Reviewed-on: https://go-review.googlesource.com/c/website/+/330229 Trust: Heschi Kreinick <heschi@google.com> Run-TryBot: Heschi Kreinick <heschi@google.com> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Steve Traut <straut@google.com>
2021-03-12_content/doc: remove redundant Path metadataRuss Cox
CL 251343 (Feb 12) changed the default service URL for _content/doc/x.html from https://golang.org/doc/x.html to https://golang.org/doc/x. Remove Path metadata that simply restates this new default. Change-Id: Ia132c08f200c5a93554755cd1cd8429c9f8f3062 Reviewed-on: https://go-review.googlesource.com/c/website/+/296382 Trust: Russ Cox <rsc@golang.org> Run-TryBot: Russ Cox <rsc@golang.org> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
2021-03-12_content: remove trailing spacesRuss Cox
Change-Id: Ide6008487c296dbd8d8f8cd6bd4eae54c2590127 Reviewed-on: https://go-review.googlesource.com/c/website/+/296381 Trust: Russ Cox <rsc@golang.org> Run-TryBot: Russ Cox <rsc@golang.org> TryBot-Result: Go Bot <gobot@golang.org> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>