Changes between Version 17 and Version 18 of QtWebKitDocContrib


Ignore:
Timestamp:
Oct 6, 2010 1:36:37 AM (12 years ago)
Author:
Henry Haverinen
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • QtWebKitDocContrib

    v17 v18  
    3737== Submitting a documentation contribution ==
    3838
    39 Documentation is contributed to the WebKit SVN (the trunk of the project). By default, the documentation change will then be included in the next QtWebKit release that is branched off from the trunk. It is also possible to "cherry-pick" documentation changes to previous versions of QtWebKit (see below).
     39Documentation is contributed to the WebKit SVN (the trunk of the project). By default, the documentation change will then be included in the next QtWebKit release that is branched off from the trunk. It is also possible to "cherry-pick" documentation changes to previous versions of QtWebKit (see below). In some cases, documentation changes are needed in a certain release branch only.
    4040
    41  * Make your changes. Typically, you would change  existing qdoc files or create new qdoc files.
     41 * Make your changes. Typically, you would change existing qdoc files or create new qdoc files.
    4242 * Create a bug in the WebKit bugzilla. Use this template as the starting point: http://webkit.org/new-qtwebkit-bug.
    4343   * Leave the component as "New bugs".
     
    4545   * Select 528+ (Nightly build) as the version
    4646   * Enter "ademar.reis@openbossa.org" as the assignee
    47    * enter a short title to the change in the summary field. Don't omit the [Qt] in the beginning
    48    * enter a description of the change in the description field
    49  * Attach the changed qdoc file or the new qdoc file n the bug report
    50  * Wait for Ademar to prepare a change log and a patch
     47   * As the reporter of the bug, you will automatically receive email updates when the bug changes, for example when there are comments from reviewers. If you'd like a colleague or a mailing list to receive email notifications, you can add the email addresses in the CC field.
     48   * enter a short title to the change in the summary field. Don't omit the [Qt] prefix in the beginning
     49   * enter a description of the change in the description field and which QtWebKit releases are applicable.
     50 * Attach the changed qdoc file or the new qdoc file n the bug report. If your document embeds images, attach them to the bug report as well. When attaching documents, just add a short description and leave the other fields as they are.
    5151 * Wait for review comments and make a new version of the qdoc file as necessary
    5252
    5353== Having your documentation contribution cherry picked to a previous QtWebKit release ==
    5454
    55 You can work with QtWebKit release manager Ademar Reis to get your changes cherry picked to a QtWebKit release.
     55You can work with QtWebKit release manager Ademar Reis by email or over IRC to get your changes cherry picked to a QtWebKit release.
    5656
    5757== Communication ==
    5858
    5959We can use the QtWebKit [http://lists.webkit.org/mailman/listinfo.cgi/webkit-qt webkit-qt Mailing List] and the #qtwebkit IRC channel on freenode.net to discuss documentation, too.
    60 
    6160
    6261== Appendix: Installing git and checking out the documentation sources using git ==
     
    6968
    7069After installing git, you can verify your installation by typing {{{git}}} on the command line. If git has been installed and included in your PATH, you will see  a list of most commonly used git commands.
    71 
    7270
    7371Alternatively, you can Since the documentation is stored together with the source code, technical writes can also  check out the sources and documentation. Open a command prompt, go to your working directory for QtWebKit documentation, and type the following command: