Bug 32112 - Centralize web site instructions on using WebKit scripts
Summary: Centralize web site instructions on using WebKit scripts
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: WebKit Website (show other bugs)
Version: 528+ (Nightly build)
Hardware: All All
: P4 Minor
Assignee: Nobody
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-12-03 03:11 PST by Chris Jerdonek
Modified: 2009-12-05 16:30 PST (History)
3 users (show)

See Also:


Attachments
Proposed patch (16.25 KB, patch)
2009-12-03 03:23 PST, Chris Jerdonek
no flags Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Jerdonek 2009-12-03 03:11:59 PST
Five different pages on the WebKit site include the same advice to add WebKit/WebKitTools/Scripts to your shell path.  It would be good to centralize the general advice on how to use the scripts so the documentation is more concise and easier to maintain.
Comment 1 Chris Jerdonek 2009-12-03 03:23:41 PST
Created attachment 44223 [details]
Proposed patch

The WebKit/WebKitTools/Scripts path now appears on only one page.

Also fixed a few minor typos, validation issues, etc.
Comment 2 WebKit Review Bot 2009-12-03 03:27:18 PST
style-queue ran check-webkit-style on attachment 44223 [details] without any errors.
Comment 3 Darin Adler 2009-12-04 11:55:23 PST
Comment on attachment 44223 [details]
Proposed patch

This seems OK. r=me

The real test is how many people are able to successfully use the the website and follow the instructions without having to ask people on the mailing list. We used to get a lot of "I can't build WebKit" emails on the webkit-dev mailing list.
Comment 4 Chris Jerdonek 2009-12-04 20:03:59 PST
(In reply to comment #3)
> (From update of attachment 44223 [details])
> This seems OK. r=me
> 
> The real test is how many people are able to successfully use the the website
> and follow the instructions without having to ask people on the mailing list.
> We used to get a lot of "I can't build WebKit" emails on the webkit-dev mailing
> list.

Understood.  An advantage of the approach taken in this patch is that if people need extra "hand-holding" to use the command-line (like with modifying their shell path), we can put those extra details in the new page this patch creates and make that page extra clear.
Comment 5 WebKit Commit Bot 2009-12-05 16:30:37 PST
Comment on attachment 44223 [details]
Proposed patch

Clearing flags on attachment: 44223

Committed r51733: <http://trac.webkit.org/changeset/51733>
Comment 6 WebKit Commit Bot 2009-12-05 16:30:43 PST
All reviewed patches have been landed.  Closing bug.