| Line 1: | Line 1: | ||
| - | == Creating SDK | + | == Creating SDK Tutorials == |
This page includes recommendations for the content of MeeGo SDK tutorials, following the [[SDK documentation guidelines]]: | This page includes recommendations for the content of MeeGo SDK tutorials, following the [[SDK documentation guidelines]]: | ||
# Create a documentation bug | # Create a documentation bug | ||
| - | # Create wiki content | + | # Create wiki content as described below |
| - | # Request review, update bug | + | # Request review, update bug |
| - | # Add link to your wiki page in the appropriate section of the [[Developer Guide for MeeGo 1.0 | Developer's page]] | + | # Add a link to your wiki page in the appropriate section of the [[Developer Guide for MeeGo 1.0 | Developer's page]] |
== Content and Formatting == | == Content and Formatting == | ||
| Line 18: | Line 18: | ||
=== Formatting === | === Formatting === | ||
Wiki standards should be used and look similar to [[Getting started with the MeeGo SDK for Linux | other tutorial pages]]: | Wiki standards should be used and look similar to [[Getting started with the MeeGo SDK for Linux | other tutorial pages]]: | ||
| - | * Capitalize first letter of all title words. Correct: My Tutorial About Foo | + | * Capitalize first letter of all title words. |
| + | * Correct: My Tutorial About Foo | ||
| + | * Incorrect: My tutorial about foo | ||
* Headings should be level 2 (== Heading ==). Sub-headings level 3 (=== Sub-headings ===). | * Headings should be level 2 (== Heading ==). Sub-headings level 3 (=== Sub-headings ===). | ||
* Code should be in gray boxes (put one space before code lines) | * Code should be in gray boxes (put one space before code lines) | ||
Contents |
This page includes recommendations for the content of MeeGo SDK tutorials, following the SDK documentation guidelines:
The content of the tutorial is up to you but it should be concise and accurate. In addition, the following components are recommended if applicable:
If you are not the expert, be clear to note that. For example: "Here is one way to <perform this feature>. There may be better ways."
Links to offsite content is not encouraged. Advertising, spam, or other inappropriate content will be removed and the author banned from further contributions.
Wiki standards should be used and look similar to other tutorial pages:
* Correct: My Tutorial About Foo * Incorrect: My tutorial about foo
Links to your new tutorial should be placed on the main developer page after a peer review and only when it is ready for developers to use.
Screenshots are encouraged if helpful.
Source code is important whenever possible.
Code snippets should be shown inside boxes like this
When providing source, be aware of the following:
If your code is large, you may want to create a project in a public git repository. You can also optionally post a tgz or bz2 zipped archive. * Qt projects: If the project is Qt, it should be buildable with: qmake && make && make install