[chore] Add godoc target

open-telemetry · Apr 8, 2024 · 651d93e · 651d93e
1 parent 014c6fc
commit 651d93e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -191,12 +191,7 @@ Prefer using [Examples](https://pkg.go.dev/testing#hdr-Examples)
 instead of putting code snippets in Go doc comments.
 In some cases, you can even create [Testable Examples](https://go.dev/blog/examples).
 
-You can install and run a "local Go Doc site" in the following way:
-
-  ```sh
-  go install golang.org/x/pkgsite/cmd/pkgsite@latest
-  pkgsite
-  ```
+You can install and run a local pkg.go.dev (Go Doc) website with `make godoc`.
 
 [`go.opentelemetry.io/otel/metric`](https://pkg.go.dev/go.opentelemetry.io/otel/metric)
 is an example of a very well-documented package.

diff --git a/Makefile b/Makefile
@@ -310,3 +310,8 @@ lint-markdown:
 .PHONY: verify-readmes
 verify-readmes:
 	./verify_readmes.sh
+
+.PHONY: godoc
+godoc:
+	go install golang.org/x/pkgsite/cmd/pkgsite@latest
+	pkgsite