Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Point documentation to pkg.go.dev #455

Closed
wants to merge 2 commits into from

Conversation

damienstanton
Copy link

Most projects have moved away from godoc.org as the standard hosting site for generated documentation. This PR updates the reference link and badge, accordingly.

Most projects have moved away from godoc.org as the standard hosting site for generated documentation. This PR updates the reference link and badge, accordingly.
@damienstanton
Copy link
Author

Note that I just signed an ECA, so this might require a manual trigger to get that check to pass.

Signed-off-by: Damien Stanton <damien.stanton@gmail.com>
@MattBrittan
Copy link
Contributor

Note: Before doing this we need to look at how the license info is stored. Currently it appears that google does not detect the licenses (as seen here) meaning that the documentation will not be visible; this is likely to become an issue when we make the next release (if this commit is merged).

@damienstanton - unfortunately to pass the automated test the "Signed-off-by" entry (more info here) needs to be on all commits. Signing out the offending commit and using git commit --amend --signoff seemed to work when I had this issue.

@MattBrittan
Copy link
Contributor

I have significantly updated the README (#461) and to complete this have just raised #462 which makes the change you raised as well as a few others:

  • Changes the link further down the document
  • Updates the LICENSE file so that pkg.go.dev will display the documentation when the next version is released.

Thanks very much for your contribution and apologies for duplicating it in another request (hopefully we can release v1.3.0 shortly so I wanted to test that the documentation links will continue to function).

@MattBrittan
Copy link
Contributor

Closing this PR because the changes were implemented in PR #462 (which made further changes to avoid issues with the license file). Thanks for pointing out the issue and raising a PR.

@MattBrittan MattBrittan closed this Dec 7, 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.

None yet

2 participants