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

doc: populate the PriorDiscussion wiki page #18430

Closed
bradfitz opened this issue Dec 25, 2016 · 17 comments
Closed

doc: populate the PriorDiscussion wiki page #18430

bradfitz opened this issue Dec 25, 2016 · 17 comments

Comments

@bradfitz
Copy link
Contributor

There are many questions that aren't in our FAQ, but which people ask with some frequency.

See the recent #18425 for the latest example. It'd be nice if we could reply with a URL, instead of "search the history"

Normally additions to the FAQ are denied with the reason that the proposed new Asked Question is not Frequent.

So let's create a separate page (a wiki page, probably, so more people can edit) with many more Q&A, and link to old mailing list discussion threads and bugs, so we don't have to close bugs without pointing the author at something for them to read.

@as
Copy link
Contributor

as commented Dec 25, 2016

Perhaps there should be a section about frequently-requested features. The author of a feature request would first search this section to see if their feature has already been discussed.

@bradfitz
Copy link
Contributor Author

@as, yes, the Q&A could have many sections, and that would be one.

@robpike
Copy link
Contributor

robpike commented Dec 26, 2016

Is there a reason not to put these in the FAQ, perhaps as a special section. FRF (frequently requested features)

@bradfitz
Copy link
Contributor Author

bradfitz commented Dec 26, 2016

@robpike, I don't want to go through gatekeepers and English review and Gerrit for content that the community could collaborate on quickly. The goal is content and answers (or at least links to background reading), not quality of prose. Any answer for these is better than no answers (the current state).

@robpike
Copy link
Contributor

robpike commented Dec 26, 2016

Sounds like a role for the wiki, not something checked in.

@bradfitz
Copy link
Contributor Author

Yup.

@as
Copy link
Contributor

as commented Dec 27, 2016

If it helps, This sheet lists features I've frequently seen requested.

The FAQ already discusses some specific feature requests (unions and concurrent map access), so It may be useful to have a link to the wiki here:

https://golang.org/doc/faq#Why_doesnt_Go_have_feature_X

@kennygrant
Copy link
Contributor

Perhaps you could just add a new section to the existing 'Questions' page on the wiki for this?

https://github.com/golang/go/wiki/Questions

@rsc
Copy link
Contributor

rsc commented Jan 4, 2017

It sounds like you are proposing a wiki/Answers page or something. OK, LGTM. Proposal accepted.

@rsc rsc added this to the Soon milestone Jan 4, 2017
@bradfitz
Copy link
Contributor Author

bradfitz commented Jan 4, 2017

@kennygrant, we don't pay Github per wiki page, so no need to overload that page with multiple meanings.

I've created https://golang.org/wiki/PriorDiscussion which I hope others can help me flesh out over the next few weeks.

I'll repurpose this bug about adding to it.

@bradfitz bradfitz changed the title doc: create a Q&A doc: populate the PriorDiscussion wiki page Jan 4, 2017
@bradfitz
Copy link
Contributor Author

bradfitz commented Jan 4, 2017

I propose that our new policy when closing bugs is to never say:

Sorry, no, this has been discussed before. Go search.

If two people have brought it up before, there will probably be three, and it deserves an entry in https://golang.org/wiki/PriorDiscussion .

And then after adding such an entry, we should reply instead with:

See prior discussion at https://golang.org/wiki/PriorDiscussion#panics-on-sends-or-closes-of-closed-channel.

/cc @minux @odeke-em

@davecheney
Copy link
Contributor

davecheney commented Jan 4, 2017 via email

@bradfitz
Copy link
Contributor Author

bradfitz commented Jan 4, 2017

Also, if you see a good thread with good discussion or a good explanation, add it anyway, even if it's the first time you've seen it. The PriorDiscussion page can also just be an index of good discussion that's happened in the past for interested readers.

@ALTree
Copy link
Member

ALTree commented Jan 5, 2017

I tried to send a change to https://golang.org/wiki/PriorDiscussion thinking that I was creating a "pull request" of some sort - to be reviewed - but it just changed the page straight away (??).

Well, that's strange. BTW there's two more links now.

@bradfitz
Copy link
Contributor Author

bradfitz commented Jan 5, 2017

No need for code review. Append at will.

Thanks!

@odeke-em
Copy link
Member

odeke-em commented Jan 5, 2017

SGTM! Thank you @bradfitz for the idea.

@bradfitz bradfitz added Soon This needs to be done soon. (regressions, serious bugs, outages) and removed Soon This needs to be done soon. (regressions, serious bugs, outages) labels May 17, 2018
@bradfitz bradfitz modified the milestones: Soon, Unplanned May 17, 2018
@bradfitz
Copy link
Contributor Author

This happened.

@golang golang locked and limited conversation to collaborators May 28, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

9 participants