Skip to content

Fix GoDoc link at the top of the README file#2387

Merged
mtrmac merged 1 commit intocontainers:mainfrom
ananthb:fix-godoc-link
Apr 29, 2024
Merged

Fix GoDoc link at the top of the README file#2387
mtrmac merged 1 commit intocontainers:mainfrom
ananthb:fix-godoc-link

Conversation

@ananthb
Copy link
Contributor

@ananthb ananthb commented Apr 26, 2024 •
edited
Loading

I was really puzzled by the broken documentation at the current link. This version bump should fix it.

mtrmac
mtrmac reviewed Apr 26, 2024
View reviewed changes
Copy link
Collaborator

@mtrmac mtrmac left a comment

Choose a reason for hiding this comment

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

Thanks!

Could you update the links further, to point directly at the pkg.go.dev host name?

@ananthb
Fix GoDoc link at the top of the README file
487afc9 
Signed-off-by: Ananth Bhaskararaman <antsub@gmail.com>
@ananthb
Copy link
Contributor Author

ananthb commented Apr 26, 2024

I created the badge link again with their badge generation tool.

@ananthb ananthb requested a review from mtrmac April 26, 2024 20:44
@ananthb
Copy link
Contributor Author

ananthb commented Apr 26, 2024

I also cleaned up the README language and links a bit here: 9bc780a.

I can add that commit to this PR if that works for you.

mtrmac
mtrmac approved these changes Apr 29, 2024
View reviewed changes
Copy link
Collaborator

@mtrmac mtrmac left a comment

Choose a reason for hiding this comment

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

Thanks!

@mtrmac
Copy link
Collaborator

mtrmac commented Apr 29, 2024

I also cleaned up the README language and links a bit here

Some parts of that (like updating for the link redirect) are clearly valuable in isolation.

OTOH parts of the README description are to a large extent a historical artifact of how this library was split from skopeo, and should ideally be replaced wholesale — so incremental improvements to the wording would not be the best use of anyone’s time. (Not that I can immediately prioritize those wholesale replacements, either…)

@mtrmac mtrmac merged commit d7adcab into containers:main Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mtrmac mtrmac mtrmac approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ananthb @mtrmac