From 12eac51beafb23e225a5e486c056626386672c60 Mon Sep 17 00:00:00 2001 From: Steve Traut Date: Thu, 19 Aug 2021 10:27:41 -0400 Subject: _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 Trust: Bryan C. Mills Reviewed-by: Bryan C. Mills Run-TryBot: Bryan C. Mills TryBot-Result: Go Bot --- _content/doc/tutorial/create-module.html | 6 ++++++ 1 file changed, 6 insertions(+) (limited to '_content/doc/tutorial/create-module.html') diff --git a/_content/doc/tutorial/create-module.html b/_content/doc/tutorial/create-module.html index e9df3367..d187f4f9 100644 --- a/_content/doc/tutorial/create-module.html +++ b/_content/doc/tutorial/create-module.html @@ -152,6 +152,12 @@ cd greetings Go tools. That would be your code's repository.

+

+ For more on naming your module with a module path, see + Managing + dependencies. +

+ 
 $ go mod init example.com/greetings
 go: creating new go.mod: module example.com/greetings
-- 
cgit v1.3-5-g9baa