From bd622872f4fc2bf09b75f59c461e5c38e10f91ec Mon Sep 17 00:00:00 2001 From: Jay Conrod Date: Fri, 18 Oct 2019 17:39:31 -0400 Subject: [PATCH] doc: add skeleton module documentation with headings Sections will be filled in with individual CLs before Go 1.14. NOTE: This document is currently in Markdown for ease of writing / reviewing. Before Go 1.14, we will either ensure that x/website can render Markdown (flavor TBD) or check in a rendered HTML file that can be displayed directly. Updates #33637 Change-Id: Icd43fa2bdb7d256b28a56b93214b70343f43492e Reviewed-on: https://go-review.googlesource.com/c/go/+/202081 Reviewed-by: Bryan C. Mills --- doc/modules.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 doc/modules.md diff --git a/doc/modules.md b/doc/modules.md new file mode 100644 index 0000000000..d9bc73efb3 --- /dev/null +++ b/doc/modules.md @@ -0,0 +1,61 @@ + + + + +## Introduction + +## Glossary + +## Packages, modules, and versions + +## go.mod files + +### go.mod file format + +### Minimal version selection (MVS) + +### Compatibility with non-module repositories + +## Module-aware build commands + +### Enabling modules + +### Initializing modules + +### Build commands + +### Vendoring + +### `go mod download` + +### `go mod verify` + +### `go mod edit` + +### `go clean -modcache` + +### Module commands outside a module + +## Retrieving modules + +### GOPROXY protocol + +### Module zip requirements + +### Privacy + +### Private modules + +## Authenticating modules + +### go.sum file format + +### Checksum database + +### Privacy -- 2.50.0