Reviewed by Darin. Landed by Maciej.
authormjs <mjs@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 7 Feb 2006 09:29:20 +0000 (09:29 +0000)
committermjs <mjs@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 7 Feb 2006 09:29:20 +0000 (09:29 +0000)
        - Several fixes to the site
        http://bugzilla.opendarwin.org/show_bug.cgi?id=7105

        * blog/wp-content/themes/webkit/style.css:
        * index.html:
        * quality/bugwriting.html:
        * quality/reduction.html:
        * webkitdev.css:

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@12639 268f45cc-cd09-0410-ab3c-d52691b4dbfc

WebKitSite/ChangeLog
WebKitSite/blog/wp-content/themes/webkit/style.css
WebKitSite/index.html
WebKitSite/quality/bugwriting.html
WebKitSite/quality/reduction.html
WebKitSite/webkitdev.css

index 25a3f84..d5e02a6 100644 (file)
@@ -1,3 +1,16 @@
+2006-02-07  Joost de Valk  <jdevalk@opendarwin.org>
+
+        Reviewed by Darin. Landed by Maciej.
+        
+        - Several fixes to the site
+        http://bugzilla.opendarwin.org/show_bug.cgi?id=7105
+
+        * blog/wp-content/themes/webkit/style.css:
+        * index.html:
+        * quality/bugwriting.html:
+        * quality/reduction.html:
+        * webkitdev.css:
+
 2006-02-05  Eric Seidel  <eseidel@apple.com>
 
         Reviewed by darin.
index 0133be8..583e9df 100644 (file)
@@ -22,6 +22,7 @@ body {
 
 #content {
        font-size: 10pt;
+       line-height: 140%;
         margin-right: 201px;
         margin-top: 12px;
         margin-left: 12px;
index d3cfc8e..2370274 100644 (file)
@@ -16,27 +16,38 @@ The WebKit Open Source Project
 
 <div id="content">
 <div class="article">
-<h3>It's Open!</h3>
+<h3>Welcome to the web site for the WebKit Open Source Project!</h3>
 <div class="articlebody">
+<p>
 <img align=right src="images/welcomeopen.gif" width=72 height=56>
-Welcome to the web site for the WebKit Open Source Project.  WebKit is the system framework used on Mac OS X by <a href="http://www.apple.com/safari/">Safari</a>, Dashboard, Mail.app,
-and many other OS X applications.  It is based on the <A href="http://khtml.info">KHTML</a> engine from <a href="http://kde.org/">KDE</a>.
-
-<p>There are many ways in which you can get involved with the project.  You can <a href="building/checkout.html">check out the source code</a>
-to try out the latest version of WebKit in your Safari browser.  Once you have the source you can <a href="building/build.html">build it</a>
-and <a href="quality/reporting.html">report bugs</a> you find in the software.  You can help out with bugs by providing
-<a href="quality/reduction.html">reductions</a> or by submitting <a href="coding/contributing.html">patches for review</a>. Contributors with a proven
-track record of good patches will be given check-in access to the repository.</p>
-
-<p>More information about WebKit can be found on its <a href="http://www.opendarwin.org/wiki/index.php/WebKit">wiki</a>. You can help here too, by
-adding information that can help others learn about WebKit.</a></p?
-
-<p>There are many exciting <a href="projects/index.html">projects</a> that you can contribute to.  Come help us improve 
-<a href="projects/compat/index.html">Web site compatibility</a>, 
-write <a href="projects/documentation/index.html">documentation</a>, test WebKit on your hardware, help implement
-new standards like <a href="projects/svg/index.html">SVG</a> and 
-<a href="projects/mathml/index.html">MathML</a>, or help enhance our existing standards support for technologies like 
-<a href="projects/css/index.html">CSS</a> and the <a href="projects/dom/index.html">DOM</a>.  The code is all here, live and ready to be hacked on!</p>
+WebKit is the system framework used on Mac OS X by <a href="http://www.apple.com/safari/">Safari</a>, 
+Dashboard, Mail.app, and many other OS X applications.  It is based on the <A href="http://khtml.info">KHTML</a> engine from <a href="http://kde.org/">KDE</a>.
+</p>
+<p>
+<h4>Getting involved</h4>
+There are many ways in which you can get involved with the project.  You can either <a href="building/checkout.html">check out</a> and 
+<a href="building/build.html">build the source code</a> or <a href="http://nigthly.webkit.org/">download the latest nightly build</a> to try out the latest 
+version of WebKit in your Safari browser.  Once you have either of these, you can <a href="quality/reporting.html">report bugs</a> you find in the software.  
+You can help out with bugs by providing <a href="quality/reduction.html">reductions</a> or by submitting <a href="coding/contributing.html">patches for 
+review</a>. Contributors with a proven track record of good patches will be given check-in access to the repository.
+</p>
+
+<p>
+<h4>More info</h4>
+More information about WebKit can be found on its <a href="http://www.opendarwin.org/wiki/index.php/WebKit">wiki</a>. You can help here too, by
+adding information that can help others learn about WebKit. If you have more questions, <a href="mailto:webkit-dev@opendarwin.org">mail the mailinglist</a>
+or join the team of developers, testers and other people in <a href="irc://irc.freenode.net/#webkit">#webkit on irc.freenode.net</a>. You can
+also <a href="http://cia.navi.cx/stats/project/webkit">track our activity on CIA</a>.
+</p>
+
+<p>
+<h4>Projects</h4>
+There are many exciting <a href="projects/index.html">projects</a> that you can contribute to.  Come help us improve <a href="projects/compat/index.html">
+Web site compatibility</a>, write <a href="projects/documentation/index.html">documentation</a>, test WebKit on your hardware, help implement
+new standards like <a href="projects/svg/index.html">SVG</a> and <a href="projects/mathml/index.html">MathML</a>, or help enhance our existing standards 
+support for technologies like <a href="projects/css/index.html">CSS</a> and the <a href="projects/dom/index.html">DOM</a>. The code is all here, live and 
+ready to be hacked on!
+</p>
 
 </div>
 
index f0e3ebf..1deb533 100644 (file)
@@ -5,8 +5,23 @@
  http-equiv="content-type">
   <title>Bug Writing</title>
   <link rel=stylesheet href="../webkitdev.css">
+  <script type="text/javascript">
+       function version_set() {
+       var regex;
+        var matches;
+
+               regex = new RegExp("Mozilla/5.0 \\(.*\\) AppleWebKit/(.*) \\(KHTML, like Gecko\\) Safari/(.*)");
+               matches = regex.exec(navigator.userAgent);
+               if (matches)
+        {
+               document.getElementById('webkit_version').innerHTML = "<strong>You are currently using: <tt>" + matches[1] + ".</tt></strong><br><br>";
+                       document.getElementById('webkit_version').style.display = "block";
+                       webKitVersion = parseInt(matches[1]);
+        }
+       }
+</script>
 </head>
-<body>
+<body onload="version_set();">
 <!--begin sidebar -->
 <iframe id="sidebar" src="../sidebar.html"></iframe>
 <!--end sidebar -->
@@ -21,12 +36,19 @@ Bug Writing
 an appropriate priority and severity for a bug, and increase the chance that a bug will be fixed quickly. The more specific information
 you can provide, the better.</p>
 
-<ul>
+<ol>
        <li><b>Version</b>
-       <p>Please select the WebKit version you were using when the bug occurred, or the closest match. <tt>312</tt> is the WebKit version
-       that shipped with Mac OS X 10.3.9. <tt>412</tt> is the WebKit version that shipped with Mac OS X 10.4 (Tiger). Locally-built versions
-       of WebKit have a <tt>+</tt> after the most recent official build number. So, for example, <tt>412+</tt> is a locally-built version of WebKit
-       that's newer than the <tt>412</tt> version shipped with Tiger.</p>
+       <p>
+       Please select the WebKit version you were using when the bug occurred, or the closest match. <tt>312</tt> is the WebKit version
+       that shipped with Mac OS X 10.3.9. <tt>412</tt> up to <tt>417.9</tt> are the WebKit versions that shipped with Mac OS X 10.4 (Tiger) 
+       and it's updates. 
+       </p>
+       <p>
+       Locally-built versions of WebKit have a <tt>+</tt> after the build number, and their build number is generally higher
+       then the latest release version. So, for example, <tt>420+</tt> is a 
+       locally-built version of WebKit that's newer than the <tt>417.9</tt> version that shipped with the latest update of Tiger.
+       </p>
+       <div style="display: none; text-align: center;" id="webkit_version"></div>
 
        <li><b>Component</b> 
                <p>If you know the precise cause of a bug (i.e., you've reduced it to a failing test case and know the reason), then you can 
@@ -39,13 +61,14 @@ you can provide, the better.</p>
        <li>
                <b>Platform and OS</b>
                <p>Please select the platform and the OS version that your bug occurred on. Typically this would be platform <tt>Macintosh</tt>
-               and OS <tt>Mac OS X 10.3</tt> (Panther) or <tt>Mac OS X 10.4</tt> (Tiger).</p>
+               and OS <tt>Mac OS X 10.3</tt> (Panther) or <tt>Mac OS X 10.4</tt> (Tiger). </p>
        </li>   
 
        <li>
                <b>Priority</b>
                <p>Normally a QA person or developer will set this, so the bug submitter can leave this at the default value. A number of
-               <a href="bugpriorities.html">guidelines</a> and some individual judgment are involved in setting the priority.</p>
+               <a href="bugpriorities.html">guidelines</a> and some individual judgment are involved in setting the priority. If you know the
+               bug is a regression, ie. something is wrong which wasn't wrong in previous versions of WebKit, you can set this to P1.</p>
        </li>
 
        <li>
@@ -65,7 +88,7 @@ you can provide, the better.</p>
        <p>A good summary explains the problem in clear and specific terms, but is often concise enough to fit within the default summary space in Bugzilla.  
         One should be able to tell exactly what a bug is about just by reading the summary.</p>
        
-       Tips for a good suummary:
+       Tips for a good summary:
        <ul>
                <li>include the domain of the page that shows the bug (especially if it's an important site)
                <li>if the bug is a crash, note this and note whether or not the crash is reproducible
@@ -97,7 +120,7 @@ you can provide, the better.</p>
                <b>Blocks</b>
                <p>If this bug blocks another bug from being fixed, put the other bug's number here. Otherwise, leave it empty.</p>
        </li>
-</ul>
+</ol>
 
 </body>
 </html>
index 9ce2103..e52a23c 100644 (file)
@@ -16,10 +16,12 @@ Test Case Reduction
 </div>
 
 <div id="content">
-<p>The basic idea behind bug reduction is to take a page that demonstrates a problem and
+<h2>A general guide to test case reduction</h2>
+<p>
+The basic idea behind bug reduction is to take a page that demonstrates a problem and
 remove as much content as possible while still reproducing the original problem.
 </p>
-<p>Why is this needed?</p>
+<h4>Why is this needed?</h4>
 <p>
 A reduced test case can help identify the central problem on the
 page by eliminating irrelevant information, i.e., portions of the HTML
@@ -30,9 +32,7 @@ solution. Also, since a site can change its content or design, the
 problem may no longer occur on the real-world site. 
 By constructing a test case you can capture the initial problem.
 </p>
-<p>
-A general guide to test case reduction:
-</p>
+<h4>The first steps</h4>
 <p>
 Really the first step in reducing a page is to identify that main
 problem of the page. For example:
@@ -45,35 +45,38 @@ problem of the page. For example:
 <p>
 After you have made this determination, you need to create a local copy
 of the page created from the page source window. After saving this
-source, it's a good idea to put a&nbsp; &lt;BASE &gt; element in the
-HEAD so that any images/external style sheet or scripts that use a
-relative path will get loaded. After the BASE element has been added,
+source, it's a good idea to put a <code>&lt;BASE&gt;</code> element in the
+<code>HEAD</code> so that any images/external style sheet or scripts that use a
+relative path will get loaded. After the <code>BASE</code> element has been added,
 load the local copy into the browser and verify that problem is still
 occurring. In this case, let's assume the problem is still present.
 </p>
+<h4>Work from top to bottom</h4>
 <p>
-In general, it's best to start from the top of the &lt;DOCTYPE&gt; and
-work down through the HEAD to the BODY element. Take a look at the HTML
+In general, it's best to start from the top of the <code>&lt;DOCTYPE&gt;</code> and
+work down through the <code>HEAD</code> to the <code>BODY</code> element. Take a look at the HTML
 file in a text editor and view what types of elements are present in the
-&lt;head&gt;. Typically, the HEAD will include the &lt;title&gt;
-element, which is required, and elements such as &lt;link&gt;,
-&lt;style&gt; and &lt;script&gt;.
+<code>&lt;head&gt;</code>. Typically, the <code>HEAD</code> will include the <code>&lt;title&gt;</code>
+element, which is required, and elements such as <code>&lt;link&gt;</code>,
+<code>&lt;style&gt;</code> and <code>&lt;script&gt;</code>.
 </p>
 <p>
 The reduction process is to remove one element at a time, save, and reload the
 test case. If you have removed the element and the page is still
 displaying the problem, continue with the next element. If removing an
-element in the head causes the problem to not occur, you may have found
-one piece in of the problem. Re-add this element back into the head,
+element in the <code>HEAD</code> causes the problem to not occur, you may have found
+one piece in of the problem. Re-add this element back into the <code>HEAD</code>,
 reload the page and confirm the problem is still occurring and move
-on to the next element in the head.
+on to the next element in the <code>HEAD</code>.
 </p>
+
+<h4>Finished the <code>HEAD</code>? Continue with the <code>BODY</code>!</h4>
 <p>
-Once the HEAD element has been reduced, you need to start reducing
-the number of required elements in the BODY. This will tend to be the
+Once the <code>HEAD</code> element has been reduced, you need to start reducing
+the number of required elements in the <code>BODY</code>. This will tend to be the
 most time consuming since hundreds (thousands) of elements will be
 present. The general practice is start removing elements by both their
-&lt;start&gt; and &lt;/end&gt; elements. This is especially true for
+<code>&lt;start&gt;</code> and <code>&lt;/end&gt;</code> elements. This is especially true for
 tables, which are frequently nested. You can speed up this process by
 selecting groups of elements and removing them but ideally you need to
 save and reload the test case each time to verify the problem is
@@ -85,11 +88,11 @@ uncheck 'Enable Javascript' in the Preferences. If you turn this option
 off and loading your test case still reproduces the problem, then any
 script elements that are present can be removed since they are not a
 factor in this issue. Let's say that you have reduced the page down to
-a nested table with an ordered list with an &lt;link&gt; element that need
+a nested table with an ordered list with an <code>&lt;link&gt;</code> element that need
 to be present. It's good practice to identify that CSS rule that is
 being in the external file and add it directly to the test case. Create
-a &lt;style&gt; &lt;/style&gt; in the head and copy/paste the contents
-of the .css file into this style element. Remove the &lt;link&gt; and
+a <code>&lt;style&gt;</code> <code>&lt;/style&gt;</code> in the head and copy/paste the contents
+of the .css file into this style element. Remove the <code>&lt;link&gt;</code> and
 save the changes. Load the test case and verify the problem is still
 occurring. Now manually delete or comment out each CSS rule until you
 have just the required set of rules to reproduce.
index 22fc0f5..62c1e77 100644 (file)
@@ -3,6 +3,7 @@ body {
        margin: 0;
         font-size: 90%;
         background-color: white;
+       text-align: justify;
 }
 
 a:link {
@@ -64,6 +65,7 @@ body > #sidebar {
         margin-right: 201px;
         margin-top: 1em;
         margin-left: 1em;
+        line-height: 140%;
 }
 
 .articleheader {
@@ -82,4 +84,9 @@ body > #sidebar {
 
 h3 {
        margin-top: 12px;
+}
+
+h4 {
+       font-size: 105%;
+       margin-bottom: 3px;
 }
\ No newline at end of file