GNOME Bugzilla – Bug 673338
"Hello World" JavaScript tutorial incomplete, has spelling/grammar errors, could use improvement
Last modified: 2012-04-02 14:45:16 UTC
PERSONAL COMMENT / SUMMARY I think it's great that GNOME's including basic, beginner-level, step-by-step tutorials, and I took the "Hello World" one and was able to put together my first GNOME app ever. Go me! And thanks, Susanna :) I noticed a few errors though and felt it could use some improvement, so I wrote up a .patch file and here it is! Along with a more detailed description. Many thanks to bithin, gpoo, and the others who helped me on #docs. PROBLEM The tutorial found at http://developer.gnome.org/gnome-devel-demos/unstable/helloWorld.js.html.en * Incorporates spelling, grammatical, and stylistic errors * Leaves out line 16 of the finalized script (label.show();) from the step-by-step instructions * Tells users about chmod +x and flagging the script as an executable before the finalized script is saved to disk, and does not revisit the topic right at the end where it's actually needed * Could use some improvement and formatting in general HOW TO REPRODUCE 1. Take the tutorial as a GNOME novice. EXPECTED BEHAVIOUR GNOME will have reader-friendly, accessible, concise documentation, which explains all steps of contributing to the GNOME project and of writing apps for the GNOME platform. SUMMARY OF INCLUDED PATCH Rewrites the tutorial to fix the bugs mentioned. Also makes a minor change to the JavaScript tutorial intro.
Created attachment 211108 [details] The rewritten file because I'm having trouble creating a patch. I'm having trouble creating a patch, and am attaching the rewritten file itself until I figure out how.
Created attachment 211112 [details] [review] The actual patch: Many thanks to gpoo on #docs for helping me wrangle git!
Created attachment 211113 [details] [review] A fixed version of the patch The first time I tried to submit a patch, it had a small bug (a non-closed tag) in it.
Review of attachment 211113 [details] [review]: Thank you for your patch. Nice Work. The tutorials in general are a work in progress, and help is very appreiciated.
The patch has been pushed to the master branch: http://git.gnome.org/browse/gnome-devel-docs/commit/?id=4071b8fef60c6dc145664de0a9b0cbcab92655d9 I edited the commit message slightly to be more specific (as there is also a helloword in other programming languages here).