feat(godocfx): include alt documentation link (#3530)

googleapis · Jan 12, 2021 · 806cdd5 · 806cdd5
1 parent ab2af0b
commit 806cdd5
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/internal/godocfx/parse.go b/internal/godocfx/parse.go
@@ -83,6 +83,7 @@ type item struct {
 	Syntax   syntax    `yaml:"syntax,omitempty"`
 	Examples []example `yaml:"codeexamples,omitempty"`
 	Children []child   `yaml:"children,omitempty"`
+	AltLink  string    `yaml:"alt_link,omitempty"`
 }
 
 func (p *page) addItem(i *item) {
@@ -156,6 +157,7 @@ func parse(glob string, workingDir string, optionalExtraFiles []string) (*result
 			Langs:    onlyGo,
 			Type:     "package",
 			Examples: processExamples(pi.doc.Examples, pi.fset),
+			AltLink:  "https://pkg.go.dev/" + pi.doc.ImportPath,
 		}
 		pkgPage := &page{Items: []*item{pkgItem}}
 		pages[pi.doc.ImportPath] = pkgPage

diff --git a/internal/godocfx/testdata/golden/index.yml b/internal/godocfx/testdata/golden/index.yml
@@ -231,6 +231,7 @@ items:
   - cloud.google.com/go/storage.Writer.CloseWithError
   - cloud.google.com/go/storage.Writer.Write
   - cloud.google.com/go/storage.SignedURL
+  alt_link: https://pkg.go.dev/cloud.google.com/go/storage
 - uid: cloud.google.com/go/storage.DeleteAction,SetStorageClassAction
   name: DeleteAction, SetStorageClassAction
   id: DeleteAction,SetStorageClassAction