From b98b0526172f08d52c000410112a5a5d2d57fa2e Mon Sep 17 00:00:00 2001 From: 180909 Date: Fri, 7 Jun 2024 16:47:33 +0800 Subject: [PATCH] Replace godoc with pkg (#874) --- .doc/overview.asciidoc | 2 +- README.md | 2 +- _examples/README.md | 2 +- _examples/fasthttp/README.md | 2 +- _examples/instrumentation/README.md | 2 +- esapi/doc.go | 2 +- internal/build/cmd/generate/commands/gentests/model.go | 2 +- 7 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.doc/overview.asciidoc b/.doc/overview.asciidoc index a593c3d77a..2749aaa32c 100644 --- a/.doc/overview.asciidoc +++ b/.doc/overview.asciidoc @@ -45,7 +45,7 @@ at https://github.com/elastic/go-elasticsearch/tree/master/_examples. === Resources * https://github.com/elastic/go-elasticsearch[Source Code] -* https://godoc.org/github.com/elastic/go-elasticsearch[API Documentation] +* https://pkg.go.dev/github.com/elastic/go-elasticsearch[API Documentation] * https://github.com/elastic/go-elasticsearch/tree/master/_examples[Examples and Recipes] diff --git a/README.md b/README.md index 3cbeeb7f85..25b97af73a 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ or **[sign-up](https://cloud.elastic.co/registration?elektra=en-ess-sign-up-page)** **for a free trial of Elastic Cloud**. -[![GoDoc](https://godoc.org/github.com/elastic/go-elasticsearch?status.svg)](https://pkg.go.dev/github.com/elastic/go-elasticsearch/v8) +[![Go Reference](https://pkg.go.dev/github.com/elastic/go-elasticsearch?status.svg)](https://pkg.go.dev/github.com/elastic/go-elasticsearch/v8) [![Go Report Card](https://goreportcard.com/badge/github.com/elastic/go-elasticsearch)](https://goreportcard.com/report/github.com/elastic/go-elasticsearch) [![codecov.io](https://codecov.io/github/elastic/go-elasticsearch/coverage.svg?branch=main)](https://codecov.io/gh/elastic/go-elasticsearch?branch=main) [![Build](https://github.com/elastic/go-elasticsearch/workflows/Build/badge.svg)](https://github.com/elastic/go-elasticsearch/actions?query=branch%3Amain) diff --git a/_examples/README.md b/_examples/README.md index 89de9c5c6f..3a4cd2272b 100644 --- a/_examples/README.md +++ b/_examples/README.md @@ -19,7 +19,7 @@ and client helper methods for a more efficient encoding and decoding of the requ ## Fast HTTP -The [**`fasthttp`**](./fasthttp) directory contains a demonstration of replacing the default client transport with an HTTP client from the [`github.com/valyala/fasthttp`](https://godoc.org/github.com/valyala/fasthttp) package. +The [**`fasthttp`**](./fasthttp) directory contains a demonstration of replacing the default client transport with an HTTP client from the [`github.com/valyala/fasthttp`](https://pkg.go.dev/github.com/valyala/fasthttp) package. ## Instrumentation diff --git a/_examples/fasthttp/README.md b/_examples/fasthttp/README.md index 7c94ae2a57..198af14194 100644 --- a/_examples/fasthttp/README.md +++ b/_examples/fasthttp/README.md @@ -1,7 +1,7 @@ # Example: fasthttp This example demonstrates how to replace the `net/http` transport in the client with an -HTTP client from the [`github.com/valyala/fasthttp`](https://godoc.org/github.com/valyala/fasthttp) package. +HTTP client from the [`github.com/valyala/fasthttp`](https://pkg.go.dev/github.com/valyala/fasthttp) package. The [`fasthttp.Transport` type](./fasthttp.go) is a drop-in replacement for `elastictransport.Config.Transport`, converting request and response object between `net/http` and `fasthttp`. diff --git a/_examples/instrumentation/README.md b/_examples/instrumentation/README.md index 4cc31bd4a8..34c80adab0 100644 --- a/_examples/instrumentation/README.md +++ b/_examples/instrumentation/README.md @@ -4,7 +4,7 @@ This example demonstrates how to instrument the Elasticsearch client. ### OpenCensus -The [**`opencensus.go`**](./opencensus.go) example uses the [`ochttp.Transport`](https://godoc.org/go.opencensus.io/plugin/ochttp#example-Transport) wrapper to auto-instrument the client calls, and provides a simple exporter which prints information to the terminal. +The [**`opencensus.go`**](./opencensus.go) example uses the [`ochttp.Transport`](https://pkg.go.dev/go.opencensus.io/plugin/ochttp#example-Transport) wrapper to auto-instrument the client calls, and provides a simple exporter which prints information to the terminal. diff --git a/esapi/doc.go b/esapi/doc.go index 73d4788c4e..d573b88b46 100644 --- a/esapi/doc.go +++ b/esapi/doc.go @@ -73,7 +73,7 @@ It has a minor overhead compared to using a struct directly; refer to the esapi_benchmark_test.go suite for concrete numbers. See the documentation for each API function or struct at -https://godoc.org/github.com/elastic/go-elasticsearch, +https://pkg.go.dev/github.com/elastic/go-elasticsearch, or locally by: go doc github.com/elastic/go-elasticsearch/v8/esapi Index diff --git a/internal/build/cmd/generate/commands/gentests/model.go b/internal/build/cmd/generate/commands/gentests/model.go index c2315a1db4..a306d7614f 100644 --- a/internal/build/cmd/generate/commands/gentests/model.go +++ b/internal/build/cmd/generate/commands/gentests/model.go @@ -415,7 +415,7 @@ func (a Action) Params() map[string]interface{} { // Condition returns the condition for the assertion. // -// TODO: Evaulate https://godoc.org/github.com/google/go-cmp/cmp +// TODO: Evaulate https://pkg.go.dev/github.com/google/go-cmp/cmp func (a Assertion) Condition() string { var ( output string