commit | 12eac51beafb23e225a5e486c056626386672c60 | [log] [tgz] |
---|---|---|
author | Steve Traut <straut@google.com> | Thu Aug 19 10:27:41 2021 -0400 |
committer | Steve Traut <straut@google.com> | Wed Sep 08 14:57:14 2021 +0000 |
tree | 2acafc1d23013ea6efed7d5b4260a9a360638c1d | |
parent | 06d6b9d29b8244fe90ea8518bd521344fd4d87e8 [diff] |
_content/doc: module naming best practices 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>
This repo holds content and serving programs for the golang.org and go.dev web sites.
Content is in _content/ (golang.org), go.dev/_content/ (go.dev), and tour/ (tour.golang.org). Server code is in cmd/ and internal/.
To run the combined golang.org+go.dev server to preview local content changes, use:
go run ./cmd/golangorg
The supporting programs cmd/admingolangorg and cmd/googlegolangorg are the servers for admin.golang.org and google.golang.org. (They do not use the _content/ directories.)
Each command directory has its own README.md explaining deployment.
This repository uses prettier to format JS and CSS files.
The version of prettier
used is 1.18.2.
It is encouraged that all JS and CSS code be run through this before submitting a change. However, it is not a strict requirement enforced by CI.
This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.
The main issue tracker for the website repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/website:” in the subject line, so it is easy to find.