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

Jump to bottom

wiki: transfer label descriptions from wiki to labels themselves #24023

Closed
dmitshur opened this issue Feb 22, 2018 · 4 comments
Closed

wiki: transfer label descriptions from wiki to labels themselves #24023

dmitshur opened this issue Feb 22, 2018 · 4 comments
Labels
Documentation FrozenDueToAge
Milestone
Unreleased

Comments

@dmitshur
Copy link
Contributor

dmitshur commented Feb 22, 2018 •
edited

Now that GitHub has added descriptions to labels, it would probably be helpful to transfer the label descriptions from https://github.com/golang/go/wiki/IssueLabels to the labels themselves.

I think it would make it easier for more people to discover what the labels mean.

If we do this, I think the wiki page should be removed (maybe not right away, and also having made a backup), to avoid having to maintain same information in two places.

This issue is to consider/discuss this opportunity.
@dmitshur
Copy link
Contributor Author

dmitshur commented Feb 22, 2018 •
edited

An alternative to consider is to keep https://github.com/golang/go/wiki/IssueLabels as the source of truth, because it's easier to see who edited it and it has edit history. Then the label descriptions can be copied over from the wiki page to the labels.

But this has the risk of people editing non-source-of-truth and it becomes harder to resolve conflicts then.

@dgryski
Copy link
Contributor

dgryski commented Feb 22, 2018 •
edited

Can label edits be detected somehow? Or maybe involve Gopherbot?

@bradfitz
Copy link
Contributor

I'm not sure this changes enough to be worth automating. I think enough people have wiki + github edit access that we can just manually keep things in sync. Or we can change the wiki page to just link to https://github.com/golang/go/labels

I added one description at https://github.com/golang/go/labels to test how it renders. Seems fine to just move everything there. The one downside is there are length limitations, but maybe that's a feature.

@bradfitz bradfitz changed the title transfer label descriptions from wiki to labels themselves wiki: transfer label descriptions from wiki to labels themselves Feb 23, 2018
@bradfitz bradfitz added this to the Unreleased milestone Feb 23, 2018
@dmitshur dmitshur mentioned this issue Mar 19, 2018
Open
@agnivade
Copy link
Contributor

agnivade commented Jun 2, 2019

@bradfitz made the change couple of days ago.

@agnivade agnivade closed this as completed Jun 2, 2019
@golang golang locked and limited conversation to collaborators Jun 1, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Documentation FrozenDueToAge
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
5 participants
@bradfitz @dgryski @agnivade @dmitshur @gopherbot