Skip to content

README.md: Use go.dev instead of godoc#4681

Merged
dmcgowan merged 1 commit intocontainerd:masterfrom
fuweid:update-godoc-badge
Nov 2, 2020
Merged

README.md: Use go.dev instead of godoc#4681
dmcgowan merged 1 commit intocontainerd:masterfrom
fuweid:update-godoc-badge

Conversation

@fuweid
Copy link
Copy Markdown
Member

@fuweid fuweid commented Oct 31, 2020

Signed-off-by: Wei Fu [email protected]

@theopenlab-ci
Copy link
Copy Markdown

theopenlab-ci Bot commented Oct 31, 2020

Build succeeded.

Copy link
Copy Markdown
Member

@estesp estesp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Comment thread README.md
![containerd banner](https://raw.githubusercontent.com/cncf/artwork/master/projects/containerd/horizontal/color/containerd-horizontal-color.png)

[![GoDoc](https://godoc.org/github.com/containerd/containerd?status.svg)](https://godoc.org/github.com/containerd/containerd)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/containerd/containerd)](https://pkg.go.dev/github.com/containerd/containerd)
Copy link
Copy Markdown
Member

@thaJeztah thaJeztah Oct 31, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like there's two possible landing pages;

Wondering which one is more appropriate?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The latter one.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agree.. the latter one.. more tabs... users coming from our repo readme don't need to land on another copy of the readme.. and both landing pages include link backs to the repo..

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thaJeztah I generated it from https://pkg.go.dev/badge/ and I think the later one is better as Mike said. :p

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

users coming from our repo readme don't need to land on another copy of the readme

Ah, yes, that's fair.

I got somewhat confused, because the first link showed "overview" as first tab, so felt more like an "entry point" to the project. (the second one shows the same info, but now as second tab 🤷‍♂️). I guess my confusion was because the old godoc.org also shows the subpackages/directories on the landing page, whereas the new layout only shows the root package, and hides subdirectories/packages in the third tab

Copy link
Copy Markdown
Contributor

@Zyqsempai Zyqsempai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Member

@mikebrow mikebrow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Member

@dmcgowan dmcgowan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dmcgowan dmcgowan merged commit 394be74 into containerd:master Nov 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants