Skip to content

Commit

Permalink
general: move from godoc.org to pkg.go.dev for documentation
Browse files Browse the repository at this point in the history
Per https://blog.golang.org/godoc.org-redirect, godoc traffic will soon
be redirected automatically to pkg.go.dev.

Per the most recent golang-tools call, there is now a push to update
badges/links from godoc.org to pkg.go.dev.

pkg.go.dev is a far superior documentation experience for the CUE docs,
and there are no known blockers/issues that would prevent us migrating.

Most importantly we get a new badge.

Change-Id: Icf3ab495a69a031e5fb141440ba2f296643d5cf6
Reviewed-on: https://cue-review.googlesource.com/c/cue/+/8234
Reviewed-by: Marcel van Lohuizen <mpvl@golang.org>
Reviewed-by: CUE cueckoo <cueckoo@gmail.com>
  • Loading branch information
myitcv committed Jan 29, 2021
1 parent d5d5fd1 commit 7110020
Show file tree
Hide file tree
Showing 7 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
[![GoDoc](https://godoc.org/cuelang.org/go?status.svg)](https://godoc.org/cuelang.org/go)
[![Go Reference](https://pkg.go.dev/badge/cuelang.org/go.svg)](https://pkg.go.dev/cuelang.org/go)
[![Github](https://github.com/cuelang/cue/workflows/Test/badge.svg)](https://github.com/cuelang/cue/actions)
[![GolangCI](https://golangci.com/badges/github.com/cuelang/cue.svg)](https://golangci.com/r/github.com/cuelang/cue)
[![Go 1.13+](https://img.shields.io/badge/go-1.13-9cf.svg)](https://golang.org/dl/)
Expand Down Expand Up @@ -125,9 +125,9 @@ an existing set of Kubernetes configurations is available in

- [Language Specification](./doc/ref/spec.md): official CUE Language specification.

- [API](https://godoc.org/cuelang.org/go/cue): the API on godoc.org
- [API](https://pkg.go.dev/cuelang.org/go/cue): the API on pkg.go.dev

- [Builtin packages](https://godoc.org/cuelang.org/go/pkg): builtins available from CUE programs
- [Builtin packages](https://pkg.go.dev/cuelang.org/go/pkg): builtins available from CUE programs

- [`cue` Command line reference](./doc/cmd/cue.md): the `cue` command

Expand Down
2 changes: 1 addition & 1 deletion pkg/tool/cli/gen.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package main

// TODO: remove when we have a cuedoc server. Until then,
// piggyback on godoc.org.
// piggyback on pkg.go.dev.

import (
"bytes"
Expand Down
2 changes: 1 addition & 1 deletion pkg/tool/exec/gen.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package main

// TODO: remove when we have a cuedoc server. Until then,
// piggyback on godoc.org.
// piggyback on pkg.go.dev.

import (
"bytes"
Expand Down
2 changes: 1 addition & 1 deletion pkg/tool/file/gen.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package main

// TODO: remove when we have a cuedoc server. Until then,
// piggyback on godoc.org.
// piggyback on pkg.go.dev.

import (
"bytes"
Expand Down
2 changes: 1 addition & 1 deletion pkg/tool/gen.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package main

// TODO: remove when we have a cuedoc server. Until then,
// piggyback on godoc.org.
// piggyback on pkg.go.dev.

import (
"bytes"
Expand Down
2 changes: 1 addition & 1 deletion pkg/tool/http/gen.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package main

// TODO: remove when we have a cuedoc server. Until then,
// piggyback on godoc.org.
// piggyback on pkg.go.dev.

import (
"bytes"
Expand Down
2 changes: 1 addition & 1 deletion pkg/tool/os/gen.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package main

// TODO: remove when we have a cuedoc server. Until then,
// piggyback on godoc.org.
// piggyback on pkg.go.dev.

import (
"bytes"
Expand Down

0 comments on commit 7110020

Please sign in to comment.