Merge branch 'translate-en-2024'

Author: oohira

.github/workflows/test.yml

@@ -12,14 +12,14 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        go-version: [1.17.x]
+        go-version: [1.23.0]
 
     runs-on: ${{ matrix.os }}
     steps:
     - uses: actions/checkout@v2
 
     - name: Set up Go
-      uses: actions/setup-go@v2
+      uses: actions/setup-go@v3
       with:
         go-version: ${{ matrix.go-version }}
 

.textlintrc .textlintrc.json

@@ -5,17 +5,16 @@
   "rules": {
     "preset-ja-technical-writing": {
       "ja-no-weak-phrase": false,
+      "max-kanji-continuous-len": {
+        "max": 6,
+        "allow": [
+          "可変長引数関数"
+        ]
+      },
       "max-ten": {
         "max": 4
       },
       "no-exclamation-question-mark": false
     }
-  },
-  "filters": {
-    "whitelist": {
-      "allow": [
-        "可変長引数関数"
-      ]
-    }
   }
 }

CONTRIBUTING.md

@@ -2,11 +2,16 @@
 
 Thanks for your interest in contributing to Go by Example!
 
-* When sending a PR that affects the displayed contents of the site, run
-  `tools/build` locally and include the generated HTML in the PR. If you
-  only want to submit a simple typo suggestion (for example, through the
-  Github website), feel free to send a PR anyway - we'll regenerate the
-  HTML and merge with your commit.
+* When sending a PR that affects the displayed contents of the site, 
+  updating the HTML in the `public` directory by itself is insufficient, since
+  the source of truth for the website is in the `examples` directory.
+  
+  Instead, update the proper source file(s) in the `examples` directory and
+  run `tools/build` locally to regenerate the HTML; include both changes in
+  your PR.  
+  
+  If you don't want to deal with getting a proper PR in, feel free to just
+  open an issue and point out the change you suggest.
 
 * We're open to adding more examples to the site. They should be on things
   used by many programmers and only require the standard library. If you're

README.md

@@ -7,7 +7,7 @@ a site that teaches Go via annotated example programs.
 
 The Go by Example site is built by extracting code and
 comments from source files in `examples` and rendering
-them via the `templates` into a static `public`
+them using `templates` into a static `public`
 directory. The programs implementing this build process
 are in `tools`, along with dependencies specified in
 the `go.mod`file.
@@ -18,7 +18,7 @@ CloudFront, for example.
 
 ### Building
 
-[![Build Status](https://github.com/mmcgrana/gobyexample/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/mmcgrana/gobyexample/actions)
+[![test](https://github.com/mmcgrana/gobyexample/actions/workflows/test.yml/badge.svg)](https://github.com/mmcgrana/gobyexample/actions/workflows/test.yml)
 
 To build the site you'll need Go installed. Run:
 
@@ -34,7 +34,7 @@ $ tools/build-loop
 
 To see the site locally:
 
-```
+```console
 $ tools/serve
 ```
 
@@ -55,7 +55,7 @@ $ tools/upload
 This work is copyright Mark McGranaghan and licensed under a
 [Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).
 
-The Go Gopher is copyright [Renée French](http://reneefrench.blogspot.com/) and licensed under a
+The Go Gopher is copyright [Renée French](https://reneefrench.blogspot.com/) and licensed under a
 [Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).
 
 
@@ -64,14 +64,15 @@ The Go Gopher is copyright [Renée French](http://reneefrench.blogspot.com/) and
 Contributor translations of the Go by Example site are available in:
 
 * [Chinese](https://gobyexample-cn.github.io/) by [gobyexample-cn](https://github.com/gobyexample-cn)
-* [Czech](http://gobyexamples.sweb.cz/) by [martinkunc](https://github.com/martinkunc/gobyexample-cz)
 * [French](http://le-go-par-l-exemple.keiruaprod.fr) by [keirua](https://github.com/keirua/gobyexample)
-* [Italian](http://gobyexample.it) by the [Go Italian community](https://github.com/golangit/gobyexample-it)
+* [Italian](https://gobyexample.it) by the [Go Italian community](https://github.com/golangit/gobyexample-it)
 * [Japanese](http://spinute.org/go-by-example) by [spinute](https://github.com/spinute)
 * [Korean](https://mingrammer.com/gobyexample/) by [mingrammer](https://github.com/mingrammer)
 * [Russian](https://gobyexample.com.ru/) by [badkaktus](https://github.com/badkaktus)
-* [Spanish](http://goconejemplos.com) by the [Go Mexico community](https://github.com/dabit/gobyexample)
-* [Ukrainian](http://butuzov.github.io/gobyexample/) by [butuzov](https://github.com/butuzov/gobyexample)
+* [Ukrainian](https://butuzov.github.io/gobyexample/) by [butuzov](https://github.com/butuzov/gobyexample)
+* [Brazilian Portuguese](https://lcslitx.github.io/GoEmExemplos/) by [lcslitx](https://github.com/LCSLITX)
+* [Vietnamese](https://gobyexample.vn/) by [s6k Gopher](https://github.com/s6k-gopher/gobyexample-vn)
+* [Burmese](https://setkyar.github.io/gobyexample) by [Set Kyar Wa Lar](https://github.com/setkyar/gobyexample)
 
 ### Thanks
 
@@ -81,13 +82,19 @@ inspired this project.
 
 ### FAQ
 
+#### I found a problem with the examples; what do I do?
+
+We're very happy to fix problem reports and accept contributions! Please submit
+[an issue](https://github.com/mmcgrana/gobyexample/issues) or send a Pull Request.
+See `CONTRIBUTING.md` for more details.
+
 #### What version of Go is required to run these examples?
 
 Given Go's strong [backwards compatibility guarantees](https://go.dev/doc/go1compat),
 we expect the vast majority of examples to work on the latest released version of Go
 as well as many older releases going back years.
 
-That said, some examples show off new features added in the latest release; therefore,
+That said, some examples show off new features added in recent releases; therefore,
 it's recommended to try running examples with the latest officially released Go version
 (see Go's [release history](https://go.dev/doc/devel/release) for details).
 
@@ -97,6 +104,11 @@ Some of the examples demonstrate concurrent code which has a non-deterministic
 execution order. It depends on how the Go runtime schedules its goroutines and
 may vary by operating system, CPU architecture, or even Go version.
 
+Similarly, examples that iterate over maps may produce items in a different order
+from what you're getting on your machine. This is because the order of iteration
+over maps in Go is [not specified and is not guaranteed to be the same from one
+iteration to the next](https://go.dev/ref/spec#RangeClause).
+
 It doesn't mean anything is wrong with the example. Typically the code in these
 examples will be insensitive to the actual order of the output; if the code is
 sensitive to the order - that's probably a bug - so feel free to report it.