Skip to content

Commit

Permalink
Replace godoc with pkg (#874)
Browse files Browse the repository at this point in the history
180909 authored Jun 7, 2024

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
1 parent 4d8fe93 commit b98b052
Showing 7 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .doc/overview.asciidoc
Original file line number Diff line number Diff line change
@@ -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]


2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 1 addition & 1 deletion _examples/README.md
Original file line number Diff line number Diff line change
@@ -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

2 changes: 1 addition & 1 deletion _examples/fasthttp/README.md
Original file line number Diff line number Diff line change
@@ -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`.
2 changes: 1 addition & 1 deletion _examples/instrumentation/README.md
Original file line number Diff line number Diff line change
@@ -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.

<a href="https://asciinema.org/a/KhyP3GuuHPJAZQAmrgmdwS7uf" target="_blank"><img src="https://asciinema.org/a/KhyP3GuuHPJAZQAmrgmdwS7uf.svg" width="750" /></a>

2 changes: 1 addition & 1 deletion esapi/doc.go
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion internal/build/cmd/generate/commands/gentests/model.go
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit b98b052

Please sign in to comment.