_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>
9 files changed
tree: 2acafc1d23013ea6efed7d5b4260a9a360638c1d
  1. _content/
  2. cmd/
  3. go.dev/
  4. internal/
  5. tour/
  6. .gitattributes
  7. .prettierrc
  8. AUTHORS
  9. codereview.cfg
  10. content.go
  11. CONTRIBUTING.md
  12. CONTRIBUTORS
  13. go-app-deploy.sh
  14. go.mod
  15. go.sum
  16. LICENSE
  17. PATENTS
  18. README.md
README.md

Go website

Go Reference

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.

JS/CSS Formatting

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.

Report Issues / Send Patches

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.