Changes between Version 17 and Version 18 of QtWebKitDocContrib
- Timestamp:
- Oct 6, 2010, 1:36:37 AM (14 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
QtWebKitDocContrib
v17 v18 37 37 == Submitting a documentation contribution == 38 38 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). 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). In some cases, documentation changes are needed in a certain release branch only. 40 40 41 * Make your changes. Typically, you would change 41 * Make your changes. Typically, you would change existing qdoc files or create new qdoc files. 42 42 * Create a bug in the WebKit bugzilla. Use this template as the starting point: http://webkit.org/new-qtwebkit-bug. 43 43 * Leave the component as "New bugs". … … 45 45 * Select 528+ (Nightly build) as the version 46 46 * 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 beginning48 * enter a description of the change in the description field49 * Attach the changed qdoc file or the new qdoc file n the bug report50 * Wait for Ademar to prepare a change log and a patch47 * 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. 51 51 * Wait for review comments and make a new version of the qdoc file as necessary 52 52 53 53 == Having your documentation contribution cherry picked to a previous QtWebKit release == 54 54 55 You can work with QtWebKit release manager Ademar Reis to get your changes cherry picked to a QtWebKit release.55 You can work with QtWebKit release manager Ademar Reis by email or over IRC to get your changes cherry picked to a QtWebKit release. 56 56 57 57 == Communication == 58 58 59 59 We 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 61 60 62 61 == Appendix: Installing git and checking out the documentation sources using git == … … 69 68 70 69 After 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 72 70 73 71 Alternatively, 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:
