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

proposal: introduce new html meta tag for issue trackers #19725

Open
rakyll opened this issue Mar 27, 2017 · 3 comments

Comments

@rakyll
Copy link
Member

commented Mar 27, 2017

For the users of the packages with vanity import paths uses, it is often impossible to find the package's issue tracker to file an issue. The package maintainers often have to manually add a link to the package comment to ensure that users will be able to find the package's issue tracker. This process is tedious and adding more noise to the godoc.

I propose to introduce a new meta tag for our vanity URL redirect pages, so that the package owners can set the location of the package's issue tracker.

<meta name="go-import" content="cloud.google.com/go git https://code.googlesource.com/gocloud">
<meta name="go-source" content="cloud.google.com/go https://github.com/GoogleCloudPlatform/gcloud-golang https://github.com/GoogleCloudPlatform/gcloud-golang/tree/master{/dir} https://github.com/GoogleCloudPlatform/gcloud-golang/tree/master{/dir}/{file}#L{line}">

<meta name="go-issues" content="cloud.google.com/go https://github.com/GoogleCloudPlatform/gcloud-golang/issues">

Once a meta tag is introduced, the Go tools (such as godoc.org) can display a link to the issue tracker on the package page.

@rakyll rakyll added the Proposal label Mar 27, 2017

@mvdan

This comment has been minimized.

Copy link
Member

commented Mar 27, 2017

Out of curiosity - how often does the source link not contain the issue tracker (such as in a GitHub repo)?

@gopherbot gopherbot added this to the Proposal milestone Mar 27, 2017

@rakyll

This comment has been minimized.

Copy link
Member Author

commented Mar 27, 2017

I don't have much data around this.

Some more questions... Source may live somewhere else but the issue tracker might be on GitHub. Source may live on GitHub but issue tracker may not not. How many providers should we support? Do we want to auto identify issue trackers by looking at the source? Is that expected by the the package maintainer that we automatically show an issue tracker link?

Suggesting a meta tag is the most conservative approach I could think of, that's why I kept the proposal very limited to a specific case.

@rsc

This comment has been minimized.

Copy link
Contributor

commented Mar 27, 2017

This fits into the overall package management story as well. I think we should put this on hold until that's clearer.

@rsc rsc changed the title proposal: introduce new vanity import path meta tag for issue trackers proposal: introduce new html meta tag for issue trackers Mar 27, 2017

@rsc rsc added the Proposal-Hold label Mar 27, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.