|author||Steve Traut <firstname.lastname@example.org>||Mon Jan 18 11:26:17 2021 -0500|
|committer||Steve Traut <email@example.com>||Mon Feb 01 20:42:43 2021 +0000|
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 <firstname.lastname@example.org> TryBot-Result: Go Bot <email@example.com> Reviewed-by: Dmitri Shuralyov <firstname.lastname@example.org> Trust: Steve Traut <email@example.com> Trust: Dmitri Shuralyov <firstname.lastname@example.org>
This repository holds the Go website server code and content.
To download and run the golang.org web server locally:
git clone https://go.googlesource.com/website
go run ./cmd/golangorg
See cmd/golangorg/README.md for more details.
To make basic changes to the golang.org website content:
go run ./cmd/golangorg.
go generate ./content/static
go run ./cmd/golangorg
See content/README.md for more sophisticated instructions.
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.