Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.
Sign upRetain the FAQ? #291
Comments
aturon
added
question
content
labels
Nov 18, 2018
This comment has been minimized.
This comment has been minimized.
|
i actually kinda strongly want to get rid of the FAQ. to me it felt like it was growing a bunch and wasn't super helpful. we have so many audiences that their frequently asked questions..are well, it's hard to make and maintain one. i would much rather grow sets of books - if different teams e.g. the lang team wanted to keep and maintain an FAQ i think that sounds good, but i dont think it's good to maintain on the website. |
This comment has been minimized.
This comment has been minimized.
|
We shouldn't lose the FAQ altogether -- it's gone through an enormous set of iterations and has some really helpful material. But I agree that it makes more sense to separate out more like we do for books, and put it under the purview of the Docs Team rather than the site itself. |
This comment has been minimized.
This comment has been minimized.
|
strong agree on not losing the content @aturon i think it could be a good book on its own, or perhaps there are good elements that could make FAQs for different team books (that may or may not yet exist). i just dont think maintaining it on the website makes sense at the scale it's currently at. |
This comment has been minimized.
This comment has been minimized.
|
Or do you think that we should have a light-weight FAQ page? Focusing only on the website's main target users and re-directing others. |
This comment has been minimized.
This comment has been minimized.
|
I think it could make sense to have a short FAQ page that mostly just directs people to various books; kind of like the bookshelf but worded in a Q&A format perhaps? |
ashleygwilliams
assigned
aturon
Nov 28, 2018
ashleygwilliams
added
the
needs decision
label
Nov 28, 2018
This comment has been minimized.
This comment has been minimized.
Centril
commented
Nov 28, 2018
|
Maybe we could have a per-team FAQ? |
This comment has been minimized.
This comment has been minimized.
|
@Centril i think that's an OK idea but i can imagine that teams may struggle to keep it maintained. in general- i think this is something the docs team should own (cc @steveklabnik) and that we can link to from the site, but should not be content maintained on the site. |
This comment has been minimized.
This comment has been minimized.
|
assuming the docs team is open to managing this, i would like to close this issue as it will then become an issue for the docs team to handle. |
ashleygwilliams
added
waiting on response
and removed
needs decision
labels
Nov 29, 2018
This comment has been minimized.
This comment has been minimized.
Centril
commented
Nov 29, 2018
That's seems OK; There are some team policy notes (e.g. wrt. the globality of inference, ...) in the FAQ tho but I suppose that the lang team or other teams can work together with the docs team on this if and when team policies change.
I absolutely agree with this. :) The location is much less important than the content being available. |
This comment has been minimized.
This comment has been minimized.
|
Personal bias alert: I really don't like FAQs. It's also been a real maintenance burden in the past. There is some useful information there though... |
This comment has been minimized.
This comment has been minimized.
AndrewBrinker
commented
Nov 29, 2018
|
My two cents: the FAQ has a ton of useful information, but collecting it all here makes it not particularly accessible. Examples:
I had a great time working on the first version of the FAQ, and I think it's been a worthwhile effort and resource, but it's also probably run its course. |
aturon commentedNov 18, 2018
The FAQ on the old web site is a pretty enormous resource that was always relatively buried. We need to figure out how that fits in the new web site.