diff options
| author | Steve Traut <straut@google.com> | 2021-01-18 11:26:17 -0500 |
|---|---|---|
| committer | Steve Traut <straut@google.com> | 2021-02-01 20:42:43 +0000 |
| commit | 0ebc08ad1827251b4bd8c4bc75b02164c339ba67 (patch) | |
| tree | f7f6d55071cfba3ad05e499b30cecd6264642fdf /_content/doc/tutorial/call-module-code.html | |
| parent | dc11df0a4180d78d2a3e678c2306df94cc92ac5c (diff) | |
| download | go-x-website-0ebc08ad1827251b4bd8c4bc75b02164c339ba67.tar.xz | |
content/static/doc: add documentation for using modules
This adds content that we can revise and enhance over time (unlike the
blog). The content has the following characteristics:
- It attempts to be task-oriented, focusing on the things users
will likely want to do.
- It includes content for two separate sets of user tasks: those
for developing modules and those for consuming them (managing the
dependencies).
- As article content, it can be updated and augmented over time based
on feature changes and user needs.
This change includes:
- A topic that includes help for dependency management tasks
(modules/managing-dependencies.md).
- Five topics for those intending to build and publish modules
for others to use.
- Developing and publishing modules (modules/developing.md) --
An overview.
- Module release and versioning workflow
(modules/release-workflow.md) -- Describes the high-level
steps in that workflow.
- Managing module source (modules/managing-source.md) --
Conventions and recommendations for sourcing modules to
publish.
- Developing a major version update (modules/major-version.md) --
Specifics about source for a major version update.
- Publishing a module (modules/publishing.md) -- Steps to
publish a module.
- A topic on module version numbering (modules/version-numbers.md).
- A topic with quick-reference information on the contents of a
go.mod file (modules/gomod-ref.md).
- Supporting images.
- Changes to the main docs page to reflect the additions (docs.html).
- A new modules/ folder for content files. As we add more content,
a second level of folders will help the doc set scale while
helping SEO.
- CSS changes to improve tables in docs and keep param lists
(in the go.mod reference) from extending rightward past the rest
of the content.
**Note about changes to docs.html** I essentially rearranged the
page to make it better suited to accept links for additional
planned documentation. These changes are intended to make it
clearer where the content is coming from while creating a space
for content that will be added later.
Change-Id: I0aa7a3c67e0b03a81cd4963e766b5dc7b27d85b2
Reviewed-on: https://go-review.googlesource.com/c/website/+/284472
Run-TryBot: Steve Traut <straut@google.com>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
Trust: Steve Traut <straut@google.com>
Trust: Dmitri Shuralyov <dmitshur@golang.org>
Diffstat (limited to '_content/doc/tutorial/call-module-code.html')
0 files changed, 0 insertions, 0 deletions
