Skip to content

Import and freshen FAQ #71

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

Closed
ajpiano opened this issue Mar 14, 2012 · 4 comments
Closed

Import and freshen FAQ #71

ajpiano opened this issue Mar 14, 2012 · 4 comments

Comments

@ajpiano
Copy link
Member

ajpiano commented Mar 14, 2012

Start with importing the very frequently linked http://docs.jquery.com/Frequently_Asked_Questions page
then clean it up

  • 1.8 needs to use .prop instead of .attr
  • 1.11 How do I compress my code needs to be brought up to date (mention Uglify)
  • 1.12 Needs to link to bugs.jquery.com
  • 1.13 should probably be eventually broken into its own article on learning how to think async.
  • 2.1.1 needs to mention .on() and .off()

There are probably a lot of other FAQ's we could come up with just from brainstorming for a few more minutes. I think we should give some consideration to making the "How To" category become FAQs, and have FAQ answers on separate pages. There are advantages to the monolithic "FAQ page," so I'm curious for whether @kswedberg or @addyosmani or others think we should ditch it (for separate pages) or expand it.

@addyosmani
Copy link
Member

For me, the FAQ page has always been something of a 'Show me what I can do with jQuery' high-level summary that someone could read in 5-10 minutes. There are benefits to it being left in it's current form (very fast reference), however, splitting it out into separate pages has the advantage of more room to go into detail or expand on examples if we wanted. I also don't think it would be that much more effort to click to a link to view an answer so my vote goes for separation.

@kswedberg
Copy link
Member

My vote goes for keeping it in one file and adding to it judiciously. My observation has been that people really like having a quick reference that they can go to when "I know I must be doing something wrong but I don't know what it is." And it's really nice for people answering questions on IRC and whatnot to have a consolidated "go-to" page for the things that people ask millions of times a day. The beauty of rolling this FAQ page into the new site is that we don't have to go into great detail on any one answer. We can give the overview answer and then say "Still confused about why you're getting a parse error for your ajax response? Learn more in our super detailed article about JSON", or "Now that you know why your events 'stop working' after you insert new content into the DOM and you've learned how to avoid the problem using .delegate() or passing the selector argument with .on(), take your learning to the next level with these three articles on event delegation: 1, 2, 3." Or whatever.

@ajpiano
Copy link
Member Author

ajpiano commented Mar 15, 2012

Hm. I don't think we lose the "quick reference" aspect if we divide it up into several pages. There's a lot of other things that come up a million times a day that aren't in the FAQ already, and people will be linked to atomic different pages on the learning site. I think we are still free to go into not that much detail and link on any given question, but breaking it apart frees us to go into as much detail as we like. Breaking it apart does complicate things from a redirect standpoint as well.

@ghost ghost assigned RedWolves Oct 15, 2012
@RedWolves
Copy link
Member

I am going to work on this now at the Dev Summit.

addyosmani added a commit that referenced this issue Oct 16, 2012
Added the 'How do I...' FAQs for issue #71
arthurvr pushed a commit to arthurvr/learn.jquery.com that referenced this issue Jan 4, 2015
arthurvr pushed a commit to arthurvr/learn.jquery.com that referenced this issue Jan 4, 2015
Added the 'How do I...' FAQs for issue jquery#71
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

4 participants