Skip to content

Commit 7cce20c

Browse files
author
Steve Traut
committed
[x/blog] content: add links from modules posts to modules docs
Adding to each blog post a link to modules-related documentation. Change-Id: I0f82692b528c2fe910466f36303573ce1ec98ccd Reviewed-on: https://go-review.googlesource.com/c/blog/+/290389 Run-TryBot: Steve Traut <[email protected]> TryBot-Result: Go Bot <[email protected]> Reviewed-by: Dmitri Shuralyov <[email protected]> X-Blog-Commit: 8b806c840d8a6d724d75db0d72e7e706b2c8810f
1 parent bef450b commit 7cce20c

File tree

5 files changed

+16
-0
lines changed

5 files changed

+16
-0
lines changed

blog/content/migrating-to-go-modules.article

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ This post is part 2 in a series.
1515
- Part 4 — [Go Modules: v2 and Beyond](/v2-go-modules)
1616
- Part 5 — [Keeping Your Modules Compatible](/module-compatibility)
1717

18+
**Note:** For documentation, see
19+
[Managing dependencies](https://golang.org/doc/modules/managing-dependencies)
20+
and [Developing and publishing modules](https://golang.org/doc/modules/developing).
21+
1822
Go projects use a wide variety of dependency management strategies.
1923
[Vendoring](https://golang.org/cmd/go/#hdr-Vendor_Directories) tools such
2024
as [dep](https://github.com/golang/dep) and [glide](https://github.com/Masterminds/glide) are popular,

blog/content/module-compatibility.article

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ This post is part 5 in a series.
1717
- Part 4 — [Go Modules: v2 and Beyond](/v2-go-modules)
1818
- **Part 5 — Keeping Your Modules Compatible** (this post)
1919

20+
**Note:** For documentation on developing modules, see
21+
[Developing and publishing modules](https://golang.org/doc/modules/developing).
22+
2023
Your modules will evolve over time as you add new features, change behaviors, and reconsider parts of the module's public surface. As discussed in [Go Modules: v2 and Beyond](/v2-go-modules), breaking changes to a v1+ module must happen as part of a major version bump (or by adopting a new module path).
2124

2225
However, releasing a new major version is hard on your users. They have to find the new version, learn a new API, and change their code. And some users may never update, meaning you have to maintain two versions for your code forever. So it is usually better to change your existing package in a compatible way.

blog/content/publishing-go-modules.article

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ This post is part 3 in a series.
1515
- Part 4 — [Go Modules: v2 and Beyond](/v2-go-modules)
1616
- Part 5 — [Keeping Your Modules Compatible](/module-compatibility)
1717

18+
**Note:** For documentation on developing modules, see
19+
[Developing and publishing modules](https://golang.org/doc/modules/developing).
20+
1821
This post discusses how to write and publish modules so other modules can depend
1922
on them.
2023

blog/content/using-go-modules.article

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ This post is part 1 in a series.
1717
- Part 4 — [Go Modules: v2 and Beyond](/v2-go-modules)
1818
- Part 5 — [Keeping Your Modules Compatible](/module-compatibility)
1919

20+
**Note:** For documentation on managing dependencies with modules, see
21+
[Managing dependencies](https://golang.org/doc/modules/managing-dependencies).
22+
2023
Go 1.11 and 1.12 include preliminary
2124
[support for modules](https://golang.org/doc/go1.11#modules),
2225
Go’s

blog/content/v2-go-modules.article

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,9 @@ This post is part 4 in a series.
1717
- **Part 4 — Go Modules: v2 and Beyond** (this post)
1818
- Part 5 — [Keeping Your Modules Compatible](/module-compatibility)
1919

20+
**Note:** For documentation on developing modules, see
21+
[Developing and publishing modules](https://golang.org/doc/modules/developing).
22+
2023
As a successful project matures and new requirements are added, past features
2124
and design decisions might stop making sense. Developers may want to integrate
2225
lessons they've learned by removing deprecated functions, renaming types, or

0 commit comments

Comments
 (0)