Skip to content

Commit 6220a9a

Browse files
tbpgtbpg
authored
fix(internal/godocfx): fix links to other packages in summary (#8756)
All of the golden changes fix broken links.
1 parent 0c57c2c commit 6220a9a

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

‎internal/godocfx/parse.go‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -619,6 +619,17 @@ func buildTOC(mod string, pis []pkgload.Info, extraFiles []extraFile) tableOfCon
619619
func toHTML(p *doc.Package, s string) string {
620620
printer := p.Printer()
621621

622+
// Set the DocLinkBaseURL to pkg.go.dev so links to other packages work.
623+
//
624+
// This will send users to pkg.go.dev for other cloud.google.com packages
625+
// that do have docs hosted on cloud.google.com. The link structure for
626+
// docs on cloud.google.com is [prefix]/[module]/[version]/[pkg]. At this
627+
// point, we don't know what the module path is for any given import path.
628+
// So, for simplicity, we're choosing to have working links to pkg.go.dev
629+
// (with occasional links that could be served on cloud.google.com) rather
630+
// than broken links on cloud.google.com.
631+
printer.DocLinkBaseURL = "https://pkg.go.dev"
632+
622633
// Set the default heading level to 2 so we go from H1 to H2.
623634
printer.HeadingLevel = 2
624635

‎internal/godocfx/testdata/golden/index.yml‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@ items:
4848
holds arbitrary data as a sequence of bytes, like a file. You\nrefer to objects
4949
using a handle, just as with buckets, but unlike buckets\nyou don't explicitly
5050
create an object. Instead, the first time you write\nto an object it will be created.
51-
You can use the standard Go <a href=\"/io#Reader\">io.Reader</a>\nand <a href=\"/io#Writer\">io.Writer</a>
52-
interfaces to read and write object data:\n<pre class=\"prettyprint\">obj := bkt.Object(&quot;data&quot;)\n//
51+
You can use the standard Go <a href=\"https://pkg.go.dev/io#Reader\">io.Reader</a>\nand
52+
<a href=\"https://pkg.go.dev/io#Writer\">io.Writer</a> interfaces to read and
53+
write object data:\n<pre class=\"prettyprint\">obj := bkt.Object(&quot;data&quot;)\n//
5354
Write something to obj.\n// w implements io.Writer.\nw := obj.NewWriter(ctx)\n//
5455
Write some text to obj. This will either create the object or overwrite whatever
5556
is there already.\nif _, err := fmt.Fprintf(w, &quot;This object contains text.\\n&quot;);
@@ -124,16 +125,16 @@ items:
124125
or\n<li>you are logged into <a href=\"https://cloud.google.com/sdk/gcloud/reference/auth/application-default/login\">gcloud
125126
using application default credentials</a>\nwith <a href=\"https://cloud.google.com/sdk/gcloud/reference#--impersonate-service-account\">impersonation
126127
enabled</a>.\n</ul>\n<p>Detecting GoogleAccessID may not be possible if you are
127-
authenticated using a\ntoken source or using <a href=\"/google.golang.org/api/option#WithHTTPClient\">option.WithHTTPClient</a>.
128+
authenticated using a\ntoken source or using <a href=\"https://pkg.go.dev/google.golang.org/api/option#WithHTTPClient\">option.WithHTTPClient</a>.
128129
In this case, you can provide a\nservice account email for GoogleAccessID and
129130
the client will attempt to sign\nthe URL or Post Policy using that service account.\n<p>To
130131
generate the signature, you must have:\n<ul>\n<li>iam.serviceAccounts.signBlob
131132
permissions on the GoogleAccessID service\naccount, and\n<li>the <a href=\"https://console.developers.google.com/apis/api/iamcredentials.googleapis.com/overview\">IAM
132133
Service Account Credentials API</a> enabled (unless authenticating\nwith a downloaded
133134
private key).\n</ul>\n<h2 id=\"hdr-Errors\">Errors</h2>\n<p>Errors returned by
134-
this client are often of the type <a href=\"/google.golang.org/api/googleapi#Error\">googleapi.Error</a>.\nThese
135-
errors can be introspected for more information by using <a href=\"/errors#As\">errors.As</a>\nwith
136-
the richer <a href=\"/google.golang.org/api/googleapi#Error\">googleapi.Error</a>
135+
this client are often of the type <a href=\"https://pkg.go.dev/google.golang.org/api/googleapi#Error\">googleapi.Error</a>.\nThese
136+
errors can be introspected for more information by using <a href=\"https://pkg.go.dev/errors#As\">errors.As</a>\nwith
137+
the richer <a href=\"https://pkg.go.dev/google.golang.org/api/googleapi#Error\">googleapi.Error</a>
137138
type. For example:\n<pre class=\"prettyprint\">var e &#42;googleapi.Error\nif
138139
ok := errors.As(err, &amp;e); ok {\n\t if e.Code == 409 { ... }\n}\n</pre>\n<h2
139140
id=\"hdr-Retrying_failed_requests\">Retrying failed requests</h2>\n<p>Methods

0 commit comments

Comments
 (0)